Compare commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
0b8fb87a29 | ||
|
|
e0249211d2 | ||
|
|
a244c1ba3d | ||
|
|
0a79807cb4 | ||
|
|
b70c473002 | ||
|
|
937390fca0 | ||
|
|
1140318719 | ||
|
|
655371c6d9 | ||
|
|
f07fc78eff | ||
|
|
60034a4ad8 | ||
|
|
ead7bf8841 | ||
|
|
15d2798aab | ||
|
|
58a0af40e6 | ||
|
|
1b79b45b1f | ||
|
|
f831ff3b7a | ||
|
|
f1b6859e9c | ||
|
|
2148f5196c | ||
|
|
5495e569df | ||
|
|
e121df48fe | ||
|
|
39c05b1eb3 | ||
|
|
78892a497d | ||
|
|
ccb08949ff | ||
|
|
74b091b1eb | ||
|
|
264214babd | ||
|
|
38930133f7 | ||
|
|
758cfc8e8d | ||
|
|
2a9ae74c33 | ||
|
|
2f73ba974c | ||
|
|
7c0b744c40 | ||
|
|
010d2dba60 | ||
|
|
c0b45e97ea | ||
|
|
7316fcd18a | ||
|
|
08a2d8a1a4 | ||
|
|
dbd53ba0d2 | ||
|
|
8b0c73c58e | ||
|
|
a292687a8c | ||
|
|
8659c1f4dc | ||
|
|
8ed73ba07b | ||
|
|
a41a31176d | ||
|
|
d6740efaf9 | ||
|
|
aac4ea8e2a | ||
|
|
3fe26cfb07 | ||
|
|
c837df6540 | ||
|
|
03b6b567fc | ||
|
|
09fbd442be | ||
|
|
5f32ca0140 | ||
|
|
46e5aa2815 | ||
|
|
db635f80f8 | ||
|
|
c3a101bc18 | ||
|
|
1af4bd430f | ||
|
|
0459c404f5 | ||
|
|
492f242e4d | ||
|
|
e06d6d5427 | ||
|
|
747c7c549c | ||
|
|
e91d615e68 | ||
|
|
2d527d59b0 | ||
|
|
340947a36d | ||
|
|
91d098ef65 | ||
|
|
d9f8ea8aca | ||
|
|
33bcb55124 | ||
|
|
5a93207dc2 | ||
|
|
fa7c36dbe2 | ||
|
|
faba8b8201 | ||
|
|
3422bc6f9e | ||
|
|
a195b758e6 | ||
|
|
083cd60f2d | ||
|
|
f4b7449262 | ||
|
|
fb68931538 | ||
|
|
be07fcec24 | ||
|
|
f6245cfada | ||
|
|
77cf6de722 | ||
|
|
2b17c26722 | ||
|
|
9862921297 | ||
|
|
685b2ceabd | ||
|
|
786b674db3 | ||
|
|
0b9074611a | ||
|
|
6ebfa038b3 | ||
|
|
4c809bb8d3 | ||
|
|
2dcb7eb7a2 | ||
|
|
743e89038c | ||
|
|
f9f25dc0c3 | ||
|
|
ca75698328 | ||
|
|
f117aeb7c4 | ||
|
|
e36557e844 | ||
|
|
e73b8ed5a5 | ||
|
|
0aaeb28eb7 | ||
|
|
305a5f6fda | ||
|
|
045961be02 | ||
|
|
c612dd3e70 | ||
|
|
ea4527e2dd | ||
|
|
aada33f23f | ||
|
|
1f44582658 | ||
|
|
198a58e524 | ||
|
|
0d78aef414 | ||
|
|
8f99cb0514 | ||
|
|
9a734d9b3c | ||
|
|
7a2c93a3e9 | ||
|
|
a5e1768f7e | ||
|
|
30e27062bd | ||
|
|
97d28a1b48 | ||
|
|
aade153f1c | ||
|
|
df6f5d4b33 | ||
|
|
ab14628769 | ||
|
|
69effb5af0 | ||
|
|
6e9078d64b | ||
|
|
9c73b7818f | ||
|
|
c5246d7a83 | ||
|
|
35511e08ac | ||
|
|
39dc8b226a | ||
|
|
7cb531b183 | ||
|
|
58422b17e5 | ||
|
|
0b2191f97c | ||
|
|
a3e672cde0 | ||
|
|
5a0b10bdff | ||
|
|
dfbf4d8a8f | ||
|
|
4727d622db | ||
|
|
e18e62754f | ||
|
|
bec7af5142 | ||
|
|
0db937eeeb | ||
|
|
c8d26a5ea9 | ||
|
|
1659ebd2ac | ||
|
|
7877d13776 | ||
|
|
2f7cacb933 | ||
|
|
16fcbf8a54 | ||
|
|
719a23c95b | ||
|
|
f4db8af201 | ||
|
|
3549c63cc0 | ||
|
|
b9ed7e5293 | ||
|
|
e34e2c4386 | ||
|
|
a09b2e186f | ||
|
|
cc273261c3 | ||
|
|
26c5c951b6 | ||
|
|
e63178b899 | ||
|
|
eb42f08640 | ||
|
|
2843bfd5c9 | ||
|
|
b2a838dc4e | ||
|
|
c682a6d8eb | ||
|
|
c4a23b4f1b | ||
|
|
12e74533c7 | ||
|
|
24c8f6012f | ||
|
|
b20fb9ea3f | ||
|
|
079e0defc4 | ||
|
|
00ad406e1b | ||
|
|
5c7a9e1d08 | ||
|
|
ea2c981a7f | ||
|
|
ee18d1b317 | ||
|
|
7f6771e56d | ||
|
|
1308b143c4 | ||
|
|
7be2d1f06a | ||
|
|
62021e8870 | ||
|
|
ea5f407786 | ||
|
|
2ecd1823e1 | ||
|
|
1e2eee63df | ||
|
|
8fda979870 | ||
|
|
c59002c375 | ||
|
|
1fe05b402b | ||
|
|
c7d5bef886 | ||
|
|
ca2fc2bd5c | ||
|
|
8bf9fb6299 | ||
|
|
031f24180a | ||
|
|
8663777097 | ||
|
|
342876cd0b | ||
|
|
beaa256e3f | ||
|
|
27ae27187d | ||
|
|
e8d692a707 | ||
|
|
4f71d1bd03 | ||
|
|
8d33d4c44e | ||
|
|
8be55a30c1 | ||
|
|
46a0cfa1eb | ||
|
|
6988bca7f4 | ||
|
|
1a2c0ecbfc | ||
|
|
f2281505a4 | ||
|
|
3ff790c57b | ||
|
|
d5b0fc4e3b | ||
|
|
69129c2d47 | ||
|
|
1486d66b9b | ||
|
|
67323d01f5 | ||
|
|
d0566e6645 | ||
|
|
a3e1fa866e | ||
|
|
6d6b70a888 | ||
|
|
c152d3bf35 | ||
|
|
56a0211b03 | ||
|
|
87fb943ddb | ||
|
|
dacc9bb27e | ||
|
|
43a9fa6820 | ||
|
|
523d7a0896 | ||
|
|
df53e243a5 | ||
|
|
b30d7e3337 | ||
|
|
7a8e2bcd02 | ||
|
|
7aa505f1a3 | ||
|
|
beecd2d26f | ||
|
|
96ecbe97f1 | ||
|
|
7161da4a2f | ||
|
|
462fdfe1be | ||
|
|
dc25133b10 | ||
|
|
bb7552a7bf | ||
|
|
79b4ca053a | ||
|
|
8d91bd218b | ||
|
|
8e0c96589a | ||
|
|
3ac66ea4c5 | ||
|
|
acbff61d9e | ||
|
|
83a1da04d1 | ||
|
|
b86155de49 | ||
|
|
2108ce52ca | ||
|
|
4af96da515 | ||
|
|
eda2085d4b | ||
|
|
6cdcf66e81 | ||
|
|
a701522dca | ||
|
|
ddeb31e530 | ||
|
|
f827ead0b6 | ||
|
|
ae87703a34 | ||
|
|
250c2d768b | ||
|
|
e5e6587490 | ||
|
|
4921152336 | ||
|
|
0c7da91fab | ||
|
|
add07026bc | ||
|
|
7f64418a6c | ||
|
|
e83ceaa815 | ||
|
|
e3dcb99438 | ||
|
|
78821cb5e4 | ||
|
|
548441dded | ||
|
|
7c53ae421c | ||
|
|
a71a867aea | ||
|
|
4d0d2e9a58 | ||
|
|
fcda1e325e | ||
|
|
b41fed0d12 | ||
|
|
ac533d92f6 | ||
|
|
792b48b75a | ||
|
|
175eb921c1 | ||
|
|
4cd959b34b | ||
|
|
0083efb7dc | ||
|
|
18738a56c0 | ||
|
|
3254fc8199 | ||
|
|
4a52299d35 | ||
|
|
7a1247051c | ||
|
|
71d34dd3d3 | ||
|
|
1971ffd221 | ||
|
|
a0af2145f3 | ||
|
|
64bd5cef35 | ||
|
|
4eb511e76e | ||
|
|
6e7fa2a7f8 | ||
|
|
1e3765990a | ||
|
|
2ef608fa33 | ||
|
|
479878a59d | ||
|
|
475eba8b7e | ||
|
|
c0ddec8896 | ||
|
|
38cd32b8c8 | ||
|
|
9a6ee0397b | ||
|
|
57f7bf6375 | ||
|
|
93f3cd7868 | ||
|
|
157b5a891e | ||
|
|
fcd10703a8 | ||
|
|
d17a8524c5 | ||
|
|
2d42013fed | ||
|
|
5288fe1512 | ||
|
|
3988361471 | ||
|
|
62204bda9d | ||
|
|
1ac4418d41 | ||
|
|
23914274b5 | ||
|
|
a668aa11db | ||
|
|
0aefb792dc | ||
|
|
54de1c1f5a | ||
|
|
f53f125e3e | ||
|
|
0269647d75 | ||
|
|
5fc05e7faa | ||
|
|
8c3caed1fb | ||
|
|
fbcb1fc47a | ||
|
|
fdd6e64060 | ||
|
|
3dd88f2453 | ||
|
|
d06bfefc40 | ||
|
|
30236206bc | ||
|
|
24b0231495 | ||
|
|
57946fea6d | ||
|
|
187990ce05 | ||
|
|
8cfcecf440 | ||
|
|
041d290f0f | ||
|
|
291791cb08 | ||
|
|
3d081cb7a0 | ||
|
|
0201159b31 | ||
|
|
4caaa203bb | ||
|
|
783bd63da0 | ||
|
|
82a187fe46 | ||
|
|
8ebf96f1e1 | ||
|
|
b25152a5e8 | ||
|
|
b1b488a8a0 | ||
|
|
8a76b92b5f | ||
|
|
724f3a9724 | ||
|
|
388d9cb29e | ||
|
|
6b463c6f1a | ||
|
|
4afca77d1e | ||
|
|
53d8e60ec3 | ||
|
|
23c22b79d8 | ||
|
|
4943517145 | ||
|
|
c71398c6e3 | ||
|
|
dfaa278636 | ||
|
|
139c3b42f5 | ||
|
|
d89c28334e | ||
|
|
7638bcad02 | ||
|
|
63090b82e3 | ||
|
|
63b7cb8188 | ||
|
|
ad9dda27ba | ||
|
|
3f3137874a | ||
|
|
440eaaeb26 | ||
|
|
2d6d8ce2be | ||
|
|
229d0731b8 | ||
|
|
418cd92f80 | ||
|
|
6e4ed4bc09 | ||
|
|
51b417aa7e | ||
|
|
0fc895ad17 | ||
|
|
2dea2172bc | ||
|
|
fcd3c15ec7 | ||
|
|
4cd9b08698 | ||
|
|
b21b641e2a | ||
|
|
af9c8d71c6 | ||
|
|
8bd1891fcc | ||
|
|
e5a62f17a5 | ||
|
|
db383d0e88 | ||
|
|
e519d86cad | ||
|
|
bf68656d05 | ||
|
|
69913151b6 | ||
|
|
46312eb138 | ||
|
|
1a13936681 | ||
|
|
251ea22f5f | ||
|
|
8f8808ce1c | ||
|
|
bb207b953c | ||
|
|
2984d6876d | ||
|
|
5d2b131c99 | ||
|
|
43c9b4db9c | ||
|
|
ce9e27e116 | ||
|
|
e25b7deaf3 | ||
|
|
81078073cb | ||
|
|
e6e5db95ba | ||
|
|
2cf3af242b | ||
|
|
ed664359a6 | ||
|
|
4a5e855b76 | ||
|
|
1e60863a40 | ||
|
|
10ad3ee5bd | ||
|
|
32c5a0a77a | ||
|
|
b6651f12e2 | ||
|
|
15ad35bf76 | ||
|
|
9a986dd000 | ||
|
|
714146f616 | ||
|
|
96d2b4e9fd | ||
|
|
122c42153e | ||
|
|
32c4ee16a0 | ||
|
|
53cdb411b7 | ||
|
|
0708e0ae1c | ||
|
|
95db24f8ed | ||
|
|
bcdd2e7feb | ||
|
|
4adfa9f830 | ||
|
|
dcc8f99991 | ||
|
|
3bdb56462d | ||
|
|
b8bffe97b5 | ||
|
|
af817b6bc3 | ||
|
|
8e1cbc65d7 | ||
|
|
e38a1f9c1a | ||
|
|
50c3133dae | ||
|
|
b1e2a74ad5 | ||
|
|
7e9dc8cd65 | ||
|
|
7d87cc27fc | ||
|
|
25714cde90 | ||
|
|
8241482c19 | ||
|
|
3044e010f6 | ||
|
|
9743b933da | ||
|
|
1ce8ec4758 | ||
|
|
cb99b7646c | ||
|
|
5af7279c67 | ||
|
|
224d9f6787 | ||
|
|
ed7df13f9b | ||
|
|
2c5f6631d7 | ||
|
|
a32b88f6b0 | ||
|
|
88cb271332 | ||
|
|
e18d1a7a16 | ||
|
|
b2dfc6f32c | ||
|
|
a64e30a94c | ||
|
|
6d5b28f75f | ||
|
|
c7decaec02 | ||
|
|
8600437c5a | ||
|
|
ece3f42ab3 | ||
|
|
32be8dfe3a | ||
|
|
2aebceda24 | ||
|
|
85b463f0e0 | ||
|
|
f6c8d4f51a | ||
|
|
b84c1c8821 | ||
|
|
a3334fdf2d | ||
|
|
d6b12b75b0 | ||
|
|
a9e623391b | ||
|
|
fd34ba778c | ||
|
|
d00d31eaf2 | ||
|
|
016a0f62bd | ||
|
|
cf52292f7c | ||
|
|
8b26c94ada | ||
|
|
582b10b5ee | ||
|
|
b51e152d10 | ||
|
|
5f197f5f9f | ||
|
|
5a3ee25dfd | ||
|
|
7050138e5e | ||
|
|
049d268314 | ||
|
|
6f71afb418 | ||
|
|
7e65692b5a | ||
|
|
bd1f44479b | ||
|
|
c0935001ce | ||
|
|
f65ab5dfea | ||
|
|
dbb7fd576f | ||
|
|
be5cc6126e | ||
|
|
6a4eb24630 | ||
|
|
61a8bc519f | ||
|
|
b15f3c0333 | ||
|
|
5830fda578 | ||
|
|
102f837263 | ||
|
|
5cee42a76e | ||
|
|
8fc7cc924a | ||
|
|
80170b814f | ||
|
|
91fcb71bc3 | ||
|
|
eb13d91bbb | ||
|
|
a464437b3a | ||
|
|
3a67dc9b08 | ||
|
|
a6ff20a657 | ||
|
|
4bf380edf8 | ||
|
|
ab3148b705 | ||
|
|
2ffd1ebf2a | ||
|
|
d1155bc8ef | ||
|
|
33ff706803 | ||
|
|
7fdd819722 | ||
|
|
aeaea23098 | ||
|
|
ff7f45f055 | ||
|
|
40665684a8 | ||
|
|
861f822151 | ||
|
|
62541f1450 | ||
|
|
a356e77f54 | ||
|
|
74abeff8d9 | ||
|
|
78dfaccd38 | ||
|
|
757b72161a | ||
|
|
c2065bf752 | ||
|
|
5608dae6e3 | ||
|
|
2288880eba | ||
|
|
ba7d0a9723 | ||
|
|
1ac8800b40 | ||
|
|
bb7827b762 | ||
|
|
8caa0275ab | ||
|
|
7e1d0f8a49 | ||
|
|
f7f5c2de37 | ||
|
|
f75710c836 | ||
|
|
a02cc89e5d | ||
|
|
f54a51c546 | ||
|
|
b12eb87b38 | ||
|
|
93f7408847 |
@@ -0,0 +1,50 @@
|
||||
name: Deploy to GitHub Pages
|
||||
|
||||
on:
|
||||
push:
|
||||
branches:
|
||||
- feat-docs
|
||||
# Review gh actions docs if you want to further define triggers, paths, etc
|
||||
# https://docs.github.com/en/actions/using-workflows/workflow-syntax-for-github-actions#on
|
||||
|
||||
permissions:
|
||||
contents: write
|
||||
|
||||
jobs:
|
||||
deploy:
|
||||
name: Deploy to GitHub Pages
|
||||
runs-on: ubuntu-latest
|
||||
steps:
|
||||
- uses: actions/checkout@v3
|
||||
- uses: actions/setup-node@v3
|
||||
with:
|
||||
node-version: 18
|
||||
cache: npm
|
||||
- name: Install dependencies
|
||||
working-directory: ./docs
|
||||
run: npm ci
|
||||
- name: Clean api-docs
|
||||
working-directory: ./docs
|
||||
run: npm run docusaurus clean-api-docs all
|
||||
- name: Build api-docs
|
||||
working-directory: ./docs
|
||||
run: npm run docusaurus gen-api-docs all
|
||||
- name: Build website
|
||||
working-directory: ./docs
|
||||
run: npm run build
|
||||
|
||||
# Popular action to deploy to GitHub Pages:
|
||||
# Docs: https://github.com/peaceiris/actions-gh-pages#%EF%B8%8F-docusaurus
|
||||
- name: Deploy to GitHub Pages
|
||||
uses: peaceiris/actions-gh-pages@v3
|
||||
with:
|
||||
github_token: ${{ secrets.GITHUB_TOKEN }}
|
||||
# Build output to publish to the `gh-pages` branch:
|
||||
publish_dir: ./docs/build
|
||||
# The following lines assign commit authorship to the official
|
||||
# GH-Actions bot for deploys to `gh-pages` branch:
|
||||
# https://github.com/actions/checkout/issues/13#issuecomment-724415212
|
||||
# The GH actions bot is used by default if you didn't specify the two fields.
|
||||
# You can swap them out with your own user credentials.
|
||||
user_name: github-actions[bot]
|
||||
user_email: 41898282+github-actions[bot]@users.noreply.github.com
|
||||
@@ -0,0 +1,20 @@
|
||||
# Dependencies
|
||||
/node_modules
|
||||
|
||||
# Production
|
||||
/build
|
||||
|
||||
# Generated files
|
||||
.docusaurus
|
||||
.cache-loader
|
||||
|
||||
# Misc
|
||||
.DS_Store
|
||||
.env.local
|
||||
.env.development.local
|
||||
.env.test.local
|
||||
.env.production.local
|
||||
|
||||
npm-debug.log*
|
||||
yarn-debug.log*
|
||||
yarn-error.log*
|
||||
@@ -0,0 +1,41 @@
|
||||
# Website
|
||||
|
||||
This website is built using [Docusaurus 2](https://docusaurus.io/), a modern static website generator.
|
||||
|
||||
### Installation
|
||||
|
||||
```
|
||||
$ yarn
|
||||
```
|
||||
|
||||
### Local Development
|
||||
|
||||
```
|
||||
$ yarn start
|
||||
```
|
||||
|
||||
This command starts a local development server and opens up a browser window. Most changes are reflected live without having to restart the server.
|
||||
|
||||
### Build
|
||||
|
||||
```
|
||||
$ yarn build
|
||||
```
|
||||
|
||||
This command generates static content into the `build` directory and can be served using any static contents hosting service.
|
||||
|
||||
### Deployment
|
||||
|
||||
Using SSH:
|
||||
|
||||
```
|
||||
$ USE_SSH=true yarn deploy
|
||||
```
|
||||
|
||||
Not using SSH:
|
||||
|
||||
```
|
||||
$ GIT_USER=<Your GitHub username> yarn deploy
|
||||
```
|
||||
|
||||
If you are using GitHub pages for hosting, this command is a convenient way to build the website and push to the `gh-pages` branch.
|
||||
@@ -0,0 +1,3 @@
|
||||
module.exports = {
|
||||
presets: [require.resolve('@docusaurus/core/lib/babel/preset')],
|
||||
};
|
||||
@@ -0,0 +1,12 @@
|
||||
---
|
||||
slug: first-blog-post
|
||||
title: First Blog Post
|
||||
authors:
|
||||
name: Gao Wei
|
||||
title: Docusaurus Core Team
|
||||
url: https://github.com/wgao19
|
||||
image_url: https://github.com/wgao19.png
|
||||
tags: [hola, docusaurus]
|
||||
---
|
||||
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
|
||||
@@ -0,0 +1,44 @@
|
||||
---
|
||||
slug: long-blog-post
|
||||
title: Long Blog Post
|
||||
authors: endi
|
||||
tags: [hello, docusaurus]
|
||||
---
|
||||
|
||||
This is the summary of a very long blog post,
|
||||
|
||||
Use a `<!--` `truncate` `-->` comment to limit blog post size in the list view.
|
||||
|
||||
<!--truncate-->
|
||||
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
|
||||
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
|
||||
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
|
||||
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
|
||||
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
|
||||
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
|
||||
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
|
||||
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
|
||||
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
|
||||
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
|
||||
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
|
||||
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
|
||||
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
|
||||
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
|
||||
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
|
||||
|
||||
Lorem ipsum dolor sit amet, consectetur adipiscing elit. Pellentesque elementum dignissim ultricies. Fusce rhoncus ipsum tempor eros aliquam consequat. Lorem ipsum dolor sit amet
|
||||
@@ -0,0 +1,20 @@
|
||||
---
|
||||
slug: mdx-blog-post
|
||||
title: MDX Blog Post
|
||||
authors: [slorber]
|
||||
tags: [docusaurus]
|
||||
---
|
||||
|
||||
Blog posts support [Docusaurus Markdown features](https://docusaurus.io/docs/markdown-features), such as [MDX](https://mdxjs.com/).
|
||||
|
||||
:::tip
|
||||
|
||||
Use the power of React to create interactive blog posts.
|
||||
|
||||
```js
|
||||
<button onClick={() => alert('button clicked!')}>Click me!</button>
|
||||
```
|
||||
|
||||
<button onClick={() => alert('button clicked!')}>Click me!</button>
|
||||
|
||||
:::
|
||||
|
After Width: | Height: | Size: 94 KiB |
@@ -0,0 +1,25 @@
|
||||
---
|
||||
slug: welcome
|
||||
title: Welcome
|
||||
authors: [slorber, yangshun]
|
||||
tags: [facebook, hello, docusaurus]
|
||||
---
|
||||
|
||||
[Docusaurus blogging features](https://docusaurus.io/docs/blog) are powered by the [blog plugin](https://docusaurus.io/docs/api/plugins/@docusaurus/plugin-content-blog).
|
||||
|
||||
Simply add Markdown files (or folders) to the `blog` directory.
|
||||
|
||||
Regular blog authors can be added to `authors.yml`.
|
||||
|
||||
The blog post date can be extracted from filenames, such as:
|
||||
|
||||
- `2019-05-30-welcome.md`
|
||||
- `2019-05-30-welcome/index.md`
|
||||
|
||||
A blog post folder can be convenient to co-locate blog post images:
|
||||
|
||||

|
||||
|
||||
The blog supports tags as well!
|
||||
|
||||
**And if you don't want a blog**: just delete this directory, and use `blog: false` in your Docusaurus config.
|
||||
@@ -0,0 +1,17 @@
|
||||
endi:
|
||||
name: Endilie Yacop Sucipto
|
||||
title: Maintainer of Docusaurus
|
||||
url: https://github.com/endiliey
|
||||
image_url: https://github.com/endiliey.png
|
||||
|
||||
yangshun:
|
||||
name: Yangshun Tay
|
||||
title: Front End Engineer @ Facebook
|
||||
url: https://github.com/yangshun
|
||||
image_url: https://github.com/yangshun.png
|
||||
|
||||
slorber:
|
||||
name: Sébastien Lorber
|
||||
title: Docusaurus maintainer
|
||||
url: https://sebastienlorber.com
|
||||
image_url: https://github.com/slorber.png
|
||||
@@ -0,0 +1,242 @@
|
||||
---
|
||||
id: createtemplate
|
||||
title: "Template Creation API"
|
||||
description: "The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **templateId** that can be used to generate documents based on the specified template."
|
||||
sidebar_label: "Template Creation API"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJztVt9v4zYM/ld0upddkSbp3T3l6bquKIIVbdCk2ENaDLLNxGplyZPk/FiQ/32kbCeOkxsaYI/rFT2bpEjqI/nRG+7F3PHBlHvIciU8OP7a4Qm42MrcS6P5gE9SYJNKzW4sCJKz69GQCaXM0rHCgXXMGxaTElhcOG8y+beIFLCd4w5bpjJOGRovgAnHIlVAbqX2js2MZXPQYNG3nrPExEUGpFhKn7LcQgIzqSFhztsi9oUF12XPOabhijgG52aF2kUq08AcO8xj6pSoBTyjHROs0PKvAtjFRW09TC4u0E54FgvNIqDbJHSZKh9oZBMJ0mFU8utyiOVMknHlqss73OThEkYPE4SuBKTWo9oCRnf+V5Os+WDDY6M9eqZHkedKxuFo780R8Bvu4hQyQU9+nQP6M9EbxB795JYCeYn1Qu2DyKBhhSAhimiFsGbCNyWwEphLMAoPu9z5tsMfjD/bzUgBgoIALyQsmdBYIjkngKTbAUe+f2u21HkhdnVttiW6fH66P9dV6n3uBr3e2hRWZmIO3dhk5IuSxiZu+BPWinXz8JS/Gfgxz4RU4VQH31PdEODgrDJFLnSox85phy8tlhewI7B9AcNJvJM7lfw+VQpWvVXhTjtHb156dSDaEgoqAUtNeB5CqzcXias7sRoFN4cxW+3cCN3WbOkwTimOqCt79Gu/T/+1qOVgZGm+d+Os1p8wsf9oQGKTNDsbOQfmYJtQoOjb13CjYNIGDRUZ5oUdc0J3hNPnz8hXolD+GKL6xk8VNhVU3/vfj9EZ6oVQMgkMNjHvoD+FWBn41BC75MaFqwqf4lvviGwC01JTTze8sKrR/4hlF/HR1DFKRI46DIWyt7ji21c6GeOA+PWY8C0hRO2f77BuTkgufwcakerWq0uUXHpKFIWSbpCCwC4MWVPJnvbsd1t3XM1eR4RU89HHKKbFMKdJo+KMn9BAgwU+Muv7CTsYGrr5zASYqsI/ItBjypjqiAAf71e8CP6Sur5PuWNpLbZOH+4gUpL8W/eq3kflhHTZi37RY5OFfUbbUUn97gYv+pJNH2doJoVif0DkkIpef6kBWS6XR33xJZy5w0VcRFiE3OzN50EYmqd5avfyBe/qwWbucTbGXpRxzcE/CdULxr1q7kUc5h4IdJqfUvSjfYggR2IAGqb9CF7fje4Rlj762rf+B1Lu3Q9vbh/Gt+SVhqcs0VW3j65QRCOXCd0IdPLLqF3jxqb//3PqnM+pimo8rHwPhTIs/lDQTcV70/buwdFMiRhRs9lQiGertlsSY6YWCWyKjwthJeFJb+ix4ikiysBx/KYs1+WE4pM5ghsor7WDtp36xDUCl/t/tX1tcPfocTxB46j6EMzCguJWLOkjEf8O+Av+Cx+U5CFQcJBvuBJ6XoRNxEu/9PMPphMdww==
|
||||
sidebar_class_name: "post api-method"
|
||||
info_path: docs/API-docs/opensign-api-v-1
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import ApiTabs from "@theme/ApiTabs";
|
||||
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
|
||||
import MimeTabs from "@theme/MimeTabs";
|
||||
import ParamsItem from "@theme/ParamsItem";
|
||||
import ResponseSamples from "@theme/ResponseSamples";
|
||||
import SchemaItem from "@theme/SchemaItem";
|
||||
import SchemaTabs from "@theme/SchemaTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
|
||||
<h1
|
||||
className={"openapi__heading"}
|
||||
>
|
||||
Template Creation API
|
||||
</h1>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"post"}
|
||||
path={"/createtemplate"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
The Template Creation API allows users to create customizable templates, which serve as blueprints for generating documents with predefined structures. Upon successful template creation, the API returns a unique **templateId** that can be used to generate documents based on the specified template.
|
||||
|
||||
## Request
|
||||
|
||||
<MimeTabs
|
||||
className={"openapi-tabs__mime"}
|
||||
>
|
||||
<TabItem
|
||||
label={"application/json"}
|
||||
value={"application/json-schema"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details mime"}
|
||||
data-collapsed={false}
|
||||
open={true}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
className={"openapi-markdown__details-summary-mime"}
|
||||
>
|
||||
<h3
|
||||
className={"openapi-markdown__details-summary-header-body"}
|
||||
>
|
||||
Body
|
||||
</h3>
|
||||
</summary><div
|
||||
style={{"textAlign":"left","marginLeft":"1rem"}}
|
||||
>
|
||||
|
||||
</div><ul
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<SchemaItem
|
||||
collapsible={false}
|
||||
name={"Name"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"string","example":"sample template"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"Note"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"string","example":"Please review and sign this document"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"Description"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"string","example":"template description"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"URL"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"string","example":"https://yourimage.com"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"signers"}
|
||||
required={false}
|
||||
schemaName={"signers[]"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"array","example":["joe@gmail.com","john@gmail.com"],"xml":{"name":"signers","wrapped":true},"items":{"type":"string","example":"joe@example.com","xml":{"name":"signers"},"title":"signers"}}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"folderId"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"string","example":"xjsba1GaxP"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem>
|
||||
</MimeTabs><div>
|
||||
<div>
|
||||
<ApiTabs>
|
||||
<TabItem
|
||||
label={"200"}
|
||||
value={"200"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
Template created successfully!
|
||||
|
||||
|
||||
</div><div>
|
||||
<MimeTabs
|
||||
className={"openapi-tabs__mime"}
|
||||
schemaType={"response"}
|
||||
>
|
||||
<TabItem
|
||||
label={"application/json"}
|
||||
value={"application/json"}
|
||||
>
|
||||
<SchemaTabs
|
||||
className={"openapi-tabs__schema"}
|
||||
>
|
||||
<TabItem
|
||||
label={"Schema"}
|
||||
value={"Schema"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details response"}
|
||||
data-collapsed={false}
|
||||
open={true}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
className={"openapi-markdown__details-summary-response"}
|
||||
>
|
||||
<strong>
|
||||
Schema
|
||||
</strong>
|
||||
</summary><div
|
||||
style={{"textAlign":"left","marginLeft":"1rem"}}
|
||||
>
|
||||
|
||||
</div><ul
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<SchemaItem
|
||||
collapsible={false}
|
||||
name={"code"}
|
||||
required={false}
|
||||
schemaName={"int32"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int32"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"type"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"message"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"Example (from schema)"}
|
||||
value={"Example (from schema)"}
|
||||
>
|
||||
<ResponseSamples
|
||||
responseExample={"{\n \"code\": 0,\n \"type\": \"string\",\n \"message\": \"string\"\n}"}
|
||||
language={"json"}
|
||||
>
|
||||
|
||||
</ResponseSamples>
|
||||
</TabItem>
|
||||
</SchemaTabs>
|
||||
</TabItem>
|
||||
</MimeTabs>
|
||||
</div>
|
||||
</TabItem><TabItem
|
||||
label={"404"}
|
||||
value={"404"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
Invalid API Token!
|
||||
|
||||
|
||||
</div><div>
|
||||
|
||||
</div>
|
||||
</TabItem>
|
||||
</ApiTabs>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -0,0 +1,112 @@
|
||||
---
|
||||
id: delete-pet
|
||||
title: "Deletes a pet"
|
||||
description: "delete a pet"
|
||||
sidebar_label: "Deletes a pet"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJydVW1r2zAQ/itCn1pI45SVfTBjrKyhhJW1LBv70Iai2OdY1JZUSW4bjP/77mTHTtIEtkFI7Ht97rmX1NyLlePxPU+08iLxji9GPAWXWGm81IrH+FaAByaYAc9HXBuwglSztFfeBY0RVpT4ZilgzRW+oIUw8vEJ1qiXFC0HkYLl+0lQYOG5khYwaiYKByPu/LqgCE6WBh9GHN5MoVMYDJIcSsHjmvu1CZbeSrXiTTPq03d1Pcp0g8AIn7/LjxUwmTKvWVvRDh5vq/+CI5WHVSg207YUvhV9vECAC4rvjFYOHHlcTCb0swtqpl5EgaiQeIZPFVBl3EFSWenXgeQNu/H9gmIi/bke+hKagtXGPOp4iOqBkIZTMPuyaVhlC2qQ98bFUSSMGWOvlZMrVYilGye6RKGMXs45pdrAmFPVbRE9mJ4BlHwLve+68XaGkjOvn0DtDQRVJlWmg7P0gelbTD/H9OzybsYw7X7TfubSMfyQOtVJVQKWRjqGfLM9b7YUDlKGSp9DUJL8w/icOQOJzGQSXMfsQT2ouS6BVQ6yqmCFVE8uflBn7P42QzMpCvYblk56WJxs2Hp9fX3H1mnwuZY+r5bMgtGD+SoIA6XbXv3LKdaKi1S622yOHZIJdJ05kioKxhF6de0lGnEYZTGswJd9J46UFxgaZ5DMuxZdXt/dIC0TjDUMxF9Ajm5mX6ff51OKSiPVtuh8PMFQKDLa+VKorURXYURdf1h2elsH1NjP9weoGy0Pbz4yhcAhajqodTft/TVD63jrAODU5giDDOqaxuGXLZqGxM8V2LBEiF1YKZY0f7gSqXT0PNykoyBPfnTn4pQduCUHMW92RNGCtPsdDmFYoe3D1SzQutuTf0N1LHWbYjjNffadI3I1vZn+nKJaVETr9la3bt0DYTpYzO66t0npm+7zQYdPtJN4MT735t3dO+bQ/5201lTdommaP8yWUbU=
|
||||
sidebar_class_name: "delete api-method"
|
||||
info_path: docs/API-docs/opensign-api-v-1
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import ApiTabs from "@theme/ApiTabs";
|
||||
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
|
||||
import MimeTabs from "@theme/MimeTabs";
|
||||
import ParamsItem from "@theme/ParamsItem";
|
||||
import ResponseSamples from "@theme/ResponseSamples";
|
||||
import SchemaItem from "@theme/SchemaItem";
|
||||
import SchemaTabs from "@theme/SchemaTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
|
||||
<h1
|
||||
className={"openapi__heading"}
|
||||
>
|
||||
Deletes a pet
|
||||
</h1>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"delete"}
|
||||
path={"/contact/{contact_id}"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
delete a pet
|
||||
|
||||
## Request
|
||||
|
||||
<details
|
||||
style={{"marginBottom":"1rem"}}
|
||||
className={"openapi-markdown__details"}
|
||||
data-collapsed={false}
|
||||
open={true}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
>
|
||||
<h3
|
||||
className={"openapi-markdown__details-summary-header-params"}
|
||||
>
|
||||
Path Parameters
|
||||
</h3>
|
||||
</summary><div>
|
||||
<ul>
|
||||
<ParamsItem
|
||||
className={"paramsItem"}
|
||||
param={{"name":"contact_id","in":"path","description":"Pet id to delete","required":true,"style":"simple","explode":false,"schema":{"type":"integer","format":"int64"}}}
|
||||
>
|
||||
|
||||
</ParamsItem>
|
||||
</ul>
|
||||
</div>
|
||||
</details><details
|
||||
style={{"marginBottom":"1rem"}}
|
||||
className={"openapi-markdown__details"}
|
||||
data-collapsed={false}
|
||||
open={true}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
>
|
||||
<h3
|
||||
className={"openapi-markdown__details-summary-header-params"}
|
||||
>
|
||||
Header Parameters
|
||||
</h3>
|
||||
</summary><div>
|
||||
<ul>
|
||||
<ParamsItem
|
||||
className={"paramsItem"}
|
||||
param={{"name":"api_key","in":"header","description":"","required":false,"style":"simple","explode":false,"schema":{"type":"string"}}}
|
||||
>
|
||||
|
||||
</ParamsItem>
|
||||
</ul>
|
||||
</div>
|
||||
</details><div>
|
||||
<div>
|
||||
<ApiTabs>
|
||||
<TabItem
|
||||
label={"400"}
|
||||
value={"400"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
Invalid pet value
|
||||
|
||||
|
||||
</div><div>
|
||||
|
||||
</div>
|
||||
</TabItem>
|
||||
</ApiTabs>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -0,0 +1,101 @@
|
||||
---
|
||||
id: delete-template
|
||||
title: "Delete template by ID"
|
||||
description: "Delete template by ID"
|
||||
sidebar_label: "Delete template by ID"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJyVVF1r2zAU/StCTyukccrKHvy0soYSVpaydOyhDUWxr2NRW1IlOW0I/u8714mbNF1hg0Ck63O/zj26GxnVMsj0TkaqXaUiBTkfSOvIq6itmeQylTlVFOl2B5AD6ZRXNUyePTfS4AJYH+FB58BoA5NTscQ5p5B57TggjJNLYQsRSxK9By4qCkOUBxGtWJDYpuQ4np4a7XFMo29oIENcV5wtaPhyMfTiKpvDVKgqMCArqVYy3ci4dozUJtKSPKCF9bWKW9OXc9m2c44fnDUBfcPjfDTiv6N6zUpVOheoOzTOVRrFtANgz99jpz4nL4yNorCNAa497v6y62zf+mKNwKgNfJZ2z3bHMshLZdJDk80Bwy0Agfyqn0HjK2DLGF1Ik0Q5N8QMTdBLU6lFGGa2hlEnqzPJTQfKGq/jesZcbVvH14dHWh/wBst3GAb9fF9OYTmN9pFMP9+SFPrtutSmsJ2zjt18pkg/Q3pxcTMRSHvMw22pg8CPP+c2a2oysZMcmPPiyFssVKBc4CPLhj+y/fPwTARHmS501rkOxb25NzNbk2gCFU0lKm0eQ3pvTsXdtABMq0r8pkXQkeaferaen5/fsXXS+VzpWDYL4cnZPXzZGTtKD71eLyfoFW+jDtNihgnpjHaT+SBV0oETeGUWHGSRaYSENU90Z/p67MQKrBAaymX4bkQXVzfXoGWEWHtB/EPJyfXk2/jHbMxRWVLbEZ0NRwgFk7Mh1socJPpIxW9m/KqkSC8xARCaaXeVbXby3i8eeKeHKwQyLZGXIZsNz/+Xr9qWzU8NeQj1DseV8lotWHB4A7kOfM5fV8FRNcwlVIaCPv3cbZUT8X/b6K8N9e/F8GPBrmj4hmP3nN6sxXbeHrz0y/H1+Bact38AF7LlPw==
|
||||
sidebar_class_name: "delete api-method"
|
||||
info_path: docs/API-docs/opensign-api-v-1
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import ApiTabs from "@theme/ApiTabs";
|
||||
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
|
||||
import MimeTabs from "@theme/MimeTabs";
|
||||
import ParamsItem from "@theme/ParamsItem";
|
||||
import ResponseSamples from "@theme/ResponseSamples";
|
||||
import SchemaItem from "@theme/SchemaItem";
|
||||
import SchemaTabs from "@theme/SchemaTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
|
||||
<h1
|
||||
className={"openapi__heading"}
|
||||
>
|
||||
Delete template by ID
|
||||
</h1>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"delete"}
|
||||
path={"/template/{template_id}"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Delete template by ID
|
||||
|
||||
## Request
|
||||
|
||||
<details
|
||||
style={{"marginBottom":"1rem"}}
|
||||
className={"openapi-markdown__details"}
|
||||
data-collapsed={false}
|
||||
open={true}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
>
|
||||
<h3
|
||||
className={"openapi-markdown__details-summary-header-params"}
|
||||
>
|
||||
Path Parameters
|
||||
</h3>
|
||||
</summary><div>
|
||||
<ul>
|
||||
<ParamsItem
|
||||
className={"paramsItem"}
|
||||
param={{"name":"template_id","in":"path","description":"ID of the template that needs to be deleted","required":true,"style":"simple","explode":false,"schema":{"type":"integer","format":"int64"}}}
|
||||
>
|
||||
|
||||
</ParamsItem>
|
||||
</ul>
|
||||
</div>
|
||||
</details><div>
|
||||
<div>
|
||||
<ApiTabs>
|
||||
<TabItem
|
||||
label={"400"}
|
||||
value={"400"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
Invalid ID supplied
|
||||
|
||||
|
||||
</div><div>
|
||||
|
||||
</div>
|
||||
</TabItem><TabItem
|
||||
label={"404"}
|
||||
value={"404"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
Order not found
|
||||
|
||||
|
||||
</div><div>
|
||||
|
||||
</div>
|
||||
</TabItem>
|
||||
</ApiTabs>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -0,0 +1,510 @@
|
||||
---
|
||||
id: find-pets-by-status
|
||||
title: "Finds Pets by status"
|
||||
description: "Multiple status values can be provided with comma separated strings"
|
||||
sidebar_label: "Finds Pets by status"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJztVk1v4zYQ/SuETl3AiZ120YNRFJtu0yDotgngFHtIjIKWRhY3EskVKTuGof/eN5RkyXYMBNs95pJYw/l4fPPB2UZeLl00fYgSE1cFae+i+ShKyMWlsl4ZHU2jv6rcK5uTcF76yomVzCtyIpZaLEjY0qxUQolYK5+J2BSFFI6sLKWH0PlSaUQYRcYSRPB4k8BnqnRyR979tpkFp1Bgk4I8lYxnG2l8QNF1x4qhfK2o3ESHAGd7uHwmvdCE4N4wwNhoB4AlBKkpRapyxICPkr5WCtJomsrc0QihNjmHhFaBc3q2uUkg8GXFp3FGhYym28hvbIOMrxbApBIUQSRXUuVyAS8w11XBxA5llnTS2DiTJ9G8rueMw1lAJMe+f5xM+N/+/VwVx+RcWuVixyJ84GIeGWN9aW2u4nAw/uLYaHsMWJalZPKUpyIE6xl4aOgGwsx480+ZhzJo7cziC8WeD0sO71UDVSUD3wpQloFWZk/6RvTz+8CjLCwTezGpR21aj0ncaaESl0tFEXRxIVoaJLzX/25YXgXld4PSraH6XOSs2dbkDhdOvPJB9eNA1pN4TH7raV0iZcw8F1c9yMkhmP3InWeA4tihd781xP+i8iR9x2wB5ZCoe9kotY39Yj8Ni9+S7waP0mhuHkOmfH2HHVFIfgjnjj9Za9hCrcVbB7110FsHvbKDWO/9S6/XjcbDrJK97aHBT3FVKr8Jz7206t8n4t9zfhSxCGSGF4UlBYKlz/Ax7raUXDkWOypX3b5QIafTKPPeuul4jMSdIyd4+ZcaN3PnWEwgVOPVRcT+u9gzbvEmbTsEfTlY9SdxPbQXfz6D5MybJ9LdQpKRxGoRrqN0aoJxy8stws8QXlze3QiEPUzLfaaQEBeOu3uF8RPWlANrsZAOC4xp8seHLP/p/EI4S7FK28l1Lh71o56ZgkTliBeGXOknN33UZ+LhNoWakrn4TAuHWp7/0LG1Xq+P2HoXbK6x1FULUZI1vfoyCAOlQ6vdxzvcFTtW4W7TGTKkYmozcyLUOCiP25VGxmGlweRVnNFW9OHQiEsQAxtCGtTm5fXdJ9Ayga++IF4Befzp5uPV37Mr9sol1aTo4nwCVzyPjPOF1INAf2CBdYJXWLHYiN2Wupfibb+ifaclui1MT89+bHOJEqzbi27bHuk3+dAjKPUM2Fm+3XINYfTVNYubVZo7J1GOe79fhE9e4tsW7RdBh07rt/tmKkyj0JwrWaowjXgYjLoeY6iN1SXWYesHVkfr794Iub66h66smJ5hbz+F3m5/sPfuSG8GvvebvgHAf+vRCYNfuDMxN37dqbcj75RBe79Om/nB1K3/A98eo4I=
|
||||
sidebar_class_name: "get api-method"
|
||||
info_path: docs/API-docs/opensign-api-v-1
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import ApiTabs from "@theme/ApiTabs";
|
||||
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
|
||||
import MimeTabs from "@theme/MimeTabs";
|
||||
import ParamsItem from "@theme/ParamsItem";
|
||||
import ResponseSamples from "@theme/ResponseSamples";
|
||||
import SchemaItem from "@theme/SchemaItem";
|
||||
import SchemaTabs from "@theme/SchemaTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
|
||||
<h1
|
||||
className={"openapi__heading"}
|
||||
>
|
||||
Finds Pets by status
|
||||
</h1>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/documentlist"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Multiple status values can be provided with comma separated strings
|
||||
|
||||
## Request
|
||||
|
||||
<details
|
||||
style={{"marginBottom":"1rem"}}
|
||||
className={"openapi-markdown__details"}
|
||||
data-collapsed={false}
|
||||
open={true}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
>
|
||||
<h3
|
||||
className={"openapi-markdown__details-summary-header-params"}
|
||||
>
|
||||
Query Parameters
|
||||
</h3>
|
||||
</summary><div>
|
||||
<ul>
|
||||
<ParamsItem
|
||||
className={"paramsItem"}
|
||||
param={{"name":"status","in":"query","description":"Status values that need to be considered for filter","required":false,"style":"form","explode":true,"schema":{"type":"string","default":"available","enum":["available","pending","sold"]}}}
|
||||
>
|
||||
|
||||
</ParamsItem>
|
||||
</ul>
|
||||
</div>
|
||||
</details><div>
|
||||
<div>
|
||||
<ApiTabs>
|
||||
<TabItem
|
||||
label={"200"}
|
||||
value={"200"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
successful operation
|
||||
|
||||
|
||||
</div><div>
|
||||
<MimeTabs
|
||||
className={"openapi-tabs__mime"}
|
||||
schemaType={"response"}
|
||||
>
|
||||
<TabItem
|
||||
label={"application/json"}
|
||||
value={"application/json"}
|
||||
>
|
||||
<SchemaTabs
|
||||
className={"openapi-tabs__schema"}
|
||||
>
|
||||
<TabItem
|
||||
label={"Schema"}
|
||||
value={"Schema"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details response"}
|
||||
data-collapsed={false}
|
||||
open={true}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
className={"openapi-markdown__details-summary-response"}
|
||||
>
|
||||
<strong>
|
||||
Schema
|
||||
</strong>
|
||||
</summary><div
|
||||
style={{"textAlign":"left","marginLeft":"1rem"}}
|
||||
>
|
||||
|
||||
</div><ul
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<li>
|
||||
<div
|
||||
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}
|
||||
>
|
||||
Array [
|
||||
</div>
|
||||
</li><SchemaItem
|
||||
collapsible={false}
|
||||
name={"id"}
|
||||
required={false}
|
||||
schemaName={"int64"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int64","example":10}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"name"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"doggie"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={true}
|
||||
className={"schemaItem"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details"}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
>
|
||||
<span
|
||||
className={"openapi-schema__container"}
|
||||
>
|
||||
<strong
|
||||
className={"openapi-schema__property"}
|
||||
>
|
||||
category
|
||||
</strong><span
|
||||
className={"openapi-schema__name"}
|
||||
>
|
||||
category
|
||||
</span>
|
||||
</span>
|
||||
</summary><div
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<SchemaItem
|
||||
collapsible={false}
|
||||
name={"id"}
|
||||
required={false}
|
||||
schemaName={"int64"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int64","example":1}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"name"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"Dogs"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</div>
|
||||
</details>
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"photoUrls"}
|
||||
required={true}
|
||||
schemaName={"string[]"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"array","xml":{"wrapped":true},"items":{"type":"string","xml":{"name":"photoUrl"}}}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={true}
|
||||
className={"schemaItem"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details"}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
>
|
||||
<span
|
||||
className={"openapi-schema__container"}
|
||||
>
|
||||
<strong
|
||||
className={"openapi-schema__property"}
|
||||
>
|
||||
tags
|
||||
</strong><span
|
||||
className={"openapi-schema__name"}
|
||||
>
|
||||
tag[]
|
||||
</span>
|
||||
</span>
|
||||
</summary><div
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<li>
|
||||
<div
|
||||
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}
|
||||
>
|
||||
Array [
|
||||
</div>
|
||||
</li><SchemaItem
|
||||
collapsible={false}
|
||||
name={"id"}
|
||||
required={false}
|
||||
schemaName={"int64"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int64"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"name"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem><li>
|
||||
<div
|
||||
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}
|
||||
>
|
||||
]
|
||||
</div>
|
||||
</li>
|
||||
</div>
|
||||
</details>
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"status"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={"**Possible values:** [`available`, `pending`, `sold`]"}
|
||||
schema={{"type":"string","description":"pet status in the store","enum":["available","pending","sold"]}}
|
||||
>
|
||||
|
||||
</SchemaItem><li>
|
||||
<div
|
||||
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}
|
||||
>
|
||||
]
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"Example (from schema)"}
|
||||
value={"Example (from schema)"}
|
||||
>
|
||||
<ResponseSamples
|
||||
responseExample={"[\n {\n \"id\": 10,\n \"name\": \"doggie\",\n \"category\": {\n \"id\": 1,\n \"name\": \"Dogs\"\n },\n \"photoUrls\": [\n \"string\"\n ],\n \"tags\": [\n {\n \"id\": 0,\n \"name\": \"string\"\n }\n ],\n \"status\": \"available\"\n }\n]"}
|
||||
language={"json"}
|
||||
>
|
||||
|
||||
</ResponseSamples>
|
||||
</TabItem>
|
||||
</SchemaTabs>
|
||||
</TabItem><TabItem
|
||||
label={"application/xml"}
|
||||
value={"application/xml"}
|
||||
>
|
||||
<SchemaTabs
|
||||
className={"openapi-tabs__schema"}
|
||||
>
|
||||
<TabItem
|
||||
label={"Schema"}
|
||||
value={"Schema"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details response"}
|
||||
data-collapsed={false}
|
||||
open={true}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
className={"openapi-markdown__details-summary-response"}
|
||||
>
|
||||
<strong>
|
||||
Schema
|
||||
</strong>
|
||||
</summary><div
|
||||
style={{"textAlign":"left","marginLeft":"1rem"}}
|
||||
>
|
||||
|
||||
</div><ul
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<li>
|
||||
<div
|
||||
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}
|
||||
>
|
||||
Array [
|
||||
</div>
|
||||
</li><SchemaItem
|
||||
collapsible={false}
|
||||
name={"id"}
|
||||
required={false}
|
||||
schemaName={"int64"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int64","example":10}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"name"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"doggie"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={true}
|
||||
className={"schemaItem"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details"}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
>
|
||||
<span
|
||||
className={"openapi-schema__container"}
|
||||
>
|
||||
<strong
|
||||
className={"openapi-schema__property"}
|
||||
>
|
||||
category
|
||||
</strong><span
|
||||
className={"openapi-schema__name"}
|
||||
>
|
||||
category
|
||||
</span>
|
||||
</span>
|
||||
</summary><div
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<SchemaItem
|
||||
collapsible={false}
|
||||
name={"id"}
|
||||
required={false}
|
||||
schemaName={"int64"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int64","example":1}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"name"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"Dogs"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</div>
|
||||
</details>
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"photoUrls"}
|
||||
required={true}
|
||||
schemaName={"string[]"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"array","xml":{"wrapped":true},"items":{"type":"string","xml":{"name":"photoUrl"}}}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={true}
|
||||
className={"schemaItem"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details"}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
>
|
||||
<span
|
||||
className={"openapi-schema__container"}
|
||||
>
|
||||
<strong
|
||||
className={"openapi-schema__property"}
|
||||
>
|
||||
tags
|
||||
</strong><span
|
||||
className={"openapi-schema__name"}
|
||||
>
|
||||
tag[]
|
||||
</span>
|
||||
</span>
|
||||
</summary><div
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<li>
|
||||
<div
|
||||
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}
|
||||
>
|
||||
Array [
|
||||
</div>
|
||||
</li><SchemaItem
|
||||
collapsible={false}
|
||||
name={"id"}
|
||||
required={false}
|
||||
schemaName={"int64"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int64"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"name"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem><li>
|
||||
<div
|
||||
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}
|
||||
>
|
||||
]
|
||||
</div>
|
||||
</li>
|
||||
</div>
|
||||
</details>
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"status"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={"**Possible values:** [`available`, `pending`, `sold`]"}
|
||||
schema={{"type":"string","description":"pet status in the store","enum":["available","pending","sold"]}}
|
||||
>
|
||||
|
||||
</SchemaItem><li>
|
||||
<div
|
||||
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}
|
||||
>
|
||||
]
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"Example (from schema)"}
|
||||
value={"Example (from schema)"}
|
||||
>
|
||||
<ResponseSamples
|
||||
responseExample={"<0>\n <id>10</id>\n <name>doggie</name>\n <category>\n <id>1</id>\n <name>Dogs</name>\n </category>\n <photoUrls>string</photoUrls>\n <tags>\n <id>0</id>\n <name>string</name>\n </tags>\n <status>available</status>\n</0>"}
|
||||
language={"xml"}
|
||||
>
|
||||
|
||||
</ResponseSamples>
|
||||
</TabItem>
|
||||
</SchemaTabs>
|
||||
</TabItem>
|
||||
</MimeTabs>
|
||||
</div>
|
||||
</TabItem><TabItem
|
||||
label={"400"}
|
||||
value={"400"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
Invalid status value
|
||||
|
||||
|
||||
</div><div>
|
||||
|
||||
</div>
|
||||
</TabItem>
|
||||
</ApiTabs>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -0,0 +1,510 @@
|
||||
---
|
||||
id: find-pets-by-tags
|
||||
title: "Finds Pets by tags"
|
||||
description: "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing."
|
||||
sidebar_label: "Finds Pets by tags"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJztVktv4zYQ/isET13AsezdRQ9GUTTdpkHQbRPAWfSQGAUtjSRuJJJLUnYMQ/+9MxRly3YMBH3ccpHN4TfvB2fLvSgcnz3wTKdNDco7vhjxDFxqpfFSKz7jvzeVl6YCRliWCsWWwIzVK5lBxtbSlyzVdS2YAyOs8Eh03kpVuDH74gLbdETf9+H7geXaMg/OI2TMR1wbQC7UdZOhtlyq7A68+3lzT6aNOMmswYMlO7dc4QFhvruUZOC3BuyGH5tN7MxrlssKmdmSEBa+NdIC6slF5WDEnd9UJA5NqvEenk2lMyR429BtWkIt+GzL/cYQTFgrSI70ULsBvfOXt227ICXOaOUgAN5PJvRzaJpr0hScy5uK7ZxHqalWHlNAeGFMJdNwkXx1xLR9hTV79x66OGH0Su31F1uFvEY+vfwKqadLS+q97EyV2UC2RFMKsAii0Ajfkb7/GIIkakNRm07aUczHcSQGKCytopDAEYsOQaExV3v8f2bLq0z5RWPVtAh9ritCxmLa2YU3XvoA/TSg7YN4GvwoaW0xZRR5qpz2bIUca+4lU+mMYjP+UxX/KpRnw3caLbRyGKh70YGcF7550eXD4jfgWYdlUjFfAp60pVoF1dRUumIlZCWWVahfUFknxekq44tTc1De0Jw7OhJq2EKR462D3jrorYNe2UGE+/jS63WjVqKSGb3lDP810BkPaWOl34RHWhj51xPQ/wW9iPh8l5oe9wJCdIUv8ZD0O0dCtoFd9U98g9mc8dJ742ZJgikbYzaUk4VCn9wYlw0kymQ15SS8Vzyn5u4StlO/LwQjfwOqhOjy8wVSLrx+AtVvESWIDPNKvkiV68AcI3KL6ueonl3e3TBUe7JqlBJT4cJ171QYPGHVOeJmS+FwRdJd5uiS6B/GU+YMpDKPM2vMHtWjmusaWOOAVoVKqic3e1QX7OE2R5gUFfsTlg6rePFdH631en0SrXeB5xoXtWbJLBi9hxeBGEI65Nod3qGvuD3V7jafY4ZkCjEzZ1QlAZzEZUakYZnBmSspo5H00zETFR+OaiTCoCovr+8+Y1gmKGtfEK8wOfl88+nqj/kVSaWS6lI0HU9QFE0i7Xwt1EDRr7hxOkY7Jy6JLC6WBwne7lez/30bjgXr4dknphJYmm0MwDY2zn5ZRzg9SiW6ROTtlkoLZ2HbErlbi6mhMuloGOzX3rPevbQ0v2hRaK9+C++mwIyHflwJK8PooeYf9W1FZnQ8l7j7Gj/gOtl1D0bG9dU9YkVDng/b+Sm0c/xD0vsrtRnIPuzzzgD6tqMzDD9QM+Ko+HEHjyPuHEP0r0dTdHDEtn8DnqqFeQ==
|
||||
sidebar_class_name: "get api-method"
|
||||
info_path: docs/API-docs/opensign-api-v-1
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import ApiTabs from "@theme/ApiTabs";
|
||||
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
|
||||
import MimeTabs from "@theme/MimeTabs";
|
||||
import ParamsItem from "@theme/ParamsItem";
|
||||
import ResponseSamples from "@theme/ResponseSamples";
|
||||
import SchemaItem from "@theme/SchemaItem";
|
||||
import SchemaTabs from "@theme/SchemaTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
|
||||
<h1
|
||||
className={"openapi__heading"}
|
||||
>
|
||||
Finds Pets by tags
|
||||
</h1>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/document/"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
|
||||
|
||||
## Request
|
||||
|
||||
<details
|
||||
style={{"marginBottom":"1rem"}}
|
||||
className={"openapi-markdown__details"}
|
||||
data-collapsed={false}
|
||||
open={true}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
>
|
||||
<h3
|
||||
className={"openapi-markdown__details-summary-header-params"}
|
||||
>
|
||||
Query Parameters
|
||||
</h3>
|
||||
</summary><div>
|
||||
<ul>
|
||||
<ParamsItem
|
||||
className={"paramsItem"}
|
||||
param={{"name":"tags","in":"query","description":"Tags to filter by","required":false,"style":"form","explode":true,"schema":{"type":"array","items":{"type":"string"}}}}
|
||||
>
|
||||
|
||||
</ParamsItem>
|
||||
</ul>
|
||||
</div>
|
||||
</details><div>
|
||||
<div>
|
||||
<ApiTabs>
|
||||
<TabItem
|
||||
label={"200"}
|
||||
value={"200"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
successful operation
|
||||
|
||||
|
||||
</div><div>
|
||||
<MimeTabs
|
||||
className={"openapi-tabs__mime"}
|
||||
schemaType={"response"}
|
||||
>
|
||||
<TabItem
|
||||
label={"application/json"}
|
||||
value={"application/json"}
|
||||
>
|
||||
<SchemaTabs
|
||||
className={"openapi-tabs__schema"}
|
||||
>
|
||||
<TabItem
|
||||
label={"Schema"}
|
||||
value={"Schema"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details response"}
|
||||
data-collapsed={false}
|
||||
open={true}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
className={"openapi-markdown__details-summary-response"}
|
||||
>
|
||||
<strong>
|
||||
Schema
|
||||
</strong>
|
||||
</summary><div
|
||||
style={{"textAlign":"left","marginLeft":"1rem"}}
|
||||
>
|
||||
|
||||
</div><ul
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<li>
|
||||
<div
|
||||
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}
|
||||
>
|
||||
Array [
|
||||
</div>
|
||||
</li><SchemaItem
|
||||
collapsible={false}
|
||||
name={"id"}
|
||||
required={false}
|
||||
schemaName={"int64"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int64","example":10}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"name"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"doggie"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={true}
|
||||
className={"schemaItem"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details"}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
>
|
||||
<span
|
||||
className={"openapi-schema__container"}
|
||||
>
|
||||
<strong
|
||||
className={"openapi-schema__property"}
|
||||
>
|
||||
category
|
||||
</strong><span
|
||||
className={"openapi-schema__name"}
|
||||
>
|
||||
category
|
||||
</span>
|
||||
</span>
|
||||
</summary><div
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<SchemaItem
|
||||
collapsible={false}
|
||||
name={"id"}
|
||||
required={false}
|
||||
schemaName={"int64"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int64","example":1}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"name"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"Dogs"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</div>
|
||||
</details>
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"photoUrls"}
|
||||
required={true}
|
||||
schemaName={"string[]"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"array","xml":{"wrapped":true},"items":{"type":"string","xml":{"name":"photoUrl"}}}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={true}
|
||||
className={"schemaItem"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details"}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
>
|
||||
<span
|
||||
className={"openapi-schema__container"}
|
||||
>
|
||||
<strong
|
||||
className={"openapi-schema__property"}
|
||||
>
|
||||
tags
|
||||
</strong><span
|
||||
className={"openapi-schema__name"}
|
||||
>
|
||||
tag[]
|
||||
</span>
|
||||
</span>
|
||||
</summary><div
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<li>
|
||||
<div
|
||||
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}
|
||||
>
|
||||
Array [
|
||||
</div>
|
||||
</li><SchemaItem
|
||||
collapsible={false}
|
||||
name={"id"}
|
||||
required={false}
|
||||
schemaName={"int64"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int64"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"name"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem><li>
|
||||
<div
|
||||
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}
|
||||
>
|
||||
]
|
||||
</div>
|
||||
</li>
|
||||
</div>
|
||||
</details>
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"status"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={"**Possible values:** [`available`, `pending`, `sold`]"}
|
||||
schema={{"type":"string","description":"pet status in the store","enum":["available","pending","sold"]}}
|
||||
>
|
||||
|
||||
</SchemaItem><li>
|
||||
<div
|
||||
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}
|
||||
>
|
||||
]
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"Example (from schema)"}
|
||||
value={"Example (from schema)"}
|
||||
>
|
||||
<ResponseSamples
|
||||
responseExample={"[\n {\n \"id\": 10,\n \"name\": \"doggie\",\n \"category\": {\n \"id\": 1,\n \"name\": \"Dogs\"\n },\n \"photoUrls\": [\n \"string\"\n ],\n \"tags\": [\n {\n \"id\": 0,\n \"name\": \"string\"\n }\n ],\n \"status\": \"available\"\n }\n]"}
|
||||
language={"json"}
|
||||
>
|
||||
|
||||
</ResponseSamples>
|
||||
</TabItem>
|
||||
</SchemaTabs>
|
||||
</TabItem><TabItem
|
||||
label={"application/xml"}
|
||||
value={"application/xml"}
|
||||
>
|
||||
<SchemaTabs
|
||||
className={"openapi-tabs__schema"}
|
||||
>
|
||||
<TabItem
|
||||
label={"Schema"}
|
||||
value={"Schema"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details response"}
|
||||
data-collapsed={false}
|
||||
open={true}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
className={"openapi-markdown__details-summary-response"}
|
||||
>
|
||||
<strong>
|
||||
Schema
|
||||
</strong>
|
||||
</summary><div
|
||||
style={{"textAlign":"left","marginLeft":"1rem"}}
|
||||
>
|
||||
|
||||
</div><ul
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<li>
|
||||
<div
|
||||
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}
|
||||
>
|
||||
Array [
|
||||
</div>
|
||||
</li><SchemaItem
|
||||
collapsible={false}
|
||||
name={"id"}
|
||||
required={false}
|
||||
schemaName={"int64"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int64","example":10}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"name"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"doggie"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={true}
|
||||
className={"schemaItem"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details"}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
>
|
||||
<span
|
||||
className={"openapi-schema__container"}
|
||||
>
|
||||
<strong
|
||||
className={"openapi-schema__property"}
|
||||
>
|
||||
category
|
||||
</strong><span
|
||||
className={"openapi-schema__name"}
|
||||
>
|
||||
category
|
||||
</span>
|
||||
</span>
|
||||
</summary><div
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<SchemaItem
|
||||
collapsible={false}
|
||||
name={"id"}
|
||||
required={false}
|
||||
schemaName={"int64"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int64","example":1}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"name"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"Dogs"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</div>
|
||||
</details>
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"photoUrls"}
|
||||
required={true}
|
||||
schemaName={"string[]"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"array","xml":{"wrapped":true},"items":{"type":"string","xml":{"name":"photoUrl"}}}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={true}
|
||||
className={"schemaItem"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details"}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
>
|
||||
<span
|
||||
className={"openapi-schema__container"}
|
||||
>
|
||||
<strong
|
||||
className={"openapi-schema__property"}
|
||||
>
|
||||
tags
|
||||
</strong><span
|
||||
className={"openapi-schema__name"}
|
||||
>
|
||||
tag[]
|
||||
</span>
|
||||
</span>
|
||||
</summary><div
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<li>
|
||||
<div
|
||||
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}
|
||||
>
|
||||
Array [
|
||||
</div>
|
||||
</li><SchemaItem
|
||||
collapsible={false}
|
||||
name={"id"}
|
||||
required={false}
|
||||
schemaName={"int64"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int64"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"name"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem><li>
|
||||
<div
|
||||
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}
|
||||
>
|
||||
]
|
||||
</div>
|
||||
</li>
|
||||
</div>
|
||||
</details>
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"status"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={"**Possible values:** [`available`, `pending`, `sold`]"}
|
||||
schema={{"type":"string","description":"pet status in the store","enum":["available","pending","sold"]}}
|
||||
>
|
||||
|
||||
</SchemaItem><li>
|
||||
<div
|
||||
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}
|
||||
>
|
||||
]
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"Example (from schema)"}
|
||||
value={"Example (from schema)"}
|
||||
>
|
||||
<ResponseSamples
|
||||
responseExample={"<0>\n <id>10</id>\n <name>doggie</name>\n <category>\n <id>1</id>\n <name>Dogs</name>\n </category>\n <photoUrls>string</photoUrls>\n <tags>\n <id>0</id>\n <name>string</name>\n </tags>\n <status>available</status>\n</0>"}
|
||||
language={"xml"}
|
||||
>
|
||||
|
||||
</ResponseSamples>
|
||||
</TabItem>
|
||||
</SchemaTabs>
|
||||
</TabItem>
|
||||
</MimeTabs>
|
||||
</div>
|
||||
</TabItem><TabItem
|
||||
label={"400"}
|
||||
value={"400"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
Invalid tag value
|
||||
|
||||
|
||||
</div><div>
|
||||
|
||||
</div>
|
||||
</TabItem>
|
||||
</ApiTabs>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -0,0 +1,125 @@
|
||||
---
|
||||
id: get-inventory
|
||||
title: "Returns pet inventories by status"
|
||||
description: "Returns a map of status codes to quantities"
|
||||
sidebar_label: "Returns pet inventories by status"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJyVVG1r2zAQ/itCn1ZI47T9FsZoGaWElbUsHfvQhqHI51iNLanSOW0w+e+7U+wkzShsISTS3XPv96iVqBZRjh9l7nRTg8UoZwOZQ9TBeDTOyrH8AdgEG4UStfLCFSKiwiYK7Qgn0ImXRlk0aCDKgXQegmLLSU62C8CJXZFfF9akDBC9s5GA41aej0b89z5YbLSGGIumEjtPZKidRfLCeOV9ZXRSZM+RjVoZdQm14hOuPZAbN38GjWSo8twwVFX3gR2mLPc4Q24XEAhYuFAr3IouzuUmfQYygm6CwTX1iEOb30vg82xDbaoBS9dVSR68wpIumQ6gEPqGSvYRVhBictGEijAloo/jLKNahpSVjWZhKzWPQ+1qEppsdSY5Qh99yvVtE9/lsKuBJN+Au2tVzfe3U5KcolsCd85wV0tQOVXJBRlbuGRssGL0HYWfUnhxdT8RFPZ4+g+liYK+rO5rSs0X1DFxZC3mKkIuSIklJCXLL4ZnInrQpujmNhRP9slOXQ2iicCzroxdxvGTPRWPdwXBjKrEL5hHgzD71Hfr9fX1r26dJJsbg2UzFwG828MXSZhaemi1u5xQrQihjnfFlCZkNHST+SBUlsBZt41Kp22ktTM80U50eWwkqeW0riQEhncjurq5v6W2jMjXfiH+IeXsdvL1+vv0mr3ySm1HdDYckSsSeRexVvYgUM9dDyhMR0RigJivOxYfz7vdU+0/id9tI8IbZr5StHebrrq2o8ajPKIGbXhJKbOmbXl1foZqs2HxSwMh8YzqVMGoOe8qsW7QrzJzKdFAXtGD4ZlmK1U1Wz4cPRDvuHpz/cDPQsMJHVJomSjUHdh7r7LrA9/vubVNgH83gw8MPjMBiJ5fdvCt5kODrr4ezW2c0Uv0B0/s87M=
|
||||
sidebar_class_name: "get api-method"
|
||||
info_path: docs/API-docs/opensign-api-v-1
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import ApiTabs from "@theme/ApiTabs";
|
||||
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
|
||||
import MimeTabs from "@theme/MimeTabs";
|
||||
import ParamsItem from "@theme/ParamsItem";
|
||||
import ResponseSamples from "@theme/ResponseSamples";
|
||||
import SchemaItem from "@theme/SchemaItem";
|
||||
import SchemaTabs from "@theme/SchemaTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
|
||||
<h1
|
||||
className={"openapi__heading"}
|
||||
>
|
||||
Returns pet inventories by status
|
||||
</h1>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/createdocument"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Returns a map of status codes to quantities
|
||||
|
||||
## Request
|
||||
|
||||
<div>
|
||||
<div>
|
||||
<ApiTabs>
|
||||
<TabItem
|
||||
label={"200"}
|
||||
value={"200"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
successful operation
|
||||
|
||||
|
||||
</div><div>
|
||||
<MimeTabs
|
||||
className={"openapi-tabs__mime"}
|
||||
schemaType={"response"}
|
||||
>
|
||||
<TabItem
|
||||
label={"application/json"}
|
||||
value={"application/json"}
|
||||
>
|
||||
<SchemaTabs
|
||||
className={"openapi-tabs__schema"}
|
||||
>
|
||||
<TabItem
|
||||
label={"Schema"}
|
||||
value={"Schema"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details response"}
|
||||
data-collapsed={false}
|
||||
open={true}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
className={"openapi-markdown__details-summary-response"}
|
||||
>
|
||||
<strong>
|
||||
Schema
|
||||
</strong>
|
||||
</summary><div
|
||||
style={{"textAlign":"left","marginLeft":"1rem"}}
|
||||
>
|
||||
|
||||
</div><ul
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<SchemaItem
|
||||
name={"property name*"}
|
||||
required={false}
|
||||
schemaName={"int32"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int32"}}
|
||||
collapsible={false}
|
||||
discriminator={false}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"Example (from schema)"}
|
||||
value={"Example (from schema)"}
|
||||
>
|
||||
<ResponseSamples
|
||||
responseExample={"{}"}
|
||||
language={"json"}
|
||||
>
|
||||
|
||||
</ResponseSamples>
|
||||
</TabItem>
|
||||
</SchemaTabs>
|
||||
</TabItem>
|
||||
</MimeTabs>
|
||||
</div>
|
||||
</TabItem>
|
||||
</ApiTabs>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -0,0 +1,499 @@
|
||||
---
|
||||
id: get-pet-by-id
|
||||
title: "Find pet by ID"
|
||||
description: "Returns a single pet"
|
||||
sidebar_label: "Find pet by ID"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJztVktv4zYQ/isETxvAsZw26MEoiqa7aWB00QTrFD0kxoKWRhI3EsklqSSGoP/eGUqy5BcQtD3mYovkNw9+M8OZmnuROT5/4LFWXsTe8dWEJ+BiK42XWvE5/wK+ssoxwZxUWQHMgOcTrg1YQZBFgqAM/B343za4mHAjrCjBgyXNNVe4QEhn4askiCTNRvic75tbfGI6JRvMa2aDbcRY+F5JC2jK2wom3PlNQUqdLA1+TDi8mkInuJWKwhEgzqEUfF5zvzGElMpDBhahqbal8O3WT5e8aVak3xmtHDiS+GE2o79dv1wVx+BcWhVse3VURrcC5QkvjClkHA6ib46E6pEbww0eWkaQp1x7/ZctAumdm3r9DWLi11gy42XrEpL2hqsQDSIQMr+YNZOO+a2c8xYjOEbxRGeZBI5YdBwybTcj/P/my5tc+aQxExuEvpYFIfu06f3CEy99gH4c7Q0kDtqFtWLDt5peLIamzx0UkR5Kd8yZXcu9ZnSKbIdC+bcm/hOVJ+k7ZAu9HBN1L1qQ88JXR6+8m+RUdi2WScV8DrjSNtSXqkpKXfEsZCHWoeYMqKTV4nSR8NWhO/RUjNy5oyWux5XSCbwXynuhvBfKbqEQ7PJYL1qoZ1HIhGGvdBXVEhIasJeHWFTFlPYs1ZVK2jtCXFnpN6E5CyO/PgF9r6gPYtvOddfQQyfHDj3nUde7o3po4g3dBuxz3+UrjP+c594bN48iDPIU46eczBSy4KaxLnFTRs8XnOz0Piyp7NsQbz0ZUsfIP4BypyPp9Rx3zr1+AtWPEDmIBDOBriVVqoNwx+Etml+ieXZ1t2Bodj+E97nE4LlwnOi4KrGNhycJqbJsT5qthYOE6TbWdEj7P04vmDMQy7R7zabsUT2qpS6BVQ5oViikenLzR3XOHm5ThElRsL9h7TDvVx96tl5eXg7YOgsyN9Ln1RrnIKMHeBY2A6Vjqe3iDO+K01fpbtMlRkjG0EXmhKkogKNumsHwEo34GstiGNt+3ReihMNHHDdhlMdXN3efkZYZ6hoS4g0uR58XH6//XF6TVkqpNkQX0xmqordLO18KNTL0u1RJmBLXGyyD/eDWw1x2an7tcszDq49MITCbms7nukv77VCM6PloesX0zdEfAtQ15QU+fU1D298rsKGU8BLCylD9VBuJdPSdbKfTk85++NJ1vzN2fBA+6nZfL4qKBZ+Gilb4GcppPHg3K0R3NUOOtYArnGyNH4keTLI7T8PN9T1iRUUcjWv1KdRq90Haj7q1W8StA/TbTE4I/EyVhu/AL1t4e3JSoLtfjyaK8MVt/gG/tF3l
|
||||
sidebar_class_name: "get api-method"
|
||||
info_path: docs/API-docs/opensign-api-v-1
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import ApiTabs from "@theme/ApiTabs";
|
||||
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
|
||||
import MimeTabs from "@theme/MimeTabs";
|
||||
import ParamsItem from "@theme/ParamsItem";
|
||||
import ResponseSamples from "@theme/ResponseSamples";
|
||||
import SchemaItem from "@theme/SchemaItem";
|
||||
import SchemaTabs from "@theme/SchemaTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
|
||||
<h1
|
||||
className={"openapi__heading"}
|
||||
>
|
||||
Find pet by ID
|
||||
</h1>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/contact/{contact_id}"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Returns a single pet
|
||||
|
||||
## Request
|
||||
|
||||
<details
|
||||
style={{"marginBottom":"1rem"}}
|
||||
className={"openapi-markdown__details"}
|
||||
data-collapsed={false}
|
||||
open={true}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
>
|
||||
<h3
|
||||
className={"openapi-markdown__details-summary-header-params"}
|
||||
>
|
||||
Path Parameters
|
||||
</h3>
|
||||
</summary><div>
|
||||
<ul>
|
||||
<ParamsItem
|
||||
className={"paramsItem"}
|
||||
param={{"name":"contact_id","in":"path","description":"ID of pet to return","required":true,"style":"simple","explode":false,"schema":{"type":"integer","format":"int64"}}}
|
||||
>
|
||||
|
||||
</ParamsItem>
|
||||
</ul>
|
||||
</div>
|
||||
</details><div>
|
||||
<div>
|
||||
<ApiTabs>
|
||||
<TabItem
|
||||
label={"200"}
|
||||
value={"200"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
successful operation
|
||||
|
||||
|
||||
</div><div>
|
||||
<MimeTabs
|
||||
className={"openapi-tabs__mime"}
|
||||
schemaType={"response"}
|
||||
>
|
||||
<TabItem
|
||||
label={"application/json"}
|
||||
value={"application/json"}
|
||||
>
|
||||
<SchemaTabs
|
||||
className={"openapi-tabs__schema"}
|
||||
>
|
||||
<TabItem
|
||||
label={"Schema"}
|
||||
value={"Schema"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details response"}
|
||||
data-collapsed={false}
|
||||
open={true}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
className={"openapi-markdown__details-summary-response"}
|
||||
>
|
||||
<strong>
|
||||
Schema
|
||||
</strong>
|
||||
</summary><div
|
||||
style={{"textAlign":"left","marginLeft":"1rem"}}
|
||||
>
|
||||
|
||||
</div><ul
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<SchemaItem
|
||||
collapsible={false}
|
||||
name={"id"}
|
||||
required={false}
|
||||
schemaName={"int64"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int64","example":10}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"name"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"doggie"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={true}
|
||||
className={"schemaItem"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details"}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
>
|
||||
<span
|
||||
className={"openapi-schema__container"}
|
||||
>
|
||||
<strong
|
||||
className={"openapi-schema__property"}
|
||||
>
|
||||
category
|
||||
</strong><span
|
||||
className={"openapi-schema__name"}
|
||||
>
|
||||
category
|
||||
</span>
|
||||
</span>
|
||||
</summary><div
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<SchemaItem
|
||||
collapsible={false}
|
||||
name={"id"}
|
||||
required={false}
|
||||
schemaName={"int64"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int64","example":1}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"name"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"Dogs"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</div>
|
||||
</details>
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"photoUrls"}
|
||||
required={true}
|
||||
schemaName={"string[]"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"array","xml":{"wrapped":true},"items":{"type":"string","xml":{"name":"photoUrl"}}}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={true}
|
||||
className={"schemaItem"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details"}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
>
|
||||
<span
|
||||
className={"openapi-schema__container"}
|
||||
>
|
||||
<strong
|
||||
className={"openapi-schema__property"}
|
||||
>
|
||||
tags
|
||||
</strong><span
|
||||
className={"openapi-schema__name"}
|
||||
>
|
||||
tag[]
|
||||
</span>
|
||||
</span>
|
||||
</summary><div
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<li>
|
||||
<div
|
||||
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}
|
||||
>
|
||||
Array [
|
||||
</div>
|
||||
</li><SchemaItem
|
||||
collapsible={false}
|
||||
name={"id"}
|
||||
required={false}
|
||||
schemaName={"int64"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int64"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"name"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem><li>
|
||||
<div
|
||||
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}
|
||||
>
|
||||
]
|
||||
</div>
|
||||
</li>
|
||||
</div>
|
||||
</details>
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"status"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={"**Possible values:** [`available`, `pending`, `sold`]"}
|
||||
schema={{"type":"string","description":"pet status in the store","enum":["available","pending","sold"]}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"Example (from schema)"}
|
||||
value={"Example (from schema)"}
|
||||
>
|
||||
<ResponseSamples
|
||||
responseExample={"{\n \"id\": 10,\n \"name\": \"doggie\",\n \"category\": {\n \"id\": 1,\n \"name\": \"Dogs\"\n },\n \"photoUrls\": [\n \"string\"\n ],\n \"tags\": [\n {\n \"id\": 0,\n \"name\": \"string\"\n }\n ],\n \"status\": \"available\"\n}"}
|
||||
language={"json"}
|
||||
>
|
||||
|
||||
</ResponseSamples>
|
||||
</TabItem>
|
||||
</SchemaTabs>
|
||||
</TabItem><TabItem
|
||||
label={"application/xml"}
|
||||
value={"application/xml"}
|
||||
>
|
||||
<SchemaTabs
|
||||
className={"openapi-tabs__schema"}
|
||||
>
|
||||
<TabItem
|
||||
label={"Schema"}
|
||||
value={"Schema"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details response"}
|
||||
data-collapsed={false}
|
||||
open={true}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
className={"openapi-markdown__details-summary-response"}
|
||||
>
|
||||
<strong>
|
||||
Schema
|
||||
</strong>
|
||||
</summary><div
|
||||
style={{"textAlign":"left","marginLeft":"1rem"}}
|
||||
>
|
||||
|
||||
</div><ul
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<SchemaItem
|
||||
collapsible={false}
|
||||
name={"id"}
|
||||
required={false}
|
||||
schemaName={"int64"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int64","example":10}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"name"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"doggie"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={true}
|
||||
className={"schemaItem"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details"}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
>
|
||||
<span
|
||||
className={"openapi-schema__container"}
|
||||
>
|
||||
<strong
|
||||
className={"openapi-schema__property"}
|
||||
>
|
||||
category
|
||||
</strong><span
|
||||
className={"openapi-schema__name"}
|
||||
>
|
||||
category
|
||||
</span>
|
||||
</span>
|
||||
</summary><div
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<SchemaItem
|
||||
collapsible={false}
|
||||
name={"id"}
|
||||
required={false}
|
||||
schemaName={"int64"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int64","example":1}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"name"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"Dogs"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</div>
|
||||
</details>
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"photoUrls"}
|
||||
required={true}
|
||||
schemaName={"string[]"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"array","xml":{"wrapped":true},"items":{"type":"string","xml":{"name":"photoUrl"}}}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={true}
|
||||
className={"schemaItem"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details"}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
>
|
||||
<span
|
||||
className={"openapi-schema__container"}
|
||||
>
|
||||
<strong
|
||||
className={"openapi-schema__property"}
|
||||
>
|
||||
tags
|
||||
</strong><span
|
||||
className={"openapi-schema__name"}
|
||||
>
|
||||
tag[]
|
||||
</span>
|
||||
</span>
|
||||
</summary><div
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<li>
|
||||
<div
|
||||
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}
|
||||
>
|
||||
Array [
|
||||
</div>
|
||||
</li><SchemaItem
|
||||
collapsible={false}
|
||||
name={"id"}
|
||||
required={false}
|
||||
schemaName={"int64"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int64"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"name"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem><li>
|
||||
<div
|
||||
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}
|
||||
>
|
||||
]
|
||||
</div>
|
||||
</li>
|
||||
</div>
|
||||
</details>
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"status"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={"**Possible values:** [`available`, `pending`, `sold`]"}
|
||||
schema={{"type":"string","description":"pet status in the store","enum":["available","pending","sold"]}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"Example (from schema)"}
|
||||
value={"Example (from schema)"}
|
||||
>
|
||||
<ResponseSamples
|
||||
responseExample={"<root>\n <id>10</id>\n <name>doggie</name>\n <category>\n <id>1</id>\n <name>Dogs</name>\n </category>\n <photoUrls>string</photoUrls>\n <tags>\n <id>0</id>\n <name>string</name>\n </tags>\n <status>available</status>\n</root>"}
|
||||
language={"xml"}
|
||||
>
|
||||
|
||||
</ResponseSamples>
|
||||
</TabItem>
|
||||
</SchemaTabs>
|
||||
</TabItem>
|
||||
</MimeTabs>
|
||||
</div>
|
||||
</TabItem><TabItem
|
||||
label={"400"}
|
||||
value={"400"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
Invalid ID supplied
|
||||
|
||||
|
||||
</div><div>
|
||||
|
||||
</div>
|
||||
</TabItem><TabItem
|
||||
label={"404"}
|
||||
value={"404"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
Pet not found
|
||||
|
||||
|
||||
</div><div>
|
||||
|
||||
</div>
|
||||
</TabItem>
|
||||
</ApiTabs>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -0,0 +1,219 @@
|
||||
---
|
||||
id: get-template
|
||||
title: "Get template by ID"
|
||||
description: ""
|
||||
sidebar_label: "Get template by ID"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJyVVU1v2zAM/SuaLluBNG63nXJasRZBsKItlg47tMUg23Ss1pY8ic4HDP/3kYqduGk3rECAWBT5SJF8ZCNRLbyc3EmEsioUgpcPI5mCT5yuUFsjJ1KOpK3AKT7OUhIsAG87dbqrlFMlIDjGaaShA+n0eL90SjqacSqFuTwEn50Lm4leW2CuUBiA1Au0IgaRASY5MIaD37V29DlBV8NIetwU7MlrsuVAYF0VNiVRpgrPCmRYKjlpJG6qoIlOmwVpZtaVCrcSErTtA8P7yhpPCSCDjycn/Pc8VF8nCXif1YXY5YPAEmsQDLK+qqpCJ+EievRs1LyMwsaPkCAnzjEM6q3Lq5C3f8e6lcBahReTKHzssifbkbyy+GaYmwKUB+FgqWEllEmF1wtDtdBepDapS34eYZ8P0/E2F7sCD1NKkD++X74VKkes/CSKNrZ2ulQLGCe2ZCwOOnThDk85pzZD4zv5aOHLolS6CFYjOudmIKBGWJcFQ3R93IOO5MpRefv2I3ea3uRfC34fKjvrTp2718EJDTUWz0QtZ6FIwTHl3pah9aOP1elUrW8CzHOfiQOqw7BleteHNy0bf36NCT37hbEoMlub9J0Mup9f6s7MUhU6FWc3M3Frn8C8ex+iopGR226ahClCw2Eio9591AwmSEsKHtyynzG1KwaNQGUZE5MMp65QsedUk1BHy1PJzPaQUKfgZs5M3JKNbn89wWbYKpX+BtwrXZrWxyQ5Rg64n185KCpHCF6bzAbjLnXX5H7OnOFXktvDKXfLVKIfX/eMCmOCsufEgbWIiY2psMxACJcs/zQ+Fb6CRGfdhBmLe3Nv5rYEUXvgqVRo8+Qn9+ZY3F1npKZVIX5C7KlTHz702VqtVi+ydRRsphrzOqYxUNm9+iIIQ0qHVrvDEb2VZn/pr7M5VUgnPUX/4ioKylE3N1US5iYw/7gDt6Ivh0bcXDRYSQiDTj6b3lxSWk4Ia98Q/xFydDn7enE1v2BUbqltiU7HJwRFosp6LJUZOJoC7jdUvBGz88MCN/stwOuy6ymENUZkpcOoCzE2XaPvFy6pT4bLkho2pwhYpWm4E364om1Z/LsGRy17R59L5bSKw0QjvmnP3+lu8f01tA/fux16JP5/7776mJ41hilDBK9h+/JAqmfLv30g9Y46HO1W44xWaYUD2xerk5m7mxHTi1vi3R8/Pvp4
|
||||
sidebar_class_name: "get api-method"
|
||||
info_path: docs/API-docs/opensign-api-v-1
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import ApiTabs from "@theme/ApiTabs";
|
||||
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
|
||||
import MimeTabs from "@theme/MimeTabs";
|
||||
import ParamsItem from "@theme/ParamsItem";
|
||||
import ResponseSamples from "@theme/ResponseSamples";
|
||||
import SchemaItem from "@theme/SchemaItem";
|
||||
import SchemaTabs from "@theme/SchemaTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
|
||||
<h1
|
||||
className={"openapi__heading"}
|
||||
>
|
||||
Get template by ID
|
||||
</h1>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/template/{template_id}"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Request
|
||||
|
||||
<details
|
||||
style={{"marginBottom":"1rem"}}
|
||||
className={"openapi-markdown__details"}
|
||||
data-collapsed={false}
|
||||
open={true}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
>
|
||||
<h3
|
||||
className={"openapi-markdown__details-summary-header-params"}
|
||||
>
|
||||
Path Parameters
|
||||
</h3>
|
||||
</summary><div>
|
||||
<ul>
|
||||
<ParamsItem
|
||||
className={"paramsItem"}
|
||||
param={{"name":"template_id","in":"path","description":"ID of template that needs to be fetched","required":true,"style":"simple","explode":false,"schema":{"type":"string","format":"strng"}}}
|
||||
>
|
||||
|
||||
</ParamsItem>
|
||||
</ul>
|
||||
</div>
|
||||
</details><div>
|
||||
<div>
|
||||
<ApiTabs>
|
||||
<TabItem
|
||||
label={"200"}
|
||||
value={"200"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
successful operation
|
||||
|
||||
|
||||
</div><div>
|
||||
<MimeTabs
|
||||
className={"openapi-tabs__mime"}
|
||||
schemaType={"response"}
|
||||
>
|
||||
<TabItem
|
||||
label={"application/json"}
|
||||
value={"application/json"}
|
||||
>
|
||||
<SchemaTabs
|
||||
className={"openapi-tabs__schema"}
|
||||
>
|
||||
<TabItem
|
||||
label={"Schema"}
|
||||
value={"Schema"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details response"}
|
||||
data-collapsed={false}
|
||||
open={true}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
className={"openapi-markdown__details-summary-response"}
|
||||
>
|
||||
<strong>
|
||||
Schema
|
||||
</strong>
|
||||
</summary><div
|
||||
style={{"textAlign":"left","marginLeft":"1rem"}}
|
||||
>
|
||||
|
||||
</div><ul
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<SchemaItem
|
||||
collapsible={false}
|
||||
name={"Name"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"string","example":"sample template"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"Note"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"string","example":"Please review and sign this document"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"Description"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"string","example":"template description"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"URL"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"string","example":"https://yourimage.com"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"signers"}
|
||||
required={false}
|
||||
schemaName={"signers[]"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"array","example":["joe@gmail.com","john@gmail.com"],"xml":{"name":"signers","wrapped":true},"items":{"type":"string","example":"joe@example.com","xml":{"name":"signers"},"title":"signers"}}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"folderId"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"string","example":"xjsba1GaxP"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"Example (from schema)"}
|
||||
value={"Example (from schema)"}
|
||||
>
|
||||
<ResponseSamples
|
||||
responseExample={"{\n \"Name\": \"sample template\",\n \"Note\": \"Please review and sign this document\",\n \"Description\": \"template description\",\n \"URL\": \"https://yourimage.com\",\n \"signers\": [\n \"joe@gmail.com\",\n \"john@gmail.com\"\n ],\n \"folderId\": \"xjsba1GaxP\"\n}"}
|
||||
language={"json"}
|
||||
>
|
||||
|
||||
</ResponseSamples>
|
||||
</TabItem>
|
||||
</SchemaTabs>
|
||||
</TabItem>
|
||||
</MimeTabs>
|
||||
</div>
|
||||
</TabItem><TabItem
|
||||
label={"400"}
|
||||
value={"400"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
Template not found!
|
||||
|
||||
|
||||
</div><div>
|
||||
|
||||
</div>
|
||||
</TabItem><TabItem
|
||||
label={"404"}
|
||||
value={"404"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
Invalid API Token!'
|
||||
|
||||
|
||||
</div><div>
|
||||
|
||||
</div>
|
||||
</TabItem>
|
||||
</ApiTabs>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -0,0 +1,26 @@
|
||||
# Overview
|
||||
|
||||
OpenSign™ API offers a robust suite of functionalities for digital document management and electronic signatures. Designed to cater to a wide array of business needs, the API facilitates the creation, signing, and management of digital documents. It ensures secure and efficient processes, complying with international legal standards for electronic signatures.
|
||||
|
||||
# Key Features
|
||||
|
||||
- **Document Creation**: Allows for the generation of digital documents directly through the API.
|
||||
- **Template Creation**: Supports the creation and management of document templates for consistent use across various applications.
|
||||
- **Electronic Signature Integration**: Provides capabilities for incorporating electronic signatures into documents.
|
||||
- **User Management**: Facilitates the management of user accounts, permissions, and roles within an application.
|
||||
- **Contacts Management**: Enables efficient handling of contact information and integration with document processes.
|
||||
- **Compliance and Security**: Ensures all operations adhere to global legal standards for electronic signatures and data security.
|
||||
- **Customization and Flexibility**: Offers highly customizable workflows, tailored to meet diverse organizational requirements.
|
||||
- **Cross-Platform Compatibility**: Assures seamless functionality across various platforms and devices.
|
||||
|
||||
# Target Audience
|
||||
|
||||
- **Developers and IT Professionals**: Implementing digital document management and electronic signature solutions.
|
||||
- **Businesses and Enterprises**: Seeking efficient and secure digital document workflows.
|
||||
- **Legal and Compliance Teams**: Requiring digital solutions compliant with legal standards for signatures and document management.
|
||||
|
||||
# Usage Scenarios
|
||||
|
||||
- Streamlining contract creation and signing processes in corporate environments.
|
||||
- Managing user permissions and contacts for large-scale document workflows.
|
||||
- Utilizing templates for standardized document processes in legal, financial, and governmental sectors.
|
||||
@@ -0,0 +1,111 @@
|
||||
---
|
||||
id: opensign-api-v-1
|
||||
title: "OpenSign API v1"
|
||||
description: "This is API documentation for OpenSign API v1 based on the OpenAPI 3.1 specification."
|
||||
sidebar_label: Introduction
|
||||
sidebar_position: 0
|
||||
hide_title: true
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import ApiLogo from "@theme/ApiLogo";
|
||||
import SchemaTabs from "@theme/SchemaTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Export from "@theme/ApiExplorer/Export";
|
||||
|
||||
<span
|
||||
className={"theme-doc-version-badge badge badge--secondary"}
|
||||
>
|
||||
Version: 1.0.0
|
||||
</span>
|
||||
|
||||
<h1
|
||||
className={"openapi__heading"}
|
||||
>
|
||||
OpenSign API v1
|
||||
</h1>
|
||||
|
||||
|
||||
|
||||
This is API documentation for OpenSign API v1 based on the OpenAPI 3.1 specification.
|
||||
|
||||
Some useful links:
|
||||
- [Official Website](https://www.opensignlabs.com)
|
||||
- [Github repo](https://github.com/opensignlabs/opensign)
|
||||
|
||||
<div
|
||||
style={{"marginBottom":"2rem"}}
|
||||
>
|
||||
<h2
|
||||
id={"authentication"}
|
||||
style={{"marginBottom":"1rem"}}
|
||||
>
|
||||
Authentication
|
||||
</h2><SchemaTabs
|
||||
className={"openapi-tabs__security-schemes"}
|
||||
>
|
||||
<TabItem
|
||||
label={"API Key: api_key"}
|
||||
value={"api_key"}
|
||||
>
|
||||
|
||||
|
||||
|
||||
|
||||
<div>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<th>
|
||||
Security Scheme Type:
|
||||
</th><td>
|
||||
apiKey
|
||||
</td>
|
||||
</tr><tr>
|
||||
<th>
|
||||
Header parameter name:
|
||||
</th><td>
|
||||
x-api-token
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</TabItem>
|
||||
</SchemaTabs>
|
||||
</div><div
|
||||
style={{"display":"flex","flexDirection":"column","marginBottom":"var(--ifm-paragraph-margin-bottom)"}}
|
||||
>
|
||||
<h3
|
||||
style={{"marginBottom":"0.25rem"}}
|
||||
>
|
||||
Contact
|
||||
</h3><span>
|
||||
[contact@opensignlabs.com](mailto:contact@opensignlabs.com)
|
||||
</span>
|
||||
</div><div
|
||||
style={{"marginBottom":"var(--ifm-paragraph-margin-bottom)"}}
|
||||
>
|
||||
<h3
|
||||
style={{"marginBottom":"0.25rem"}}
|
||||
>
|
||||
Terms of Service
|
||||
</h3><a
|
||||
href={"http://www.opensignlabs.com/terms/"}
|
||||
>
|
||||
http://www.opensignlabs.com/terms/
|
||||
</a>
|
||||
</div><div
|
||||
style={{"marginBottom":"var(--ifm-paragraph-margin-bottom)"}}
|
||||
>
|
||||
<h3
|
||||
style={{"marginBottom":"0.25rem"}}
|
||||
>
|
||||
License
|
||||
</h3><a
|
||||
href={"http://github.com/opensignlabs/opensign/LICENSE"}
|
||||
>
|
||||
AGPL 3.0
|
||||
</a>
|
||||
</div>
|
||||
|
||||
@@ -0,0 +1,118 @@
|
||||
import {SidebarConfig} from "@docusaurus/plugin-content-docs/src/sidebars/types";
|
||||
|
||||
const sidebar: SidebarConfig = [
|
||||
{
|
||||
"type": "doc",
|
||||
"id": "API-docs/opensign-api-v-1"
|
||||
},
|
||||
{
|
||||
"type": "category",
|
||||
"label": "templates",
|
||||
"items": [
|
||||
{
|
||||
"type": "doc",
|
||||
"id": "API-docs/createtemplate",
|
||||
"label": "Template Creation API",
|
||||
"className": "api-method post"
|
||||
},
|
||||
{
|
||||
"type": "doc",
|
||||
"id": "API-docs/get-template",
|
||||
"label": "Get template by ID",
|
||||
"className": "api-method get"
|
||||
},
|
||||
{
|
||||
"type": "doc",
|
||||
"id": "API-docs/update-template",
|
||||
"label": "update template by ID",
|
||||
"className": "api-method put"
|
||||
},
|
||||
{
|
||||
"type": "doc",
|
||||
"id": "API-docs/delete-template",
|
||||
"label": "Delete template by ID",
|
||||
"className": "api-method delete"
|
||||
},
|
||||
{
|
||||
"type": "doc",
|
||||
"id": "API-docs/template-list",
|
||||
"label": "Get template list",
|
||||
"className": "api-method post"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"type": "category",
|
||||
"label": "users",
|
||||
"items": [
|
||||
{
|
||||
"type": "doc",
|
||||
"id": "API-docs/update-pet",
|
||||
"label": "Update an existing pet",
|
||||
"className": "api-method put"
|
||||
},
|
||||
{
|
||||
"type": "doc",
|
||||
"id": "API-docs/add-pet",
|
||||
"label": "Add a new pet to the store",
|
||||
"className": "api-method post"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"type": "category",
|
||||
"label": "documents",
|
||||
"items": [
|
||||
{
|
||||
"type": "doc",
|
||||
"id": "API-docs/find-pets-by-status",
|
||||
"label": "Finds Pets by status",
|
||||
"className": "api-method get"
|
||||
},
|
||||
{
|
||||
"type": "doc",
|
||||
"id": "API-docs/find-pets-by-tags",
|
||||
"label": "Finds Pets by tags",
|
||||
"className": "api-method get"
|
||||
},
|
||||
{
|
||||
"type": "doc",
|
||||
"id": "API-docs/get-inventory",
|
||||
"label": "Returns pet inventories by status",
|
||||
"className": "api-method get"
|
||||
}
|
||||
]
|
||||
},
|
||||
{
|
||||
"type": "category",
|
||||
"label": "contacts",
|
||||
"items": [
|
||||
{
|
||||
"type": "doc",
|
||||
"id": "API-docs/get-pet-by-id",
|
||||
"label": "Find pet by ID",
|
||||
"className": "api-method get"
|
||||
},
|
||||
{
|
||||
"type": "doc",
|
||||
"id": "API-docs/update-pet-with-form",
|
||||
"label": "Updates a pet in the store with form data",
|
||||
"className": "api-method post"
|
||||
},
|
||||
{
|
||||
"type": "doc",
|
||||
"id": "API-docs/delete-pet",
|
||||
"label": "Deletes a pet",
|
||||
"className": "api-method delete"
|
||||
},
|
||||
{
|
||||
"type": "doc",
|
||||
"id": "API-docs/upload-file",
|
||||
"label": "uploads an image",
|
||||
"className": "api-method post"
|
||||
}
|
||||
]
|
||||
}
|
||||
];
|
||||
|
||||
export default sidebar;
|
||||
@@ -0,0 +1,297 @@
|
||||
---
|
||||
id: template-list
|
||||
title: "Get template list"
|
||||
description: "Get template list"
|
||||
sidebar_label: "Get template list"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJytVm1P2zAQ/iuWPw2p9GWb9qGfxhhjaGiglWkfSoWc5JIYHDuzHdqq6n/fnfPSUBgwaYBQcr7nXp87Z8O9yByfzrmHolTCg+OLATclWOGl0WcJn3ZH59J5PuAWflfg/CeTrPl0wxNwsZUlaaNuac29TIBFoMySlcKKAjxY5g3LwDNdFRG+mZTt/A14bLQH7cmaKEsl4+B7dOvI5Ia7OIdC0JNfl4BOTHQLMYWC3jBSL9EKnipZSN9Tk2g1A4t6qbGF8LXo3VsUwEqge1SajLcD7u5k+Y+48RZxq0IRTGOOqKOwPBEVBU+89OqhbEsAC6402tXhJpCKSvnHNXRVHINzaaVY14j/VyWZ9HSct1Jn/Uw7SZcqX02+Rrpwby8zSu3nj/OnDOzUc+9LNx2N2g5XDuwwNgWBv4dSPYd24aGjRwAZ/wKo1Wba1JDP/YK+DkmRIfKLUQn2/llQGnQ6yExmGqzrYYS1Yo0Qiebdyy2pxWfJixz88P51Rbw1GFiPhm2WN22odHhsAUWf1q8sUEzqps36Efv7Ddt3G9iP8oc0P8V90FlX9W7BZZEb2jmlCe+l8Dm+dVxq1JBR96Hi8w2vrOqRDidjiKXVDhNVInJEPBTK0f2EbxeEjCsr/XpG01JXH09v7qBfBpR8A+pfk9vqECWH3twBzaGk4HMQRBPKigbwx24nnrSl6xbSZNyuGFo2Uqcm+GqKdIHRUlvY0eUZwyj3y3SVS8fwj44TE1cF7oAw+QyZwfbQLBIOEoaHPodwSPJ3wwlzJcQybZbGkF3raz0zBTCcTlo0Suo7N73Wh2x+kaKaFIr9gsghgxdv2uIul8tHxT0ImFPp8ypiFkqzU8+CMHSgj+peDjBXvBsKd5HOsKEybrfHX1yNgvKoWYUiDqsQd54kAjSij/sg4iPuShRCj61Hp5fnWJYx2trx5xUhj87Pjk++z07IKjGwbtFkOEZTKCLWFkL3HD1F8uTJ5eRh5Ueoh/TaNlFtGv7vbudgAWmc03igfLOhhv+0arslMZLQIpHn+HgvrBQRMWy+QHsNX2lgAtf5cX2bHF6Rd1JXVU39vZtlO2gRR3grlf5Z3UVvgi8vZleoHDWfCYVJCGPFkj4h8P+UX+Mvp48NshBGMchxboTOKpGFTRbs0s8fliv8NQ==
|
||||
sidebar_class_name: "post api-method"
|
||||
info_path: docs/API-docs/opensign-api-v-1
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import ApiTabs from "@theme/ApiTabs";
|
||||
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
|
||||
import MimeTabs from "@theme/MimeTabs";
|
||||
import ParamsItem from "@theme/ParamsItem";
|
||||
import ResponseSamples from "@theme/ResponseSamples";
|
||||
import SchemaItem from "@theme/SchemaItem";
|
||||
import SchemaTabs from "@theme/SchemaTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
|
||||
<h1
|
||||
className={"openapi__heading"}
|
||||
>
|
||||
Get template list
|
||||
</h1>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"post"}
|
||||
path={"/templatelist"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Get template list
|
||||
|
||||
## Request
|
||||
|
||||
<MimeTabs
|
||||
className={"openapi-tabs__mime"}
|
||||
>
|
||||
<TabItem
|
||||
label={"application/json"}
|
||||
value={"application/json-schema"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details mime"}
|
||||
data-collapsed={false}
|
||||
open={true}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
className={"openapi-markdown__details-summary-mime"}
|
||||
>
|
||||
<h3
|
||||
className={"openapi-markdown__details-summary-header-body"}
|
||||
>
|
||||
Body
|
||||
</h3>
|
||||
</summary><div
|
||||
style={{"textAlign":"left","marginLeft":"1rem"}}
|
||||
>
|
||||
<div
|
||||
style={{"marginTop":"1rem","marginBottom":"1rem"}}
|
||||
>
|
||||
|
||||
|
||||
provide below parameter to get number of templates
|
||||
|
||||
|
||||
</div>
|
||||
</div><ul
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<SchemaItem
|
||||
collapsible={false}
|
||||
name={"limit"}
|
||||
required={false}
|
||||
schemaName={"int32"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int32","example":10}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"skip"}
|
||||
required={false}
|
||||
schemaName={"int32"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int32","example":0}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem>
|
||||
</MimeTabs><div>
|
||||
<div>
|
||||
<ApiTabs>
|
||||
<TabItem
|
||||
label={"default"}
|
||||
value={"default"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
successful operation
|
||||
|
||||
|
||||
</div><div>
|
||||
<MimeTabs
|
||||
className={"openapi-tabs__mime"}
|
||||
schemaType={"response"}
|
||||
>
|
||||
<TabItem
|
||||
label={"application/json"}
|
||||
value={"application/json"}
|
||||
>
|
||||
<SchemaTabs
|
||||
className={"openapi-tabs__schema"}
|
||||
>
|
||||
<TabItem
|
||||
label={"Schema"}
|
||||
value={"Schema"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details response"}
|
||||
data-collapsed={false}
|
||||
open={true}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
className={"openapi-markdown__details-summary-response"}
|
||||
>
|
||||
<strong>
|
||||
Schema
|
||||
</strong>
|
||||
</summary><div
|
||||
style={{"textAlign":"left","marginLeft":"1rem"}}
|
||||
>
|
||||
|
||||
</div><ul
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<SchemaItem
|
||||
collapsible={false}
|
||||
name={"id"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"string","example":"x1Hbnms2Pg"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"URL"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"https://templateuser.com"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"Name"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"sample template"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"Note"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"template note"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"Description"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"template name"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"Folder"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"folder name"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={true}
|
||||
className={"schemaItem"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details"}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
>
|
||||
<span
|
||||
className={"openapi-schema__container"}
|
||||
>
|
||||
<strong
|
||||
className={"openapi-schema__property"}
|
||||
>
|
||||
Signers
|
||||
</strong><span
|
||||
className={"openapi-schema__name"}
|
||||
>
|
||||
object[]
|
||||
</span>
|
||||
</span>
|
||||
</summary><div
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<li>
|
||||
<div
|
||||
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}
|
||||
>
|
||||
Array [
|
||||
</div>
|
||||
</li><SchemaItem
|
||||
collapsible={false}
|
||||
name={"objectId"}
|
||||
required={false}
|
||||
schemaName={"int64"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int64"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"Name"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"joe"}}
|
||||
>
|
||||
|
||||
</SchemaItem><li>
|
||||
<div
|
||||
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}
|
||||
>
|
||||
]
|
||||
</div>
|
||||
</li>
|
||||
</div>
|
||||
</details>
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"CreateBy"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"template creator name"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"Example (from schema)"}
|
||||
value={"Example (from schema)"}
|
||||
>
|
||||
<ResponseSamples
|
||||
responseExample={"{\n \"id\": \"x1Hbnms2Pg\",\n \"URL\": \"https://templateuser.com\",\n \"Name\": \"sample template\",\n \"Note\": \"template note\",\n \"Description\": \"template name\",\n \"Folder\": \"folder name\",\n \"Signers\": [\n {\n \"objectId\": 0,\n \"Name\": \"joe\"\n }\n ],\n \"CreateBy\": \"template creator name\"\n}"}
|
||||
language={"json"}
|
||||
>
|
||||
|
||||
</ResponseSamples>
|
||||
</TabItem>
|
||||
</SchemaTabs>
|
||||
</TabItem>
|
||||
</MimeTabs>
|
||||
</div>
|
||||
</TabItem>
|
||||
</ApiTabs>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -0,0 +1,117 @@
|
||||
---
|
||||
id: update-pet-with-form
|
||||
title: "Updates a pet in the store with form data"
|
||||
description: ""
|
||||
sidebar_label: "Updates a pet in the store with form data"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJy9VU1v2zAM/SuCTiuQxi32cQiGYcXWFcWGNVha7LAGhWLTsRBb0iS6aRD4v4+U7SRN2yG7DAgSm3okH8knZi1RzYMc/ZKpNahSDHI6kBmE1GuH2ho5knIgrQOv+PUyI0PtMoUwBvypsfhifUUIp7yqAMFzsLU09ELILuidzgiiOZhTWMj9DJefhc2FAxRYKBQGIAsCrZiBaHOxu4fftfb0OEJfw0AGXJWcI+jK0cNAwoMrbUamXJWBAWkBlZKjtcSVY6Q2CHPwBM2JtMLW9O6NbJrBhnL86cj+rsGvnrD9Toh/4tvz6Qjnbcc2dLty9tkG9NrMH3ELqLAOf2c3iZj/yW/KsYKzJkDg8zcnb/lnb8TmXpU6E9q4GrkoGSCtvcZV1Ity+m4B/DzleKSkwrLUnA0Y1UWqGcmk01Oy3gqrkRzK3/fKq31JyALRhVGSKOeGJF4T9NyUahaGqa3IqJP7U8mJehITrq6lv6GyqZQsX4E73Y3h4Zgsx2gXYPpZFKAyUhbXpU1uo7PG2M4rSj+h9OJsfCko7f7ArgsdBH34OLNpXQGVxmeCBiH2vMVMBcgEHWIB8ZDtr4enIjhIda7T6DoUt+bWTCwJtQ6Q16UotVmE0a05Fr+ucoJpVYqfMAsaYfqq79ZyuXzSraPoc0E3vZ4JD85u4fNojC3d9dq8HFGttBGqcJVPaEI6hW4yL6RKIjghr2683EYSnS63q+TjvpOklpcUmtTH8G5EZxfjb9SWE4q1FcQBlJNvl5/Ov0/OOSpLqh3R6fCEQpGJ5Vgps5PoJt6nIFS8brqdS0DrQSwpF8+wEgRR+3Nfx4po1u2G7aSG8ICJKxWJqumorzv1b1Y0oUc7i5VUXPAtIcB6zfK48WXTsLldEHwpMh3UrNy56y9SOXC5PUs33pp+gdJ1rxkieX8dnv/g9fUXBps1ueUw5RevmcQ/NuTVj25PHomD/qae5dUvErPaZdXz3RlmM212tt/4anJNKFXz/HfX0SKuo+6B63k2weM91ebib57Isw7veZnQqvuwgbcnLzp0a69Hc7HTpmn+AJTE1qQ=
|
||||
sidebar_class_name: "post api-method"
|
||||
info_path: docs/API-docs/opensign-api-v-1
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import ApiTabs from "@theme/ApiTabs";
|
||||
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
|
||||
import MimeTabs from "@theme/MimeTabs";
|
||||
import ParamsItem from "@theme/ParamsItem";
|
||||
import ResponseSamples from "@theme/ResponseSamples";
|
||||
import SchemaItem from "@theme/SchemaItem";
|
||||
import SchemaTabs from "@theme/SchemaTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
|
||||
<h1
|
||||
className={"openapi__heading"}
|
||||
>
|
||||
Updates a pet in the store with form data
|
||||
</h1>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"post"}
|
||||
path={"/contact/{contact_id}"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Request
|
||||
|
||||
<details
|
||||
style={{"marginBottom":"1rem"}}
|
||||
className={"openapi-markdown__details"}
|
||||
data-collapsed={false}
|
||||
open={true}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
>
|
||||
<h3
|
||||
className={"openapi-markdown__details-summary-header-params"}
|
||||
>
|
||||
Path Parameters
|
||||
</h3>
|
||||
</summary><div>
|
||||
<ul>
|
||||
<ParamsItem
|
||||
className={"paramsItem"}
|
||||
param={{"name":"contact_id","in":"path","description":"ID of pet that needs to be updated","required":true,"style":"simple","explode":false,"schema":{"type":"integer","format":"int64"}}}
|
||||
>
|
||||
|
||||
</ParamsItem>
|
||||
</ul>
|
||||
</div>
|
||||
</details><details
|
||||
style={{"marginBottom":"1rem"}}
|
||||
className={"openapi-markdown__details"}
|
||||
data-collapsed={false}
|
||||
open={true}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
>
|
||||
<h3
|
||||
className={"openapi-markdown__details-summary-header-params"}
|
||||
>
|
||||
Query Parameters
|
||||
</h3>
|
||||
</summary><div>
|
||||
<ul>
|
||||
<ParamsItem
|
||||
className={"paramsItem"}
|
||||
param={{"name":"name","in":"query","description":"Name of pet that needs to be updated","required":false,"style":"form","explode":true,"schema":{"type":"string"}}}
|
||||
>
|
||||
|
||||
</ParamsItem><ParamsItem
|
||||
className={"paramsItem"}
|
||||
param={{"name":"status","in":"query","description":"Status of pet that needs to be updated","required":false,"style":"form","explode":true,"schema":{"type":"string"}}}
|
||||
>
|
||||
|
||||
</ParamsItem>
|
||||
</ul>
|
||||
</div>
|
||||
</details><div>
|
||||
<div>
|
||||
<ApiTabs>
|
||||
<TabItem
|
||||
label={"405"}
|
||||
value={"405"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
Invalid input
|
||||
|
||||
|
||||
</div><div>
|
||||
|
||||
</div>
|
||||
</TabItem>
|
||||
</ApiTabs>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -0,0 +1,178 @@
|
||||
---
|
||||
id: update-template
|
||||
title: "update template by ID"
|
||||
description: "update template by ID"
|
||||
sidebar_label: "update template by ID"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJyVVttu2zgQ/RWCTyngWA422Ac9bbfNBsYWiVGn2IckCCiJsplIpJakfIHgf+8ZSrJlOwUaxzCo0eFcz8yk4V4sHI8fuZdlVQgvHX8ecVNJK7wyeprxmNdVhhcPHYCPeCWsKKWXlm42XOMBsF7Di8qAURqiSvglzpl0qVUVKYRw+pWZnPmlZMZm0uIkPNNSZo55wxLJWnukxMr/a2VxjL2t5Yg7vy3IlFMwRZ7ITVWYDKJcFI4A6VKWgscN99uKkEp7uZAW0NzYUvhW9Oc13+2eW/3S+b9NtqU7x35W1qxUJuFRYdZsHzM52XrI9jljFwihkMJ5ZrQcYPsAPsGB1MAX7cmQqKpCpSHD0asja8256yZ5lamndFuqh1eoDd7ehWzvUc5bpRfD+PYSuREhTRCFw95fvhvxO+M/rGZGIUoEtVJyzYTOmFMLjQIqxzKT1iWFB91fh3n8mIneRTasBVT+Ywpwhej4MX2bV5eIq1uxmaHiI+6VPzLzMiDtS0I02O0IZ6WrjHZtxq8nk3N2TPVKFCpjYLOrqZxgKS5eT67PsfeB59p4lptaZ8GTY8QJoViyhWIEAhYtDfVgVQcmUD/FPOpxUTPwfweAk3bVt2VtC2CX3lcujiJQbgwaaapYIRI3Tk0JoYpWV5xawcm0tspv50TDNm68fXmT20HKIfkXglHf8ptLSC69eZO6b/mlFAg2hEjM/n7osJu+KD2Hz2jZs/L3iHbCs/epM2TOERnI3dyE2DpO3CM7czLzeTZlyMppjR7IOr70uncitDCqatnJbZYggAzTIAw6eknyP8ZXzFUyVXnX/WP2pJ/03JSYek7mdcEKpd9c/KQv2eN9DpgSBftPJk55+XzRF3O9Xp8V81O4c6v8sk6Qucoc4IsgDBUf3to/0HTCtCrdfT4HgVQqO+L8wlQUwFE300QaZhqGlyLCdaK/Ti9RyjH0IAwU6Bj0+Xb2DWmZQNeBr7/hcvRt+uXmbn5DWonxbYmuxhOogqgyzpdCDwz9qsOyd2eVlxsfAajC8AmeNV33HVYlbsfDpYcuWsIuQZqG6v/DFrsdidEDFn30iONKWCUSIhxaNFOOztl+f514s18Z/OJ7v0nYB/bnu9H0vaypkTHEanrCMbT60RbfPQPeNTS52yK+tE5dPpCeg4aznUZTZT+/Zj8egE26RVuGnc2tWNOSx2/Mn/DH6T8PUhDGT5A3vBB6UYsF4Vu19PkJodUD3g==
|
||||
sidebar_class_name: "put api-method"
|
||||
info_path: docs/API-docs/opensign-api-v-1
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import ApiTabs from "@theme/ApiTabs";
|
||||
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
|
||||
import MimeTabs from "@theme/MimeTabs";
|
||||
import ParamsItem from "@theme/ParamsItem";
|
||||
import ResponseSamples from "@theme/ResponseSamples";
|
||||
import SchemaItem from "@theme/SchemaItem";
|
||||
import SchemaTabs from "@theme/SchemaTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
|
||||
<h1
|
||||
className={"openapi__heading"}
|
||||
>
|
||||
update template by ID
|
||||
</h1>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"put"}
|
||||
path={"/template/{template_id}"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
update template by ID
|
||||
|
||||
## Request
|
||||
|
||||
<details
|
||||
style={{"marginBottom":"1rem"}}
|
||||
className={"openapi-markdown__details"}
|
||||
data-collapsed={false}
|
||||
open={true}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
>
|
||||
<h3
|
||||
className={"openapi-markdown__details-summary-header-params"}
|
||||
>
|
||||
Path Parameters
|
||||
</h3>
|
||||
</summary><div>
|
||||
<ul>
|
||||
<ParamsItem
|
||||
className={"paramsItem"}
|
||||
param={{"name":"template_id","in":"path","description":"ID of the order that needs to be updated","required":true,"style":"simple","explode":false,"schema":{"type":"integer","format":"int64"}}}
|
||||
>
|
||||
|
||||
</ParamsItem>
|
||||
</ul>
|
||||
</div>
|
||||
</details><MimeTabs
|
||||
className={"openapi-tabs__mime"}
|
||||
>
|
||||
<TabItem
|
||||
label={"application/json"}
|
||||
value={"application/json-schema"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details mime"}
|
||||
data-collapsed={false}
|
||||
open={true}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
className={"openapi-markdown__details-summary-mime"}
|
||||
>
|
||||
<h3
|
||||
className={"openapi-markdown__details-summary-header-body"}
|
||||
>
|
||||
Body
|
||||
</h3>
|
||||
</summary><div
|
||||
style={{"textAlign":"left","marginLeft":"1rem"}}
|
||||
>
|
||||
<div
|
||||
style={{"marginTop":"1rem","marginBottom":"1rem"}}
|
||||
>
|
||||
|
||||
|
||||
provide below parameter to update templates (at least one parameter required)
|
||||
|
||||
|
||||
</div>
|
||||
</div><ul
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<SchemaItem
|
||||
collapsible={false}
|
||||
name={"Name"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"string","example":"sample template"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"Note"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"string","example":"Please review and sign this document"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"Description"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"string","example":"template description"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"FolderId"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"string","example":"xjsba1GaxP"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem>
|
||||
</MimeTabs><div>
|
||||
<div>
|
||||
<ApiTabs>
|
||||
<TabItem
|
||||
label={"400"}
|
||||
value={"400"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
Invalid ID supplied
|
||||
|
||||
|
||||
</div><div>
|
||||
|
||||
</div>
|
||||
</TabItem><TabItem
|
||||
label={"404"}
|
||||
value={"404"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
Order not found
|
||||
|
||||
|
||||
</div><div>
|
||||
|
||||
</div>
|
||||
</TabItem>
|
||||
</ApiTabs>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -0,0 +1,183 @@
|
||||
---
|
||||
id: upload-file
|
||||
title: "uploads an image"
|
||||
description: ""
|
||||
sidebar_label: "uploads an image"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJyNVG1v2jAQ/iuW+2WVgND2G5qmsaqrqlWjGkz70KLJcS7EJbE922mLEP99d05CU1akIQTJvT5399xteRArzyf3XBodhAyeLwc8Ay+dskEZzSecD7ix4AS93mQoqG1pRPZVlYAqB39q8OGLyTZ8so1hQAd6FNaWSka3xMgAYeiDA1GRzssCKkFPYWMBY6JK6RXGy42rBPrzVGnhNnyHH8rirdEePLmcj8f09xalr6UE7/O6ZHu0GO4InkdPTu/gMOkjyICO1lGYoJqU0mTQs1IYdAWuDxdFF+ccoTYmh4WhokJ4YvWeDpUvVUkKLSpSnJxkkIu6DDGgCiUJp1b9aNsQu4IqD7J2KmDn76k+9XsN9LzcLSldKAyNyxofCxKhwLekHXSpotSDewLnY4DaIQZehGD9JEmwXSNsgfZqpUuR+pE0FQpV8nTGKX6Xe04tbLq0R7CvECXfUDDoCnsZomQYzBpoOIoGV4DIsJVUjtK5ic5txTNMP8f0bHp3wzDtITMXhfIMv6TOjKwrnHScL8OxsANvlgoPGUNlKCAqSX4xOmPeglR5S40Re9APem4qYLUHolOp9NpPHvSQ3c9yNFOiZL8g9SrA8kPXrefn53+6dRp9rlUo6pQ5sObVfBWFsaV9r/3LKdYawFV+ls9xQkpCO5kjqZJonLSEx/FSG5HZiibaij4fOhG5cCOACPXKven13S22ZYyxXgnxH5CT25vLq+/zK4pKlGpGdDYaYygUEQsroXuJmjPimdBMVbQYB+PtHRO6QS2jAryExJYCubNrEW5bbu+PWOQ2UrQg5qN4u6XZ/3TlbkdiPFgurgkCFU6JlMiGSzPouEjLEHnMLxsEwwUlJ/Oybmh95LTtBp3nFM+RDUd84vl5s6R3s/kCjdP2jFbx3vCcbiziEjXV19+qddyq9oHwdiq96eV8u24NMPolmO86fKSdwI39tDdvNEcd2o511jSVJZ6mv+5WK3E=
|
||||
sidebar_class_name: "post api-method"
|
||||
info_path: docs/API-docs/opensign-api-v-1
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import ApiTabs from "@theme/ApiTabs";
|
||||
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
|
||||
import MimeTabs from "@theme/MimeTabs";
|
||||
import ParamsItem from "@theme/ParamsItem";
|
||||
import ResponseSamples from "@theme/ResponseSamples";
|
||||
import SchemaItem from "@theme/SchemaItem";
|
||||
import SchemaTabs from "@theme/SchemaTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
|
||||
<h1
|
||||
className={"openapi__heading"}
|
||||
>
|
||||
uploads an image
|
||||
</h1>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"post"}
|
||||
path={"/contactlist"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
## Request
|
||||
|
||||
<MimeTabs
|
||||
className={"openapi-tabs__mime"}
|
||||
>
|
||||
<TabItem
|
||||
label={"application/octet-stream"}
|
||||
value={"application/octet-stream-schema"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details mime"}
|
||||
data-collapsed={false}
|
||||
open={true}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
className={"openapi-markdown__details-summary-mime"}
|
||||
>
|
||||
<h3
|
||||
className={"openapi-markdown__details-summary-header-body"}
|
||||
>
|
||||
Body
|
||||
</h3>
|
||||
</summary><div
|
||||
style={{"textAlign":"left","marginLeft":"1rem"}}
|
||||
>
|
||||
|
||||
</div><ul
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<div
|
||||
style={{"marginTop":".5rem","marginBottom":".5rem","marginLeft":"1rem"}}
|
||||
>
|
||||
|
||||
|
||||
string
|
||||
|
||||
|
||||
</div>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem>
|
||||
</MimeTabs><div>
|
||||
<div>
|
||||
<ApiTabs>
|
||||
<TabItem
|
||||
label={"200"}
|
||||
value={"200"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
successful operation
|
||||
|
||||
|
||||
</div><div>
|
||||
<MimeTabs
|
||||
className={"openapi-tabs__mime"}
|
||||
schemaType={"response"}
|
||||
>
|
||||
<TabItem
|
||||
label={"application/json"}
|
||||
value={"application/json"}
|
||||
>
|
||||
<SchemaTabs
|
||||
className={"openapi-tabs__schema"}
|
||||
>
|
||||
<TabItem
|
||||
label={"Schema"}
|
||||
value={"Schema"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details response"}
|
||||
data-collapsed={false}
|
||||
open={true}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
className={"openapi-markdown__details-summary-response"}
|
||||
>
|
||||
<strong>
|
||||
Schema
|
||||
</strong>
|
||||
</summary><div
|
||||
style={{"textAlign":"left","marginLeft":"1rem"}}
|
||||
>
|
||||
|
||||
</div><ul
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<SchemaItem
|
||||
collapsible={false}
|
||||
name={"code"}
|
||||
required={false}
|
||||
schemaName={"int32"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int32"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"type"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"message"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"Example (from schema)"}
|
||||
value={"Example (from schema)"}
|
||||
>
|
||||
<ResponseSamples
|
||||
responseExample={"{\n \"code\": 0,\n \"type\": \"string\",\n \"message\": \"string\"\n}"}
|
||||
language={"json"}
|
||||
>
|
||||
|
||||
</ResponseSamples>
|
||||
</TabItem>
|
||||
</SchemaTabs>
|
||||
</TabItem>
|
||||
</MimeTabs>
|
||||
</div>
|
||||
</TabItem>
|
||||
</ApiTabs>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -0,0 +1,71 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
title: Code of conduct
|
||||
---
|
||||
|
||||
# Code of Conduct for OpenSign
|
||||
|
||||
## 1. Introduction
|
||||
|
||||
A primary goal of OpenSign is to be inclusive to the largest number of contributors, with the most varied and diverse backgrounds possible. As such, we are committed to providing a friendly, safe, and welcoming environment for all, regardless of gender, sexual orientation, ability, ethnicity, socioeconomic status, and religion (or lack thereof).
|
||||
|
||||
This code of conduct outlines our expectations for all those who participate in our community, as well as the consequences for unacceptable behavior.
|
||||
|
||||
We invite all those who participate in OpenSign to help us create safe and positive experiences for everyone.
|
||||
|
||||
## 2. Open Source Citizenship
|
||||
|
||||
A supplemental goal of this Code of Conduct is to increase open source citizenship by encouraging participants to recognize and strengthen the relationships between our actions and their effects on our community.
|
||||
|
||||
Communities mirror the societies in which they exist and positive action is essential to counteract the many forms of inequality and abuses of power that exist in society.
|
||||
|
||||
## 3. Expected Behavior
|
||||
|
||||
The following behaviors are expected and requested of all community members:
|
||||
|
||||
- Participate in an authentic and active way. In doing so, you contribute to the health and longevity of this community.
|
||||
- Exercise consideration and respect in your speech and actions.
|
||||
- Attempt collaboration before conflict.
|
||||
- Refrain from demeaning, discriminatory, or harassing behavior and speech.
|
||||
- Be mindful of your surroundings and of your fellow participants. Alert community leaders if you notice a dangerous situation, someone in distress, or violations of this Code of Conduct, even if they seem inconsequential.
|
||||
|
||||
## 4. Unacceptable Behavior
|
||||
|
||||
The following behaviors are considered harassment and are unacceptable within our community:
|
||||
|
||||
- Violence, threats of violence, or violent language directed against another person.
|
||||
- Sexist, racist, homophobic, transphobic, ableist or otherwise discriminatory jokes and language.
|
||||
- Posting or displaying sexually explicit or violent material.
|
||||
- Posting or threatening to post other people’s personally identifying information ("doxing").
|
||||
- Personal insults, particularly those related to gender, sexual orientation, race, religion, or disability.
|
||||
- Inappropriate photography or recording.
|
||||
- Inappropriate physical contact. You should have someone’s consent before touching them.
|
||||
- Unwelcome sexual attention. This includes sexualized comments or jokes; inappropriate touching, groping, and unwelcomed sexual advances.
|
||||
- Deliberate intimidation, stalking or following (online or in person).
|
||||
- Advocating for, or encouraging, any of the above behavior.
|
||||
|
||||
## 5. Consequences of Unacceptable Behavior
|
||||
|
||||
Unacceptable behavior from any community member, including sponsors and those with decision-making authority, will not be tolerated.
|
||||
|
||||
Anyone asked to stop unacceptable behavior is expected to comply immediately.
|
||||
|
||||
If a community member engages in unacceptable behavior, the community organizers may take any action they deem appropriate, up to and including a temporary ban or permanent expulsion from the community without warning (and without refund in the case of a paid event).
|
||||
|
||||
## 6. Reporting Guidelines
|
||||
|
||||
If you are subject to or witness unacceptable behavior, or have any other concerns, please notify a community organizer as soon as possible by emailing [contact@opensignlabs.com](mailto:contact@opensignlabs.com).
|
||||
|
||||
[Reporting guidelines](REPORTING_GUIDELINES.md)
|
||||
|
||||
## 7. Addressing Grievances
|
||||
|
||||
If you feel you have been falsely or unfairly accused of violating this Code of Conduct, you should notify the OpenSign administration with a concise description of your grievance. Your grievance will be handled in accordance with our existing governing policies.
|
||||
|
||||
## 8. Scope
|
||||
|
||||
We expect all community participants (contributors, paid or otherwise; sponsors; and other guests) to abide by this Code of Conduct in all community venues—online and in-person—as well as in all one-on-one communications pertaining to community business.
|
||||
|
||||
## 9. Contact info
|
||||
|
||||
[contact@opensignlabs.com](mailto:contact@opensignlabs.com)
|
||||
@@ -0,0 +1,8 @@
|
||||
# Community at OpenSign™
|
||||
|
||||
Welcome to the OpenSign™ Community page! OpenSign™ is dedicated to fostering a vibrant and engaging community where members can connect, share ideas and collaborate on the OpenSign™ project. This page provides links to our active social media platforms and community channels, offering various ways for you to join and participate in the OpenSign™ community. Whether you're looking for support, eager to contribute or just want to stay updated, you'll find a platform that suits your preference. Connect with us on Discord for real-time discussions, follow us on Twitter for the latest updates, engage with our professional network on LinkedIn or join our Facebook group for a broader community experience. Join us in our mission to develop OpenSign™ as the premier open-source [alternative to DocuSign](https://www.opensignlabs.com).
|
||||
|
||||
- [Discord](https://discord.com/invite/xe9TDuyAyj)
|
||||
- [Twitter](https://www.twitter.com/opensignhq)
|
||||
- [LinkedIn](https://www.linkedin.com/company/opensign™/)
|
||||
- [Facebook](https://www.facebook.com/profile.php?id=61551030403669)
|
||||
@@ -0,0 +1,50 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
title: Installation instructions
|
||||
---
|
||||
|
||||
# INSTALLATION INSTRUCTIONS
|
||||
|
||||
You can use our app as a cloud version from [OpenSignLabs](https://www.opensignlabs.com)
|
||||
|
||||
or follow below instructions to install it on your own infrastructure.
|
||||
|
||||
- Localhost(Frontend only)
|
||||
- Localhost(Docker)
|
||||
|
||||
## Localhost(Frontend only)
|
||||
|
||||
This is the easiest way to run the frontend application for development or testing purpose without the hassle of installing backend & DB. All the features including document upload, signing, email notifications will work seamlessly from staging backend.
|
||||
|
||||
**Warning:** All data, including user accounts and documents, is stored in the staging backend. This data will be erased every time there is a merge to the main branch. As a result, you may need to recreate user accounts repeatedly. If you find that login attempts are failing, it is likely because the data has been cleared due to a recent merge.
|
||||
|
||||
Below are the steps to follow -
|
||||
- [Clone the repository](https://help.github.com/articles/cloning-a-repository/) to your local machine using below command -
|
||||
```
|
||||
git clone https://github.com/OpenSignLabs/OpenSign.git
|
||||
```
|
||||
- Switch to the newly created OpenSign directory.
|
||||
```
|
||||
cd OpenSign
|
||||
```
|
||||
- Copy the .env.frontend_dev file to apps/OpenSign/.env using below command(on mac & linux). For windows use COPY command instead.
|
||||
```
|
||||
cp .env.frontend_dev apps/OpenSign/.env
|
||||
```
|
||||
- Switch to apps/OpenSign directory.
|
||||
```
|
||||
cd apps/OpenSign
|
||||
```
|
||||
- Install NPM packages using
|
||||
```
|
||||
npm install
|
||||
```
|
||||
- Run the project locally using
|
||||
```
|
||||
npm run start-dev
|
||||
```
|
||||
You should be able to access the application from http://localhost:3000 after this.
|
||||
Create an account by signing-up and start contributing.
|
||||
|
||||
## Localhost(Docker)
|
||||
- Please refer this documentation => [click here](https://docs.opensignlabs.com/docs/self-host/docker/run-locally)
|
||||
@@ -0,0 +1,59 @@
|
||||
|
||||
# OpenSign™ Reporting Guidelines
|
||||
|
||||
This document provides guidelines for reporting issues, suggesting enhancements, and submitting pull requests to the [OpenSign™ GitHub repository](https://github.com/OpenSignLabs/OpenSign). Adhering to these guidelines helps maintain the project's quality and efficiency.
|
||||
|
||||
## Issues
|
||||
|
||||
When creating an issue, include the following:
|
||||
|
||||
### Bug Reports
|
||||
|
||||
- **Title**: Concise and informative.
|
||||
- **Description**: Detailed description of the issue.
|
||||
- **Steps to Reproduce**: Clear steps to reproduce the bug.
|
||||
- **Expected Behavior**: Describe what you expected to happen.
|
||||
- **Actual Behavior**: Describe what actually happened.
|
||||
- **Screenshots**: If applicable, add screenshots to help explain your issue.
|
||||
- **Environment**: Include details like OS, browser version, and OpenSign™ version.
|
||||
- **Logs**: Attach relevant logs or error messages.
|
||||
|
||||
### Feature Requests
|
||||
|
||||
- **Title**: Short and descriptive.
|
||||
- **Description**: Detailed explanation of the feature and its benefits.
|
||||
- **Use Case**: Describe a specific use case or problem this feature addresses.
|
||||
- **Proposed Solution**: If possible, suggest an implementation idea.
|
||||
- **Additional Context**: Any other information or screenshots.
|
||||
|
||||
## Pull Requests
|
||||
|
||||
For submitting pull requests, follow these steps:
|
||||
|
||||
- **Branch Naming**: Use a short, descriptive name for your branch.
|
||||
- **Commit Messages**: Write clear, concise commit messages.
|
||||
- **Description**: Provide a detailed description of changes.
|
||||
- **Testing**: Describe testing done to validate the changes.
|
||||
- **Documentation**: Update relevant documentation.
|
||||
- **Screenshots**: Include before and after screenshots for UI changes.
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
All contributors are expected to follow the project's [Code of Conduct](https://docs.opensignlabs.com/docs/contribute/CODE_OF_CONDUCT).
|
||||
|
||||
## Getting Help
|
||||
|
||||
If you need help or have questions:
|
||||
|
||||
- Visit our [GitHub Discussions](https://github.com/OpenSignLabs/OpenSign/discussions) page.
|
||||
- Contact us through our [Discord community](https://discord.com/invite/xe9TDuyAyj).
|
||||
|
||||
## Stay Connected
|
||||
|
||||
- [Twitter](https://twitter.com/OpenSignHQ)
|
||||
- [Facebook](https://www.facebook.com/profile.php?id=61551030403669)
|
||||
- [LinkedIn](https://www.linkedin.com/company/opensign%E2%84%A2/)
|
||||
- [YouTube](https://www.youtube.com/@opensignhq)
|
||||
- [Website](http://www.opensignlabs.com)
|
||||
|
||||
Thank you for contributing to OpenSign™!
|
||||
@@ -0,0 +1,74 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Contributing to OpenSign
|
||||
|
||||
Hello there! Thank you for considering contributing to OpenSign, the open-source alternative to DocuSign. OpenSign is not just a project, but a community endeavor that aims to create a robust, user-friendly, and secure electronic signature solution. Your contributions, irrespective of their size, are valuable in making this vision a reality.
|
||||
|
||||
## Table of Contents
|
||||
|
||||
1. [Getting Started](#getting-started)
|
||||
2. [Code of Conduct](#code-of-conduct)
|
||||
3. [How Can I Contribute?](#how-can-i-contribute)
|
||||
- [Reporting Bugs](#reporting-bugs)
|
||||
- [Suggesting Enhancements](#suggesting-enhancements)
|
||||
- [Pull Requests](#pull-requests)
|
||||
4. [Style Guidelines](#style-guidelines)
|
||||
- [Git Commit Messages](#git-commit-messages)
|
||||
- [JavaScript Style Guide](#javascript-style-guide)
|
||||
5. [Community](#community)
|
||||
6. [License](#license)
|
||||
|
||||
## Getting Started
|
||||
|
||||
- Fork the [OpenSign repository](https://github.com/OpenSignLabs/OpenSign) to your GitHub account.
|
||||
- Clone your fork locally: `git clone https://github.com/your-username/OpenSign.git`
|
||||
- Create a new branch for your contribution: `git checkout -b feature/your-feature-name`
|
||||
- Make your contributions.
|
||||
- Push your branch to your fork: `git push origin feature/your-feature-name`
|
||||
- Create a Pull Request from your fork to the OpenSign repository.
|
||||
|
||||
## Code of Conduct
|
||||
|
||||
We expect all our contributors to adhere to the [Code of Conduct](CODE_OF_CONDUCT.md). Please read it thoroughly before contributing.
|
||||
|
||||
## How Can I Contribute?
|
||||
|
||||
### Reporting Bugs
|
||||
|
||||
- Check the [Issues](https://github.com/OpenSignLabs/OpenSign/issues) to see if the bug has already been reported. If it has, add any additional information in the comments.
|
||||
- If the bug hasn’t been reported, create a new issue. Please provide as much information as possible to help maintainers reproduce the bug.
|
||||
|
||||
### Suggesting Enhancements
|
||||
|
||||
- Use the [Issues](https://github.com/OpenSignLabs/OpenSign/issues) section to suggest any enhancements or new features.
|
||||
- Clearly describe your suggestion, explaining the problem it solves or the functionality it adds.
|
||||
|
||||
### Pull Requests
|
||||
|
||||
- Ensure any install or build dependencies are removed before the end of the layer when doing a build.
|
||||
- Update the README.md with details of changes to the interface, this includes new environment variables, exposed ports, useful file locations, and container parameters.
|
||||
- You may merge the Pull Request in once you have the sign-off of two other developers, or if you do not have permission to do that, you may request the second reviewer to merge it for you.
|
||||
|
||||
## Style Guidelines
|
||||
|
||||
### Git Commit Messages
|
||||
|
||||
- Use the present tense ("Add feature" not "Added feature")
|
||||
- Use the imperative mood ("Move cursor to..." not "Moves cursor to...")
|
||||
- Limit the first line to 72 characters or less
|
||||
|
||||
### JavaScript Style Guide
|
||||
|
||||
Adhere to the [Standard JavaScript Style Guide](https://standardjs.com).
|
||||
|
||||
## Community
|
||||
|
||||
Engage with the community on our [Gitter Channel](https://gitter.im/OpenSignLabs/community) or join our monthly community calls. Details can be found on our [Community Page](COMMUNITY.md).
|
||||
|
||||
## License
|
||||
|
||||
By contributing, you agree that your contributions will be licensed under its [AGPL v3 License](https://github.com/OpenSignLabs/OpenSign/LICENSE).
|
||||
|
||||
---
|
||||
@@ -0,0 +1,10 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
title: Why am I getting 'Ensure this field is accurately filled and meets all requirements'?
|
||||
---
|
||||
|
||||
# Why am I getting 'Ensure this field is accurately filled and meets all requirements'?
|
||||
This happens when you leave a field blank or when you don’t enter correct values in the field, for example not entering email address in correct format.
|
||||
At OpenSign we constantly try to improve the user experience our platform offers, in the latest version of OpenSign the field for which the validation has failed is automatically highlighted making it easy to identify & fix the incorrect values being entered.
|
||||
You can check the bookmark icons on the page previews on the left hand side to quickly find all the pages that have fields meant to be filled by you.
|
||||
<img width="362" alt="image" src="https://github.com/OpenSignLabs/OpenSign/assets/5486116/0e9458d1-3013-4af8-a98f-c7ff01d5d4f2" />
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
title: Why is there no dropdown list when I sign a document myself?
|
||||
---
|
||||
|
||||
# Why is there no dropdown list when I sign a document myself?
|
||||
The dropdown list field is available only when you request a signature from others or when you create a template. This is because dropdown lists function as temporary widgets, allowing the user to select one of multiple values. Once a signer selects a value from the dropdown, it is embedded into the document as text. When you sign a document yourself, OpenSign digitally signs it immediately upon clicking the finish button. Therefore, you can use the text widget to add the necessary text to the document.
|
||||
@@ -0,0 +1,8 @@
|
||||
{
|
||||
"label": "FAQs",
|
||||
"position": 6,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"description": "FAQs on Utilizing Various Features of OpenSign™ - The World's Leading Free & Open Source Document Signing Platform."
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,8 @@
|
||||
{
|
||||
"label": "Create New OpenSign Document",
|
||||
"position": 2,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"description": "5 minutes to learn how to create Document in OpenSign."
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,87 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
title: Enforce email OTP verification
|
||||
---
|
||||
|
||||
# How to Use the "Enable OTP Verification" Feature in OpenSign
|
||||
|
||||
The "Enable OTP Verification" feature in OpenSign is designed to add an extra layer of security to the document-signing process by verifying the signer’s email address. Here’s an in-depth look at how it works, when to use it, and its impact on the signing process.
|
||||
|
||||
## What is OTP Verification?
|
||||
|
||||
**OTP (One-Time Password) Verification** is a security feature that requires each signer to enter a unique code sent to their email address before they can sign the document. This ensures that only individuals with access to the specified email address can complete the signing process, adding an extra level of authenticity to each signature.
|
||||
|
||||
## How to Enable OTP Verification
|
||||
|
||||
1. **Prepare the Document**:
|
||||
- Navigate to "Main Menu" -> "Request Signatures" & start by uploading the document you want to send for signatures in OpenSign.
|
||||
|
||||
2. **Add Signers**:
|
||||
- Specify the individuals who need to sign the document by entering their email addresses.
|
||||
|
||||
3. **Configure Security Settings**:
|
||||
- Click the "Advanced Options"
|
||||
- <img width="499" alt="image" src="https://github.com/user-attachments/assets/2f099abb-9421-49fb-b53a-7d9a610a8cfe"/>
|
||||
|
||||
- Under **Security Settings**, find the option labeled "Enable OTP Verification."
|
||||
- Select **Yes** to activate OTP verification for this document.
|
||||
- <img width="1125" alt="image" src="https://github.com/user-attachments/assets/48d15c53-5eba-407c-8f81-1b17a47f32cb"/>
|
||||
|
||||
|
||||
|
||||
|
||||
4. **Send the Document**:
|
||||
- Once all settings are configured, proceed to send the document to the signers.
|
||||
|
||||
## How OTP Verification Works for Signers
|
||||
|
||||
When OTP verification is enabled, here’s what the signing experience looks like for recipients:
|
||||
|
||||
1. **Email Notification**:
|
||||
- The signer receives an email notification prompting them to review and sign the document.
|
||||
|
||||
2. **OTP Verification Prompt**:
|
||||
- When the signer clicks the link to sign the document, they are required to enter a one-time password (OTP).
|
||||
- An OTP is sent to the signer’s email address. They must enter this code on the signing page to proceed.
|
||||
|
||||
3. **Document Signing**:
|
||||
- After entering the correct OTP, the signer gains access to the document and can proceed with adding their signature.
|
||||
|
||||
## Benefits of Using OTP Verification
|
||||
|
||||
- **Enhanced Security**: Only users with access to the designated email account can sign, reducing the risk of unauthorized access.
|
||||
- **Reliable Authentication**: Verifying the signer’s email adds an additional level of validation, helping to ensure the authenticity of each signature.
|
||||
|
||||
## Impact on the Completion Certificate
|
||||
|
||||
Once the document is fully signed by all parties, OpenSign generates a **Completion Certificate**. This certificate contains detailed information about the signing process, including:
|
||||
|
||||
- **Signer’s Identity**: Each signer’s name and email address.
|
||||
- **OTP Verification Status**: If OTP verification was enabled for the document, this is noted in the completion certificate. This notation serves as proof that the signer’s email address was verified before the document was signed.
|
||||
|
||||
This feature makes it clear that the signing process involved OTP verification, adding credibility to the document’s legal standing.
|
||||
|
||||
## When to Use OTP Verification
|
||||
|
||||
Consider enabling OTP verification in scenarios where:
|
||||
|
||||
- **Confidentiality** is critical: You want to ensure that only authorized individuals with access to the signer’s email can view and sign the document.
|
||||
- **Authentication** is a priority: OTP adds an extra layer of verification, enhancing the document’s validity and security.
|
||||
- **Compliance** is required: Certain regulations or standards may necessitate an additional verification step for document signing.
|
||||
|
||||
## Disabling OTP Verification
|
||||
|
||||
If OTP verification is unnecessary for a particular document:
|
||||
|
||||
1. Under the **Security Settings**, select **No** for the "Enable OTP Verification" option.
|
||||
2. By disabling OTP verification, recipients can directly access and sign the document without needing to enter an OTP.
|
||||
|
||||
## Summary
|
||||
|
||||
The "Enable OTP Verification" feature in OpenSign is a powerful tool for ensuring that only verified individuals can sign documents. By sending a unique code to each signer’s email and requiring it before signing, this feature strengthens security and authenticity. The use of OTP verification is also recorded in the completion certificate, providing a clear record of email verification.
|
||||
|
||||
Use OTP verification whenever you need an added layer of email-based security and authenticity in your document signing workflows.
|
||||
|
||||
If you require more help, feel free to reach out to our customer support on support@opensignlabs.com.
|
||||
|
||||
Happy signing with OpenSign™!
|
||||
@@ -0,0 +1,9 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
title: Navigate between pages of a document
|
||||
---
|
||||
|
||||
# How to navigate between pages of a document in OpenSign™?
|
||||
|
||||
To navigate between pages of a document that you have uploaded either click on the 'prev' & 'next' buttons at the top or click on any of the page previews loaded on the left side -
|
||||

|
||||
@@ -0,0 +1,166 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
title: Request signatures
|
||||
---
|
||||
|
||||
# Request signatures using OpenSign™
|
||||
|
||||
## Interface Overview
|
||||
|
||||
The OpenSign™ Request signatures interface is designed to streamline the process of creating, preparing, and sending documents for electronic signature.
|
||||
|
||||
# How to Create and Send a Document for Signature with OpenSign™
|
||||
|
||||
### Step 1: Begin New Document Creation
|
||||
|
||||
- **Navigate to Request Signatures form**: Start by navigating to 'Request Signatures' from the main menu to initiate the creation of a document for signatures.
|
||||
|
||||
<img width="800" alt="request signatures" src="https://github.com/user-attachments/assets/94112aec-4581-46a5-8e09-b6fc42e9e72a" />
|
||||
|
||||
### Step 2: Uploading Your Document
|
||||
|
||||
- **[2] Choose File**: Once the "Request signature" page opens, click here to select and upload the document file from your computer that needs to be signed.
|
||||
- **[3] Choose File from Dropbox**: Click the dropbox icon to select the document file from your dropbox account.
|
||||
|
||||
### Step 3: Entering Document Details And Signers
|
||||
|
||||
- **[4] Title** *(Required)*: Input the title of your document. This identifier will be visible to signers and in your document management.
|
||||
- **[5] Signers**: Use the dropdown to select existing signers or use the addition button to add a new signer who needs to sign the document. (Here, add the signer's details such as name, email, and phone number).
|
||||
- **[6] Note**: Optionally add a note to give context or instructions regarding the document.
|
||||
|
||||
### Step 4: Organizing Your Document
|
||||
|
||||
- **[7] Folder**: Select a folder where you want the document to be stored, or leave it to default to the 'Root' folder. You can browse your documents in a beautiful explorer view by navigating to "OpenSign™ Drive".
|
||||
|
||||
### Step 5: Setting the Time Frame
|
||||
|
||||
- **[8] Time To Complete (Days)** *(Required)*: Specify the number of days the signers have to complete the signatures. After that, the document will no longer be available for signing.
|
||||
|
||||
### Step 6: Set the sending order
|
||||
- **[9] Send in Order**
|
||||
- **If you choose:**
|
||||
- **Yes**: Selecting this option will send the signing request to the first signer initially. Once the first signer completes their part, the next signer in the sequence will receive the request. This process continues until all signers have signed the document. This method ensures that the document is signed in a specific order.
|
||||
- **No**: Selecting this option will send the signing links to all signers simultaneously. Every signer can sign the document at their convenience, regardless of whether other signers have completed their signatures. This method is faster but does not enforce any signing order among the participants.
|
||||
Select the option that best suits the needs of your document processing.
|
||||
### Step 7: Auto reminder (feature only avilable for the subscribed user)
|
||||
- **[10]** Once you enable the auto reminder, a text field will appear allowing you to set the reminder for a specific number of days.
|
||||
- **Remind once in every (Days)**: Here, you can set the number of days for the reminder.
|
||||
|
||||
### Step 8: Proceed to Document Creation Panel
|
||||
- **Next**: Once all the necessary fields are filled, click this button to proceed to create the document for signing.
|
||||
- **Cancel**: If you need to start over or make changes, click this button to clear the form.
|
||||
### Step 9: Document creation
|
||||
|
||||
<img width="800" alt="request signatures" src="https://github.com/user-attachments/assets/b4e6f257-e362-46a7-b809-546f0e5999fc" />
|
||||
|
||||
- **[1] Add signature widget**: Once your document is loaded in the document creation panel, you'll need to add a signature widget for each signer. OpenSign provides an intuitive interface for this task. Select the signer from the right side panel, click on the signature widget, and position it where the signature is required.
|
||||
Use the option on the right side to add recipients if you need to include additional signers. You can place multiple signature widgets for each signer, as required.
|
||||
|
||||
After placing the Signature widget, you will see the options on the widget such as:
|
||||
- **Add Signer/Change Signer**: Clicking the first icon on the signature widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
|
||||
- **Copy Signature**: Clicking on this option reveals the following choices.
|
||||
- All pages: It will copy the signature widget to all pages.
|
||||
- All pages but last: It will copy the signature widget to all pages except the last page.
|
||||
- All pages but first: It will copy the signature widget to all pages except the first page.
|
||||
|
||||
- **[2] Add other widgets**: Depending on your needs, you can include additional widgets such as:
|
||||
- **Stamp**: After placing the Stamp widget, you will see the options on the widget such as:
|
||||
- Setting icon: By clicking on the option, you can specify whether this widget is mandatory or optional during the document signing.
|
||||
- Add Signer/Change Signer: Clicking the second option on the stamp widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
|
||||
- Copy Stamp: Clicking on this option reveals the following choices.
|
||||
- All pages : It will copy the stamp widget to all pages.
|
||||
- All pages but last: It will copy the stamp widget to all pages except the last page.
|
||||
- All pages but first: It will copy the stamp widget to all pages except the first page.
|
||||
- **Initials**: After placing the Initials widget, you will see the options on the widget such as:
|
||||
- Setting icon: By clicking on the option, you can specify whether this widget is mandatory or optional during the document signing.
|
||||
- Add Signer/Change Signer: Clicking the first icon on the Initials widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
|
||||
- Copy Initials: Clicking on this option reveals the following choices.
|
||||
- All pages : It will copy the stamp widget to all pages.
|
||||
- All pages but last: It will copy the stamp widget to all pages except the last page.
|
||||
- All pages but first: It will copy the stamp widget to all pages except the first page.
|
||||
- **Name**: After placing the name widget, you will see the options on the widget such as:
|
||||
- Setting icon: By clicking on the option, you can set the color and font.
|
||||
- Add Signer/Change Signer: Clicking the first icon on the Name widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
|
||||
- Copy : Clicking on this you can ducplicate the name widget.
|
||||
- **Job title**: After placing the job title widget, you will see the options on the widget such as:
|
||||
- Setting icon: By clicking on the option, you can set the color and font.
|
||||
- Add Signer/Change Signer: Clicking the first icon on the Job title widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
|
||||
- Copy : Clicking on this you can ducplicate the job title widget.
|
||||
|
||||
- **Company**: After placing the company widget, you will see the options on the widget such as:
|
||||
- Setting icon: By clicking on the option, you can set the color and font.
|
||||
- Add Signer/Change Signer: Clicking the first icon on the Company widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
|
||||
- Copy : Clicking on this you can ducplicate the Company widget.
|
||||
- **Date**: After placing the date widget, you will see the options on the widget such as:
|
||||
- Setting icon: By clicking on the option, you can choose from various date formats.
|
||||
- Add Signer/Change Signer: Clicking the first icon on the Date widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
|
||||
- Copy : Clicking on this you can ducplicate the date widget.
|
||||
- **Text**: After placing the Text widget, you will see the options on the widget such as:
|
||||
- Setting icon: By clicking on the option, you can set the color and font.
|
||||
- Copy : Clicking on this you can ducplicate the Text widget.
|
||||
|
||||
- **Text Input**: After placing the Text Input widget, you will see the options on the widget such as:
|
||||
- Setting icon: By clicking on the option, you can set the color and font.
|
||||
- Add Signer/Change Signer: Clicking the first icon on the Text Input widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
|
||||
- Copy : Clicking on this you can ducplicate the Text Input widget.
|
||||
- **Checkbox**: Once you drop the checkbox widget, a popup will open where you can set the checkbox name and options. Additionally, there is few optiona available like you can set Minimum check, maximum check also whether this check box is readonly also hide label option.
|
||||
- Add Signer/Change Signer: Clicking the first icon on the CheckBox widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
|
||||
- Copy : Clicking on this you can ducplicate the image widget.
|
||||
- **Dropdown**: Once you drop the dropdown widget, a popup will open where you can set the dropdown name and options. Additionally, there is few option available like you can set default value, also whether this dropdown is required or optional.
|
||||
- Add Signer/Change Signer: Clicking the first icon on the Dropdown widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
|
||||
- Copy : Clicking on this you can ducplicate the image widget.
|
||||
- **Radio button**: Once you drop the radio button widget, a popup will open where you can set the radio button name and options. Additionally, there is few option available like you can set default value, also whether this radio button is readonly also hide label option.
|
||||
- Add Signer/Change Signer: Clicking the first icon on the Radio button widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
|
||||
- Copy : Clicking on this you can ducplicate the image widget.
|
||||
- **Image**: After placing the Image widget, you will see the options on the widget such as:
|
||||
- Setting icon: By clicking on the option, you can specify whether this widget is mandatory or optional during the document signing.
|
||||
- Add Signer/Change Signer: Clicking the first icon on the Image widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
|
||||
- Copy : Clicking on this you can ducplicate the image widget.
|
||||
- **Email**: After placing the email widget, you will see the options on the widget such as:
|
||||
- Setting icon: By clicking on the option, you can set the color and font.
|
||||
- Add Signer/Change Signer: Clicking the first icon on the Email widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
|
||||
- Copy : Clicking on this you can duplicate the email widget.
|
||||
### Step 10: Next:
|
||||
- **Next**: After adding the widgets and signatures, click the 'Next' button. The document will then be created.
|
||||
|
||||
### Step 11: Send Mail
|
||||
After finishing the document creation, a 'Send Mail' popup will appear, offering options to Send Email, Customize Email, Copy Link, or Share the document.
|
||||
- Send Email: Click the 'Send' button to send the document for signing to all signers. If the sending order is set to 'Yes', it will send the document to the first signer.
|
||||
|
||||
- Customize Email: Click the 'Customize Email' button to open the email editor. Here, you can set variables and customize the content. After clicking 'Send', the document will be sent for signing to all signers, or if the sending order is set to 'Yes', it will be sent to the first signer with the customized email.
|
||||
|
||||
- Copy Link: You can copy the link to sign the document.
|
||||
|
||||
- Share: Use this option to share the document via email, WhatsApp and other Windows apps
|
||||
|
||||
<img width="800" alt="request signatures" src="https://github.com/user-attachments/assets/e2344479-daae-43ff-a61a-14ea98b237d6" />
|
||||
|
||||
## Signers Signing Process
|
||||
### Step 12: Email OTP verification
|
||||
Once the email is received, the signer can click the 'Sign Here' button. This will open the email verification page. After clicking the 'Get Verification Code' button, an OTP (one-time password) will be sent to the signer’s email address. Enter the received OTP into the verification textbox and click the 'Verify' button.
|
||||
|
||||
<div>
|
||||
<img width="800" alt="OpenSign send OTP" src="https://github.com/user-attachments/assets/b82c796a-98e3-4296-bde1-fe86b1b993ad" />
|
||||
</div>
|
||||
<div>
|
||||
<img width="800" alt="OpenSign verify otp" src="https://github.com/user-attachments/assets/63cf4b75-9d47-4630-a83c-e916a5c13b3c" />
|
||||
</div>
|
||||
|
||||
### Step 13: Finalizing the Process:
|
||||
|
||||
After verification, the signer will be redirected to the document signing page, where he can view the document received for signing. To sign, the signer simply clicks on the signature widget, which allows them to draw, upload a digitally scanned signature, or type the signature.
|
||||
|
||||
After filling out all assigned widgets, click the 'Finish' button. Once the document is finished,.
|
||||
- The signer has the option of downloading or printing the signed document. He will also obtain the completion certificate if he is the final signer.
|
||||
|
||||
- If there are more than one signer, the document will be immediately sent to the next signer. Once all signers have finished their signatures, they can download and print the signed document as well as the completion certificate.
|
||||
<img width="800" alt="OpenSignFinalStep" src="https://github.com/user-attachments/assets/f4783aa0-2879-4ec2-9ddc-16d59f3a1fc0" />
|
||||
|
||||
## Additional Information
|
||||
- All fields marked with an asterisk (*) must be completed before the document can be submitted.
|
||||
- Ensure that the document format is supported by OpenSign before uploading.
|
||||
- Signed documents can be accessed in the designated 'Root' folder or the one you have specified.
|
||||
|
||||
If you require more help, feel free to reach out to our customer support on support@opensignlabs.com.
|
||||
|
||||
Happy signing with OpenSign™!
|
||||
@@ -0,0 +1,86 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
title: Sign your-self
|
||||
---
|
||||
|
||||
# Sign your-self using OpenSign™
|
||||
|
||||
## Interface Overview
|
||||
|
||||
# How to digitally sign a document using OpenSign™ for free?
|
||||
|
||||
OpenSign lets you digitally sign documents that don't need to be sent to anybody with ease. This feature is available in all the plans including **OpenSign free**.
|
||||
After login, you will be directed to the OpenSign dashboard. From the left-side menu, click on "Sign yourself" or by clicking the button on the Dashboard.
|
||||
|
||||
### Step 1: Uploading Your Document
|
||||
|
||||
- **[1] Choose File**: Once the "Sign Yourself" page opens, click here to upload the document you want to sign from your computer.
|
||||
- **[2] Upload from Dropbox**: To upload a document directly from your Dropbox account, click the Dropbox icon. You may need to provide permissions to access the file when you do it for the first time.
|
||||
|
||||
```The maximum document size allowed is 20MB.```
|
||||
|
||||
### Step 2: Document Information
|
||||
|
||||
- **[1] Title** *(Required)*: Enter a title for your document. This will help you identify it later in OpenSign™.
|
||||
- **[2] Note**: Provide an optional note for further context about the document.
|
||||
|
||||
<img width="918" alt="OpenSign_Signyourself" src="https://github.com/user-attachments/assets/41c0f460-23b6-4ab0-befd-7fba8e845c23" />
|
||||
|
||||
### Step 3: Document Organization
|
||||
|
||||
- **[1] Folder**: Select a folder where you want the document to be stored, or leave it to default to the 'Root' folder. You can browse your documents in a beautiful explorer view by navigating to "OpenSign™ Drive".
|
||||
- **[2] Root**: This is your default directory. Click the pencil icon to create or choose a different folder.
|
||||
- **[3] Next**: After filling in all the required fields, click the "Next" button to proceed to the document creation panel.
|
||||
|
||||
### Step 4: Document creation and Signing
|
||||
- **[1] Add signature widget**: Once your document is loaded in the document creation panel, you will need to add a signature widget. OpenSign provides an intuitive interface for this task. Click on the signature widget and position it where the signature is required. You can add multiple signature widgets if needed.
|
||||
After placing the Signature widget, a popup will appear for drawing the signature.
|
||||
In the "Draw Signature" popup, you have three options available:
|
||||
- Draw the signature using your mouse cursor.
|
||||
|
||||
- Upload a digitally scanned signature.
|
||||
|
||||
- Type the signature using text input.
|
||||
|
||||
- Select your signature from "My Signature." (This option is available only if you have uploaded a signature under "My Signature" in Settings.)
|
||||
|
||||
- **[2] Add other widgets**: Depending on your needs, you can include additional widgets such as:
|
||||
- **Stamp**: After dragging and dropping the stamp widget, the "Upload Stamp Image" popup will appear, allowing you to upload an image from your file explorer. Once the stamp is uploaded, you will see the stamp image on the document. Additionally, alongside your stamp image, there is an option to copy the image. Clicking on the copy option presents three choices:
|
||||
- All pages : It will copy the stamp to all pages.
|
||||
- All pages but last: It will copy the stamp to all pages except the last page.
|
||||
- All pages but first: It will copy the stamp to all pages except the first page.
|
||||
|
||||
- **Initials**: Click on the initials widget and position it where the initials are required. After placing the Initials widget, a popup will appear for drawing the initials. In the "Draw Initials" popup, you have three options available:
|
||||
- Draw the initials using your mouse cursor.
|
||||
- Upload the digitally scanned initials.
|
||||
- Type the initials using text input.
|
||||
- **Name**: Once you drop the name widget, you can edit the name. We also provide customization options such as setting the color or font. Additionally, there is a copy option available to duplicate the widget.
|
||||
- **Job Title**: Once you drop the job title widget, you can edit the job title. Customization options such as setting the color or font are also provided. Additionally, there is a copy option available to copy the widget.
|
||||
- **Company**: Once you drop the company widget, you can edit the company name. Customization options such as setting the color or font are also provided. Additionally, there is a copy option available to duplicate the widget.
|
||||
- **Date** : Once you drop the date widget, you can choose from various date formats.
|
||||
- **Text**: Once you drop the text widget, you can write the text. Customization options such as setting the color or font are also provided. Additionally, there is a copy option available to duplicate the widget.
|
||||
- **Checkbox**: After dropping the checkbox widget, a popup will open allowing you to set the checkbox name and options. Once you click save, the checkbox will be created on the document. Additionally, a copy option will be available to duplicate the widget.
|
||||
- **Image** : After dragging and dropping the image widget, the "Upload Image" popup will appear, allowing you to upload an image from your file explorer. Once the image is uploaded, it will be displayed on the document. Additionally, there is an option to duplicate the image.
|
||||
- **Email**: Once you drop the email widget, you can edit the email. Customization options such as setting the color or font are also provided. Additionally, there is a copy option available to duplicate the widget.
|
||||
|
||||
<img width="918" alt="OpenSign_Widgets" src="https://github.com/user-attachments/assets/b73ef535-245c-43c8-98eb-cb43e4720bc5" />
|
||||
|
||||
### Step 5: Finalizing the Process:
|
||||
- **Finish**: After adding the widgets and signatures, click the "Finish" button. This will create a digitally signed document.
|
||||
|
||||
### Step 6: Print, download or send the document copy via email
|
||||
After finishing the document, a "Successfully Signed!" popup will appear, offering options to print, download, or send the document via email.
|
||||
In the "Add Email Address" text field, enter the email address you want to send the document to, then click the "Send" button to receive a copy of the signed document.
|
||||
|
||||
<img width="918" alt="OpenSign_sendEmail" src="https://github.com/user-attachments/assets/7ec61f70-3ffe-4c7e-b911-843919c6d25d" />
|
||||
|
||||
## Additional Information
|
||||
|
||||
|
||||
- The fields with an asterisk (*) are mandatory.
|
||||
- Make sure your document is in PDF, PNG, JPG, JPEG, or DOCX format.
|
||||
- You can access your signed documents in the folder you've selected by visiting OpenSign™ Drive anytime. You can also access the documents from reports section.
|
||||
|
||||
If you require more help, feel free to reach out to our customer support on support@opensignlabs.com.
|
||||
|
||||
Happy signing with OpenSign™!
|
||||
@@ -0,0 +1,8 @@
|
||||
{
|
||||
"label": "Manage Docs using OpenSign™ Drive",
|
||||
"position": 2,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"description": "5 minutes to learn everything about OpenSign™ Drive."
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,92 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
title: Create Docs & Folders
|
||||
---
|
||||
|
||||
# Organize Documents using OpenSign™ Drive
|
||||
|
||||
OpenSign Drive offers a streamlined way to manage, sign, and request signatures on your important documents. Whether you're drafting an offer letter or storing signed agreements, organizing your documents effectively is crucial. Here’s a step-by-step guide on how to create documents and folders in OpenSign Drive.
|
||||
|
||||
### 1. Accessing OpenSign Drive
|
||||
After logging into OpenSign, navigate to the left-hand sidebar and click on "OpenSign Drive." This will open the OpenSign Drive page where you can see all your stored files.
|
||||
|
||||
<img width="828" alt="OpenSign drive" src="https://github.com/user-attachments/assets/1159afaa-e7e4-4f6d-9087-e22ea7a0c840" />
|
||||
|
||||
### 2. Creating a New Folder
|
||||
Organizing your documents into folders helps you keep track of different categories of files.
|
||||
|
||||
**Step 1:** In the OpenSign Drive window, look for the "+" icon at the top-right of the screen.
|
||||
**Step 2:** Click the "+" icon and select "Create Folder" from the dropdown menu.
|
||||
**Step 3:** A dialog box will prompt you to name your new folder. Enter a descriptive name and hit "Add."
|
||||
**Step 4:** Your new folder will appear in the main area of OpenSign Drive, ready to store your documents.
|
||||
|
||||
<img width="828" alt="Create new folder" src="https://github.com/user-attachments/assets/f0260329-d3b0-4c03-af1b-7231b4f2c6a4" />
|
||||
|
||||
### 3. Creating a New Document
|
||||
To create a document for self-signing or by requesting a signature, you can do so by selecting the appropriate option from OpenSign Drive.
|
||||
|
||||
**Step 1:** Click the "+" icon in the top-right corner of OpenSign Drive.
|
||||
**Step 2:** This time, choose "Sign Yourself" or "Request Signatures" depending on whether you want to sign the document yourself or send it to others for their signatures.
|
||||
**Step 3:** When you select the "Sign Yourself" or "Request Signature" option, the document creation page will open, allowing you to enter details such as the document title, description, notes, and other necessary information. You can also choose an OpenSign Drive folder to store your document. Once you’ve selected the folder and created the document, it will be saved in that folder, making it easily accessible from your OpenSign Drive.
|
||||
|
||||
<img width="828" alt="Create new document" src="https://github.com/user-attachments/assets/97bd75ec-ea9d-4f1d-b514-b9e04ce856aa" />
|
||||
|
||||
### 4. Organizing Documents
|
||||
After creating or uploading documents, it's crucial to organize them effectively. Here are some options available in OpenSign Drive for managing your documents:
|
||||
|
||||
<img width="828" alt="OpenSign Drive Options" src="https://github.com/user-attachments/assets/350c7f0b-7751-419d-85bd-3d4ca68c1485" />
|
||||
|
||||
- **Download:** To download a document, right-click on it and select the "Download" option. This will save a copy of the document to your device.
|
||||
|
||||
- **Rename:** If you need to rename a document, right-click on it and choose the "Rename" option. This will allow you to edit the document's name.
|
||||
|
||||
- **Move:** To move a document to a different folder, right-click on the document and select the "Move" option. You'll see a list of existing folders, along with the option to create a new folder. Select the desired folder or create a new one, then move the document to that location.
|
||||
|
||||
- **Delete:** If you wish to delete a document, simply right-click on it and choose the "Delete" option. This will remove the document from your OpenSign Drive.
|
||||
|
||||
Organizing your documents properly ensures that you can easily find and manage them whenever needed.
|
||||
|
||||
### 5. Managing Documents
|
||||
|
||||
OpenSign Drive offers a variety of tools to help you manage your documents efficiently, one of the most useful being the Status Indicators system.
|
||||
|
||||
**Status Indicators**
|
||||
|
||||
These indicators are represented by different icons on your documents, allowing you to instantly recognize their current status:
|
||||
|
||||
- **Signed (Green Check Mark):** This icon signifies that the document has been fully signed and is complete.
|
||||
- **Pending Signature (Yellow Paper Airplane):** Documents with this icon are awaiting signatures from one or more parties.
|
||||
- **Draft (Blue Paper Clip):** A Blue Paper Clip indicates that the document is in draft form and has not yet been sent out for signatures.
|
||||
- **Declined document (Red Exclamation Mark):** This icon highlights documents that require immediate action, indicating that the document has been declined.
|
||||
- **Expired (Gray Hourglass):** A gray hourglass indicates that the document is expired.
|
||||
|
||||
<img width="828" alt="Create new folder" src="https://github.com/user-attachments/assets/b488ef24-3db5-4323-a3b3-ed3c12a04291" />
|
||||
|
||||
### 6. Filter and Sort Documents in OpenSign Drive
|
||||
OpenSign Drive provides a powerful and easy-to-use interface for managing your documents. To help you quickly find and organize your files, OpenSign Drive offers several sorting and filtering options, allowing you to arrange your documents by name or date, in either ascending or descending order.
|
||||
|
||||
<img width="861" alt="OpenSign filters" src="https://github.com/user-attachments/assets/af51e68a-730c-4203-8015-54b30da572f6" />
|
||||
|
||||
- **Sorting Documents by Name:**
|
||||
To sort your documents alphabetically:
|
||||
|
||||
1. Click on the Sort dropdown menu in the upper right corner of the OpenSign Drive interface.
|
||||
2. Select "Name" from the dropdown list. This will arrange your documents alphabetically by their titles.
|
||||
3. You can then choose to order them in ascending (A-Z) or descending (Z-A) order by toggling the "Ascending" or "Descending" option.
|
||||
|
||||
- **Sorting Documents by Date:**
|
||||
If you prefer to sort your documents based on when they were created or modified:
|
||||
|
||||
1. Click the Sort dropdown menu in the top right corner.
|
||||
2. Ensure that "Date" is selected. This will organize your documents based on their creation or modification date.
|
||||
3. Select "Ascending" to arrange documents from the oldest to the newest, or choose "Descending" to list them from the newest to the oldest.
|
||||
|
||||
- **Ascending vs. Descending Order**
|
||||
- **Ascending Order:** Whether sorting by name or date, selecting "Ascending" will arrange your documents from A to Z (if sorting by name) or from oldest to newest (if sorting by date).
|
||||
- **Descending Order:** Choosing "Descending" will reverse the order, arranging documents from Z to A (by name) or from newest to oldest (by date).
|
||||
|
||||
These sorting features help you keep your documents organized, making it easier to locate specific files quickly, especially when you have a large number of documents stored in your OpenSign Drive.
|
||||
|
||||
If you require more help, feel free to reach out to our customer support on support@opensignlabs.com.
|
||||
|
||||
Happy signing with OpenSign™!
|
||||
@@ -0,0 +1,18 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
title: Grid vs List view
|
||||
---
|
||||
|
||||
# How to switch between grid view and list view in OpenSign drive
|
||||
|
||||
- Navigate to OpenSign drive using the main menu or clicking [this](https://app.opensignlabs.com/opensigndrive) link.
|
||||
- Click the list view icon on the upper right corner of the screen(marked in green) to switch to list view from gride view -
|
||||
|
||||
<img width="1159" alt="OpenSign gridview icon" src="https://github.com/user-attachments/assets/0c03980e-6c28-4ac4-ace2-214d66858d84"></img>
|
||||
|
||||
- In case you are already in list view, you will find a button to swith to grid view at the same location(marked in green)
|
||||
|
||||
<img width="1164" alt="image" src="https://github.com/user-attachments/assets/566845ac-de2e-4f0a-b758-77833fb6e829"></img>
|
||||
|
||||
|
||||
|
||||
@@ -0,0 +1,49 @@
|
||||
# OpenSign™ Drive Interface Documentation
|
||||
|
||||
## Overview
|
||||
|
||||
This documentation provides an overview of the OpenSign™ Drive interface, detailing its key features, user interface elements and functionality.
|
||||

|
||||
|
||||
### Interface Elements
|
||||
|
||||
- **Navigation Bar**: At the top, displaying the current directory ("OpenSign™ Drive >").
|
||||
- **Toolbar**:
|
||||
- `+`: Button to add new documents.
|
||||
- `Sort Options`: Dropdown to sort files by criteria such as date.
|
||||
- `View Options`: Toggle between list and grid views.
|
||||
|
||||
### File Organization
|
||||
|
||||
- **Documents**: Represented by icons with a red PDF symbol.
|
||||
- `Status Indicator`: Colored dots on the PDF icons represent the document status (e.g., green for 'complete').
|
||||
- **Folders**: Represented by yellow folder icons.
|
||||
|
||||
### Document Information Popup
|
||||
|
||||
- Activated by hovering on a document, displaying the following details:
|
||||
- **Title**: The name of the document.
|
||||
- **Status**: Current status of the document (e.g., "Draft", "In-progress", "Completed", "Rejected" & "Expired").
|
||||
- **Created Date**: The date the document was created or uploaded.
|
||||
- **Additional Notes**: Any pertinent notes or descriptions.
|
||||
|
||||
### File and Folder Labels
|
||||
|
||||
- **Labels**: Below each icon, providing the name of the file or folder.
|
||||
- **Status Labels**: Next to file labels, indicating additional status information.
|
||||
|
||||
## Interaction Patterns
|
||||
|
||||
- **Click**: Select files or folders.
|
||||
- **Right-click**: Access context-specific actions.
|
||||
|
||||
## Accessibility Features
|
||||
|
||||
- **Status Colors**: Visually distinct colors for quick status recognition.
|
||||
- **File Icons**: Large and clear with significant visual cues (PDF symbol).
|
||||
|
||||
### Version Information
|
||||
|
||||
This interface is current as of 15/01/2024. It is subject to change with future updates to the OpenSign™ Drive.
|
||||
|
||||
For further assistance or to report issues, please contact us on hello@opensignlabs.com
|
||||
@@ -0,0 +1,21 @@
|
||||
# Rename documents from OpenSign™ Drive
|
||||
|
||||
The OpenSign™ Drive interface allows users to rename their documents efficiently.
|
||||
|
||||

|
||||
|
||||
## Overview of User Interface
|
||||
|
||||
- **Toolbar at the top**: Includes options to add a new document (`+` icon), sort documents by date, and change the view layout (grid or list view).
|
||||
- **Document and Folder Grid**: Displays documents and folders as icons with titles. PDF documents are clearly indicated with a red PDF logo.
|
||||
- **Status Indicators**: Some documents have colored status labels such as blue (with a lock icon) indicating a secure document, and green (with a checkmark) suggesting completed or signed documents.
|
||||
- **Selected Document Preview**: When a document is selected, a preview pane appears at the bottom, showing details like Title, Status, Created Date, and Signers involved.
|
||||
|
||||
## Renaming a Document
|
||||
|
||||
To rename a document in OpenSign™ Drive, follow these steps:
|
||||
|
||||
1. **Select the Document**: Hover on the document you wish to rename. The document will be highlighted and its details will be displayed in the preview pane.
|
||||
2. **Access Rename Option**: Right-click on the selected document to open the context menu and select the 'Rename' option.
|
||||
3. **Edit the Title**: Enter the new name for the document in the provided field.
|
||||
4. **Save Changes**: Press 'Enter' to apply the new name to the document.
|
||||
@@ -0,0 +1,8 @@
|
||||
{
|
||||
"label": "Reports",
|
||||
"position": 2,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"description": "Navigate seamlessly through OpenSign™ reports."
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,48 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
title: Completed
|
||||
---
|
||||
# Completed documents report
|
||||
---
|
||||
|
||||
The "Completed documents" report within OpenSign serves as a vital tool for managing and reviewing all finalized documents that have been processed through the platform. This guide will walk you through the key features and functionalities of the "Completed documents" report, enabling you to efficiently navigate and manage your signed documents.
|
||||
|
||||
```note: In this report, you can only see documents that you own.```
|
||||
|
||||
### Navigating to the Completed documents report
|
||||
|
||||
1. Once logged into OpenSign, you'll see a navigation panel on the left side of your screen.
|
||||
2. Click on **"Reports"** to expand the available options.
|
||||
3. Select **"Completed"** to view the list of documents that have been fully signed and processed.
|
||||
|
||||
### Understanding the Completed documents report
|
||||
|
||||
The "Completed documents" report is displayed in a tabular format, presenting key information about each finalized document. Below is a breakdown of each column and its purpose:
|
||||
|
||||
<img width="816" alt="OpenSign_Signyourself" src="https://github.com/user-attachments/assets/4694c9b3-ca2c-4f27-a9d9-8dca220a4124" />
|
||||
|
||||
- **Sr.No:** This column displays the serial number for each document in the list, helping you quickly identify and reference documents.
|
||||
|
||||
- **Title:** The "Title" column displays the name of the document.
|
||||
|
||||
- **Note:** This section contains any notes that were added during the document's creation process.
|
||||
|
||||
- **Folder:** The "Folder" column indicates the location where the document is stored within OpenSign Drive, ensuring you can easily locate the document later.
|
||||
|
||||
- **File:** Here, you will find a **"Download"** link that allows you to directly download the completed document to your local device for review or archiving.
|
||||
|
||||
- **Owner:** This column shows the name of the person who created the document.
|
||||
|
||||
- **Signers:** The "Signers" column displays the names and email addresses of the signers assigned to that document for signature. Click the "View" button to see the signers.
|
||||
|
||||
### Action buttons
|
||||
|
||||
The "Completed documents" report also includes several actions icons for each document:
|
||||
|
||||
- **View Document:** The eye icon allows you to preview the document directly within OpenSign without needing to download it.
|
||||
|
||||
- **Delete Document:** The trash bin icon enables you to permanently delete a document from your completed list. Be cautious, as this action cannot be undone.
|
||||
|
||||
If you require more help, feel free to reach out to our customer support on support@opensignlabs.com.
|
||||
|
||||
Happy signing with OpenSign™!
|
||||
@@ -0,0 +1,38 @@
|
||||
---
|
||||
sidebar_position: 7
|
||||
title: Contactbook
|
||||
---
|
||||
|
||||
# Contactbook
|
||||
|
||||
The **Contactbook** report in OpenSign enables you to add and manage contacts.
|
||||
|
||||
## Accessing Contactbook
|
||||
|
||||
To view your Contactbook:
|
||||
|
||||
1. Log in to your OpenSign account.
|
||||
2. Navigate to the left sidebar.
|
||||
3. Click on the `Contactbook` link under the reports section.
|
||||
|
||||
<img width="828" alt="Add contact" src="https://github.com/user-attachments/assets/80308df4-33a8-41ee-a240-801f775dcec0" />
|
||||
|
||||
## Understanding the Contactbook report
|
||||
### Adding a New Contact:
|
||||
|
||||
To add a new contact, click the red plus (+) button located at the top-right corner of the Contactbook page.
|
||||
This will open a pop-up where you can enter the contact’s name, email, and phone number.
|
||||
|
||||
The Contactbook page displays a list of contacts with the following columns:
|
||||
|
||||
- **Sr.No**: A sequential number for each contact.
|
||||
- **Name**: The contact's name.
|
||||
- **Email**: The contact’s email address.
|
||||
- **Phone**: The contact’s phone number (if available).
|
||||
|
||||
<img width="828" alt="contactbook" src="https://github.com/user-attachments/assets/524a7aa7-594e-412a-ad50-caebc125c1db" />
|
||||
|
||||
### Action buttons
|
||||
|
||||
- **Delete**: To delete a contact, click on the trash icon located next to the contact’s details. This will remove the contact from your Contactbook. A confirmation prompt may appear to prevent accidental deletions.
|
||||
|
||||
@@ -0,0 +1,44 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
title: Declined
|
||||
---
|
||||
# The Declined documents report
|
||||
|
||||
The "Declined documents" report within OpenSign serves as a vital tool for managing and reviewing all declined documents that have been processed through the platform. This guide will walk you through the key features and functionalities of the "Declined documents" report, enabling you to efficiently navigate and manage your signed documents.
|
||||
|
||||
### Navigating to the Declined documents report
|
||||
|
||||
1. Once logged into OpenSign, you'll see a navigation panel on the left side of your screen.
|
||||
2. Click on **"Reports"** to expand the available options.
|
||||
3. Select **"Declined"** to view the list of documents that have been fully signed and processed.
|
||||
|
||||
### Understanding the Declined documents report
|
||||
|
||||
The "Declined documents" report is displayed in a tabular format, presenting key information about each finalized document. Below is a breakdown of each column and its purpose:
|
||||
|
||||
<img width="816" alt="OpenSign_Signyourself" src="https://github.com/user-attachments/assets/dc55e678-52c0-4e75-a1d5-b5a94690bc33" />
|
||||
|
||||
- **Sr.No:** This column displays the serial number for each document in the list, helping you quickly identify and reference documents.
|
||||
|
||||
- **Title:** The "Title" column displays the name of the document.
|
||||
|
||||
- **Reason:** This section contains the reasons for declining the document.
|
||||
|
||||
- **Folder:** The "Folder" column indicates the location where the document is stored within OpenSign Drive, ensuring you can easily locate the document later.
|
||||
|
||||
- **File:** Here, you will find a **"Download"** link that allows you to directly download the completed document to your local device for review or archiving.
|
||||
|
||||
- **Owner:** This column shows the name of the person who created the document.
|
||||
|
||||
- **Signers:** The "Signers" column displays the names and email addresses of the signers assigned to that document for signature. Click the "View" button to see the signers
|
||||
|
||||
### Action buttons
|
||||
|
||||
The "Declined documents" report also includes several action icons for each document:
|
||||
|
||||
- **View Document:** The eye icon allows you to preview the document directly within OpenSign without needing to download it.
|
||||
- **Delete Document:** The trash bin icon enables you to permanently delete a document from your declined list. Be cautious, as this action cannot be undone.
|
||||
|
||||
If you require more help, feel free to reach out to our customer support on support@opensignlabs.com.
|
||||
|
||||
Happy signing with OpenSign™!
|
||||
@@ -0,0 +1,45 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
title: Drafts
|
||||
---
|
||||
# The Draft documents report
|
||||
|
||||
The Draft documents section in OpenSign helps you manage all your in-progress documents easily. This feature allows you to save, review, and edit documents before sending them for signature. Here's a detailed overview of how to navigate and use the Draft Documents report effectively.
|
||||
|
||||
### Navigating to the Draft documents report
|
||||
|
||||
1. Once logged into OpenSign, you'll see a navigation panel on the left side of your screen.
|
||||
2. Click on **"Reports"** to expand the available options.
|
||||
3. Select **"Drafts"** under the Reports section. This will display all your saved draft documents.
|
||||
|
||||
### Understanding the Draft documents report
|
||||
|
||||
The Draft documents section provides an organized list of all documents that are saved as drafts. Each draft entry contains key details that help you quickly identify and manage your documents. Here’s a breakdown of the information available:
|
||||
|
||||
<img width="816" alt="Draft documents" src="https://github.com/user-attachments/assets/6f743287-6459-4e93-ad7d-064c1ed68da0" />
|
||||
|
||||
- **Sr.No:** This column displays the serial number for each document in the list, helping you quickly identify and reference documents.
|
||||
|
||||
- **Title:** The "Title" column displays the name of the document.
|
||||
|
||||
- **Note:** This section contains any notes that were added during the document's creation.
|
||||
|
||||
- **Folder:** The "Folder" column indicates the location where the document is stored within OpenSign Drive, ensuring you can easily locate the document later.
|
||||
|
||||
- **File:** Here, you will find a **"Download"** link that allows you to directly download the drafted document to your local device for review or archiving.
|
||||
|
||||
- **Owner:** This column shows the name of the person who created the document.
|
||||
|
||||
- **Signers:** The "Signers" column displays the names and email addresses of the signers assigned to that document for signature. Click the "View" button to see the signers.
|
||||
|
||||
### Action buttons
|
||||
|
||||
The "Draft documents" report also includes several actions icons for each document:
|
||||
|
||||
- **Edit:** If you need to make changes to your draft, click the edit (pencil) icon. This will open the document for you to make the necessary modifications before sending it for signatures.
|
||||
|
||||
- **Delete:** If a draft is no longer needed, click the trash icon to delete it. Be cautious when using this action as deleted drafts cannot be recovered.
|
||||
|
||||
If you require more help, feel free to reach out to our customer support on support@opensignlabs.com.
|
||||
|
||||
Happy signing with OpenSign™!
|
||||
@@ -0,0 +1,46 @@
|
||||
---
|
||||
sidebar_position: 6
|
||||
title: Expired
|
||||
---
|
||||
|
||||
# Expired documents report
|
||||
|
||||
The **Expired documents** report in OpenSign allows you to manage and review documents that have reached their expiration date without being signed. This feature is essential for maintaining an organized record of inactive documents that may require follow-up or archival.
|
||||
|
||||
## Accessing Expired documents
|
||||
|
||||
To view your expired documents:
|
||||
|
||||
1. Log in to your OpenSign account.
|
||||
2. Navigate to the left sidebar.
|
||||
3. Click on the `Expired` link under the Reports section.
|
||||
|
||||
<img width="828" alt="Expired document" src="https://github.com/user-attachments/assets/01f3626f-d694-4d3b-82da-2f2b77693b76" />
|
||||
|
||||
## Understanding the Expired documents report
|
||||
|
||||
The Expired documents report displays a list of documents that have not been signed by all parties before the designated expiration date. Each entry in the report includes the following information:
|
||||
|
||||
- **Title**: The name of the document.
|
||||
- **Note**: A brief note associated with the document at the time of creation.
|
||||
- **Folder**: The folder in which the document is stored, helping you organize and locate documents efficiently in OpenSign drive.
|
||||
- **File**: Link to download the document for offline storage.
|
||||
- **Owner**: The user who uploaded or owns the document.
|
||||
- **Signers**: Lists the parties required to sign the document.
|
||||
|
||||
### Action buttons
|
||||
|
||||
For each expired document, you can perform several actions:
|
||||
|
||||
- **Delete**: Deletes the document from your OpenSign account.
|
||||
- **View**: Opens the document in a viewer within OpenSign, allowing you to review the details and contents of the document.
|
||||
|
||||
## Managing Expired documents
|
||||
|
||||
Managing your expired documents effectively can help ensure that no important document is overlooked. Consider the following tips:
|
||||
|
||||
- **Review Regularly**: Check the Expired documents report periodically to manage documents that require attention.
|
||||
- **Follow Up**: Contact the signers who have not completed their signatures informing them about the expired documents and resend the documents if necessary.
|
||||
- **Archive**: Move documents that are no longer active or needed to an archive folder to keep your workspace organized.
|
||||
|
||||
By keeping track of your expired documents, you can maintain a clear overview of your document workflows & ensure that all the necessary actions are taken on time.
|
||||
@@ -0,0 +1,70 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
title: In Progress
|
||||
---
|
||||
# In-Progress documents report
|
||||
The In-Progress documents report in OpenSign helps you monitor and manage documents that are currently in the signing process. This report enables you to monitor the status of your documents, manually share the document URL, track document progress, resend reminders, revoke access, or delete documents that are no longer required. Here’s a detailed guide on how to use the In-Progress documents report effectively.
|
||||
|
||||
### Navigating to the In-Progress documents report
|
||||
|
||||
1. Once logged into OpenSign, you'll see a navigation panel on the left side of your screen.
|
||||
2. Click on **"Reports"** to expand the available options.
|
||||
3. Select **"In progress"** This will display all documents that are currently awaiting signatures or are otherwise in the signing process.
|
||||
|
||||
### Understanding the In-Progress documents report
|
||||
|
||||
The "In progress documents" report is displayed in a tabular format, presenting key information about each finalized document. Below is a breakdown of each column and its purpose:
|
||||
|
||||
<img width="816" alt="Inprogress documents" src="https://github.com/user-attachments/assets/60100998-1412-4331-8842-55fd9dd10307" />
|
||||
|
||||
- **Sr.No:** This column displays the serial number for each document in the list, helping you quickly identify and reference documents.
|
||||
|
||||
- **Title:** The "Title" column displays the name of the document.
|
||||
|
||||
- **Note:** This section contains any notes that were added during the document's creation process.
|
||||
|
||||
- **Folder:** The "Folder" column indicates the location where the document is stored within OpenSign Drive, ensuring you can easily locate the document later.
|
||||
|
||||
- **File:** Here, you will find a **"Download"** link that allows you to directly download the In-progress document to your local device for review.
|
||||
|
||||
- **Status:** This column displays the current status of the document, indicating whether it has been viewed or signed by the signer. Once the signer has viewed or signed the document, the Owner of the document can click "View" to see the activity logs.
|
||||
|
||||
<img width="816" alt="Inprogress documents" src="https://github.com/user-attachments/assets/4eb43321-5eec-48ec-a3b6-75e932d31c6c" />
|
||||
|
||||
|
||||
- **Signers:** The "Signers" column displays the names and email addresses of the signers assigned to that document for signature. Click the "View" button to see the signers.
|
||||
|
||||
### Action buttons
|
||||
|
||||
The "In progress documents" report also includes several actions icons for each document:
|
||||
|
||||
- **Share Document:** The "Share" option in the In-Progress Documents report allows you to manually share the signing link of a document with signers or other recipients directly via email. This feature ensures that the signers can easily access the document, even if they have missed the initial notification.
|
||||
|
||||
<img width="816" alt="Inprogress documents" src="https://github.com/user-attachments/assets/7c632c2d-c784-4b51-9517-5c6817abd16f" />
|
||||
|
||||
Upon clicking the Share icon, a pop-up window titled Copy link will appear. This window provides multiple options to share the document link with designated recipients.
|
||||
|
||||
**Here’s how to use the options within this pop-up:**
|
||||
|
||||
The pop-up will display a list of email addresses of the intended recipients or signers of the document. Each email corresponds to a person who needs access to the document.
|
||||
|
||||
-
|
||||
- **Share Button:** Click the Share button next to the recipient’s email address to resend the document link directly to that individual. This action provides multiple sharing options, such as copying the link, or sharing it via Outlook, WhatsApp, Messenger, and more.
|
||||
|
||||
- **Copy Button:** Click the Copy button next to the email address to copy the unique signing link to your clipboard. You can then paste this link manually into an email, chat, or any other preferred method of communication to share with the recipient.
|
||||
|
||||
- **View Document:** The eye icon lets you preview the document directly within OpenSign without downloading it. Here, you can view the document's exact status, including who has signed and how many signers are still pending.
|
||||
|
||||
- **Resend:** If a signer has not responded or needs a reminder, use the resend option to send another notification. This ensures that the signing process continues without delay.
|
||||
|
||||
<img width="816" alt="resend document" src="https://github.com/user-attachments/assets/c0cb3348-47ca-4d2e-a2d7-81cb3b18a0c6" />
|
||||
|
||||
- **Revoke:** If there’s a mistake or you need to cancel the document, revoking stops all signing actions immediately. This is useful when changes are needed before re-sending the document.
|
||||
|
||||
<img width="816" alt="resend document" src="https://github.com/user-attachments/assets/b2273768-ef81-44cd-95ea-92babee429b6" />
|
||||
|
||||
- **Delete :** If the document is outdated or was sent by mistake, you can permanently remove it from the list. Use this action cautiously, as deleted documents cannot be recovered.
|
||||
|
||||
If you require more help, feel free to reach out to our customer support on support@opensignlabs.com.
|
||||
|
||||
Happy signing with OpenSign™!
|
||||
@@ -0,0 +1,51 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
title: Need your sign
|
||||
---
|
||||
# Need your sign report
|
||||
|
||||
The "Need your sign" feature in OpenSign is designed to simplify the process of managing documents that require your signature. This guide will walk you through the various elements of the "Need your sign" report, helping you to efficiently navigate and complete your pending signing tasks.
|
||||
|
||||
## Accessing the "Need your sign" report
|
||||
|
||||
- **Login to OpenSign**: Start by logging into your OpenSign account.
|
||||
- **Navigate to "Need your sign"**: Once logged in, you will find a navigation panel on the left side of your screen. Under the "Reports" section, click on "Need your sign" to view all documents that require your signature.
|
||||
|
||||
## Understanding the "Need your sign" report
|
||||
|
||||
Upon clicking "Need your sign," you will be presented with a list of documents awaiting your signature. Here's a breakdown of the key elements within this interface:
|
||||
|
||||
- **Sr.No**: This column provides a serial number for each document in the list, allowing for easy identification and reference.
|
||||
|
||||
- **Title**: The "Title" column displays the name of the document.
|
||||
|
||||
- **Note**: This section includes any notes or instructions related to the document.
|
||||
|
||||
- **Folder**: The folder column shows where the document is stored within OpenSign Drive. This helps in organizing and finding documents later on.
|
||||
|
||||
- **File**: In this column, a "Download" link is provided, allowing you to download the document directly to your device for offline review or record-keeping.
|
||||
|
||||
- **Owner**: The owner column indicates who owns or initiated the document.
|
||||
|
||||
- **Signers**: The "Signers" column displays the names and email addresses of the signers assigned to that document for signature. Click the "View" button to see the signers
|
||||
|
||||
- **Sign**: The "SIGN" button is prominently displayed next to each document. Clicking this button will open the document in the signing interface, allowing you to review and apply your signature.
|
||||
|
||||
### Action buttons
|
||||
|
||||
- **View Document**: By clicking "View" under the "Signers" column, you can get more details about the document, including the list of individuals who have already signed or are expected to sign it.
|
||||
|
||||
- **Download Document**: The "Download" link in the "File" column provides a quick way to save the document to your local device, ensuring you have a copy for your records.
|
||||
|
||||
## Signing a Document
|
||||
|
||||
To sign a document:
|
||||
|
||||
1. Click the **SIGN** button next to the document you wish to sign.
|
||||
2. Review the document carefully within the OpenSign interface.
|
||||
3. Apply your signature following the prompts.
|
||||
4. Once signed, the document will move from the "Need your sign" section to the "Completed" section, indicating that the signing process is finished.
|
||||
|
||||
If you require more help, feel free to reach out to our customer support on support@opensignlabs.com.
|
||||
|
||||
Happy signing with OpenSign™!
|
||||
@@ -0,0 +1,8 @@
|
||||
{
|
||||
"label": "Settings",
|
||||
"position": 5,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"description": "5 minutes to learn everything about OpenSign™ configuration."
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,19 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
title: Disable DocumentId
|
||||
---
|
||||
|
||||
# How to disable adding the OpenSign™ documentId to signed documents
|
||||
Whenever a document is signed by all parties, OpenSign™ adds a DocumentId at the top left corner of the digitally signed document.
|
||||
Using this id you can verifiy the authenticity of the document at a later date, hence we strongly recommend that you keep this id.
|
||||
In case you want to disable adding this to your signed documents, turn the 'Disable DocumentId' switch on.
|
||||
|
||||
- Click the '⌄' symbol just beside your name on the top right corner
|
||||
- Click profile
|
||||
- Click the 'edit' button
|
||||
- Turn the 'Disable DocumentId' swith to on
|
||||
- Click 'save'
|
||||
|
||||
<img width="436" alt="image" src="https://github.com/OpenSignLabs/OpenSign/assets/5486116/ee4433c7-1af7-4b74-800d-500060c0642d"></img>
|
||||
|
||||
Note that this feature will be available only to enterprise plan customers.
|
||||
@@ -0,0 +1,52 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
title: Manage users
|
||||
---
|
||||
|
||||
# User Management
|
||||
|
||||
The **User Management** feature allows administrators to add, edit, and manage users within the OpenSign application. This feature is available on self-hosted, teams, and enterprise plans. Only users with "Admin" & "OrgAdmin" role are allowed to manage users.
|
||||
|
||||
## Accessing User Management
|
||||
|
||||
1. **Navigate to User management**
|
||||
- Go to the **Menu**.
|
||||
- Select **Settings**.
|
||||
- Click on **Users**.
|
||||
- A list of existing users will be displayed.
|
||||
|
||||
## Adding a New User
|
||||
|
||||
To add a new user:
|
||||
|
||||
1. **Click the "+" Button**
|
||||
- Located in the upper right corner of the user list.
|
||||
|
||||
2. **Fill in the User Information**
|
||||
- **Name** (required): Enter the user's full name.
|
||||
- **Email** (required): Enter the user's email address.
|
||||
- **Password**: A password is generated automatically. Copy it as it will only be displayed once.
|
||||
- **Phone** (optional): Enter the user's phone number.
|
||||
- **Team** (required): Select the team the user belongs to from the dropdown. Teams can be created only on the Teams & Enterprise plans.
|
||||
- **Role** (required): Select the user's role from the dropdown - OrgAdmin(Has all permissions including user management), Editor(Has all permissions other than user management like creating & sharing templates with teams, User(cannot manager users & cannot share templates with teams but can use templates features for themselves).
|
||||
|
||||

|
||||
|
||||
3. **Submit or Cancel**
|
||||
- Click **Submit** to add the user.
|
||||
- Click **Cancel** to discard the changes.
|
||||
|
||||
## Managing User Status
|
||||
|
||||
- **Toggling Active Status**
|
||||
- Use the "active" switch next to each user to enable or disable their account.
|
||||
|
||||
---
|
||||
|
||||
For more information, visit our social media channels:
|
||||
- [Twitter](https://twitter.com/OpenSignHQ)
|
||||
- [Website](http://www.opensignlabs.com)
|
||||
- [Facebook](https://www.facebook.com/profile.php?id=61551030403669)
|
||||
- [LinkedIn](https://www.linkedin.com/company/opensignhq/)
|
||||
- [YouTube](https://www.youtube.com/@opensignhq)
|
||||
|
||||
@@ -0,0 +1,37 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
title: My Signature
|
||||
---
|
||||
|
||||
# Setup "My Signature" in OpenSign
|
||||
|
||||
This guide provides instructions on how to save your signature and initials using the OpenSign application. Once saved, you can use them with one click when signing documents. To create your signature, start by clicking the "My Signature" link under "settings" menu.
|
||||
|
||||
## Creating and Saving Your Signature
|
||||
|
||||
The drawing box on the left is dedicated to this purpose. If you make a mistake or wish to redo your signature, simply click the Clear button below the drawing box to erase it and start over.
|
||||
|
||||
## Uploading a Signature Image
|
||||
|
||||
Alternatively, if you prefer to use a pre-existing image of your signature, click the "Upload Image" button next to the Signature button. This will prompt you to select an image file from your device. Once uploaded, the image will be displayed in the drawing box, ready to be saved.
|
||||
|
||||
<img width="820" alt="create signature and initials" src="https://github.com/user-attachments/assets/6e86e3ed-48e2-47d1-a9b6-f964b13986c5"></img>
|
||||
|
||||
## Creating and Saving Your Initials
|
||||
|
||||
For creating your initials, use your mouse or a stylus to draw your initials on the drawing box on the right. As with the signature, there is a Clear button available to erase and redo the initials if necessary.
|
||||
|
||||
## Saving Your Signature and Initials
|
||||
|
||||
After you have drawn your signature and initials or uploaded your signature image, the next step is to save them. Click the Save button located below the drawing areas. This will store your signature and initials in the system, making them readily available for future use.
|
||||
|
||||
<img width="820" alt="create signature" src="https://github.com/user-attachments/assets/f999f256-038f-4e91-be7d-e1dceb0cfdec"></img>
|
||||
|
||||
Once saved, these can be applied with a single click whenever you need to sign a document within the OpenSign application, streamlining your workflow and ensuring consistency in your document signing process.
|
||||
|
||||
## Getting Started
|
||||
**try OpenSign on cloud** at **[OpenSignLabs](https://app.opensignlabs.com)**.
|
||||
|
||||
Or
|
||||
|
||||
Get started by deploying a new instance of **OpenSign** by following these [instructions](https://docs.opensignlabs.com/docs/self-host/intro).
|
||||
@@ -0,0 +1,8 @@
|
||||
{
|
||||
"label": "Templates",
|
||||
"position": 2,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"description": "5 minutes to learn everything about OpenSign™ Templates feature."
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,179 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
title: Create Templates
|
||||
---
|
||||
|
||||
## Getting Started
|
||||
|
||||
Creating a template in OpenSign is straightforward and can significantly enhance your document workflow. Follow these steps to create a custom template:
|
||||
|
||||
# How to Create a Template in OpenSign™
|
||||
|
||||
## Step 1:
|
||||
### Begin New Template Creation
|
||||
|
||||
- **Navigate to New template form**: On the left sidebar, click on "Templates" to expand the menu. and Click on the "Create template" option.
|
||||
|
||||
<img width="828" alt="Create Template" src="https://github.com/user-attachments/assets/1cb7610f-c144-4774-85c2-ed7d70e0a73c" />
|
||||
|
||||
### Uploading Your Document
|
||||
|
||||
- **[1] Choose File**: Once the "New template" page opens, click here to select and upload the document file from your computer that needs to be signed. Supported formats include PDF, PNG, JPG, JPEG, and DOCX.
|
||||
- **[2] Choose File from Dropbox**: Click the dropbox icon to select the document file from your dropbox account.
|
||||
|
||||
### Entering Template Details
|
||||
|
||||
- **[3] Title** *(Required)*: Provide a title for your template. For example, "Demo Custom Template."
|
||||
- **[4] Description**: Optionally add a description to give context or instructions regarding the template.
|
||||
- **[5] Note**: Optionally add a note to give context or instructions regarding the document.
|
||||
|
||||
### Set the sending order
|
||||
- **[6] Send in Order**
|
||||
- **If you choose:**
|
||||
- **Yes**: Selecting this option will send the signing request to the first signer initially. Once the first signer completes their part, the next signer in the sequence will receive the request. This process continues until all signers have signed the document. This method ensures that the document is signed in a specific order.
|
||||
- **No**: Selecting this option will send the signing links to all signers simultaneously. Every signer can sign the document at their convenience, regardless of whether other signers have completed their signatures. This method is faster but does not enforce any signing order among the participants.
|
||||
Select the option that best suits the needs of your document processing.
|
||||
### Auto reminder (feature only avilable for the subscribed user)
|
||||
- **[7]** Once you enable the auto reminder, a text field will appear allowing you to set the reminder for a specific number of days.
|
||||
- **Remind once in every (Days)**: Here, you can set the number of days for the reminder.
|
||||
### Security Setting
|
||||
- **[8] Enable OTP Verfication** :
|
||||
If set to "Yes," the signer will be required to complete email OTP verification before viewing and signing the document. If "Enable OTP Verification" is set to "No," the signer will not be prompted for OTP verification during the signing process.
|
||||
|
||||
- **[9] Enable tour**:
|
||||
If set to "Yes," the signer will see the tour guide while signing the document. If your signer is familiar with OpenSign and you prefer not to display the tour guide, you can select "No," and the tour guide will not be shown to your signers.
|
||||
|
||||
### Proceed to Template Creation Panel
|
||||
- **Next**: Click the "Next" button to proceed to the next stage of template creation, where you can add widgets and finalize the template.
|
||||
- **Cancel**: If you need to start over or make changes, click Cancel button to clear the form.
|
||||
## Step 2:
|
||||
### Template creation
|
||||
|
||||
<img width="828" alt="Create Template" src="https://github.com/user-attachments/assets/986a0068-e711-4367-91b6-349dc1db8c43" />
|
||||
|
||||
- **[1] Define Roles**:
|
||||
- **Add Roles**: In the roles section on the right, click "+ Add role" to specify the roles involved in the document, such as Candidate, HR, and Manager.
|
||||
- **[2] Assign Widgets to Roles**: Click on each role to highlight it, then drag and drop the widget to assign it to that role.
|
||||
- **[1] Assign signature widget**: Select the Role from the right side panel, click on the signature widget, and position it where the signature is required. You can place multiple signature widgets for each Role, as required.
|
||||
|
||||
After placing the Signature widget, you will see the options on the widget such as:
|
||||
- **Add Signer/Change Signer**: Clicking the first icon on the signature widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
|
||||
- **Copy Signature**: Clicking on this option reveals the following choices.
|
||||
- All pages: It will copy the signature widget to all pages.
|
||||
- All pages but last: It will copy the signature widget to all pages except the last page.
|
||||
- All pages but first: It will copy the signature widget to all pages except the first page.
|
||||
|
||||
- **[2] Add other widgets**: Depending on your needs, you can include additional widgets such as:
|
||||
- **Stamp**: After placing the Stamp widget, you will see the options on the widget such as:
|
||||
- Setting icon: By clicking on the option, you can specify whether this widget is mandatory or optional during the document signing.
|
||||
- Add Signer/Change Signer: Clicking the second option on the stamp widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
|
||||
- Copy Stamp: Clicking on this option reveals the following choices.
|
||||
- All pages : It will copy the stamp widget to all pages.
|
||||
- All pages but last: It will copy the stamp widget to all pages except the last page.
|
||||
- All pages but first: It will copy the stamp widget to all pages except the first page.
|
||||
- **Initials**: After placing the Initials widget, you will see the options on the widget such as:
|
||||
- Setting icon: By clicking on the option, you can specify whether this widget is mandatory or optional during the document signing.
|
||||
- Add Signer/Change Signer: Clicking the first icon on the Initials widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
|
||||
- Copy Initials: Clicking on this option reveals the following choices.
|
||||
- All pages : It will copy the stamp widget to all pages.
|
||||
- All pages but last: It will copy the stamp widget to all pages except the last page.
|
||||
- All pages but first: It will copy the stamp widget to all pages except the first page.
|
||||
- **Name**: After placing the name widget, you will see the options on the widget such as:
|
||||
- Setting icon: By clicking on the option, you can set the color and font.
|
||||
- Add Signer/Change Signer: Clicking the first icon on the Name widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
|
||||
- Copy : Clicking on this you can ducplicate the name widget.
|
||||
- **Job title**: After placing the job title widget, you will see the options on the widget such as:
|
||||
- Setting icon: By clicking on the option, you can set the color and font.
|
||||
- Add Signer/Change Signer: Clicking the first icon on the Job title widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
|
||||
- Copy : Clicking on this you can ducplicate the job title widget.
|
||||
|
||||
- **Company**: After placing the company widget, you will see the options on the widget such as:
|
||||
- Setting icon: By clicking on the option, you can set the color and font.
|
||||
- Add Signer/Change Signer: Clicking the first icon on the Company widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
|
||||
- Copy : Clicking on this you can ducplicate the Company widget.
|
||||
- **Date**: After placing the date widget, you will see the options on the widget such as:
|
||||
- Setting icon: By clicking on the option, you can choose from various date formats.
|
||||
- Add Signer/Change Signer: Clicking the first icon on the Date widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
|
||||
- Copy : Clicking on this you can ducplicate the date widget.
|
||||
- **Text**: After placing the Text widget, you will see the options on the widget such as:
|
||||
- Setting icon: By clicking on the option, you can set the color and font.
|
||||
- Copy : Clicking on this you can ducplicate the Text widget.
|
||||
|
||||
- **Text Input**: After placing the Text Input widget, you will see the options on the widget such as:
|
||||
- Setting icon: By clicking on the option, you can set the color and font.
|
||||
- Add Signer/Change Signer: Clicking the first icon on the Text Input widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
|
||||
- Copy : Clicking on this you can ducplicate the Text Input widget.
|
||||
- **Checkbox**: Once you drop the checkbox widget, a popup will open where you can set the checkbox name and options. Additionally, there is few optiona available like you can set Minimum check, maximum check also whether this check box is readonly also hide label option.
|
||||
- Add Signer/Change Signer: Clicking the first icon on the CheckBox widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
|
||||
- Copy : Clicking on this you can ducplicate the image widget.
|
||||
- **Dropdown**: Once you drop the dropdown widget, a popup will open where you can set the dropdown name and options. Additionally, there is few option available like you can set default value, also whether this dropdown is required or optional.
|
||||
- Add Signer/Change Signer: Clicking the first icon on the Dropdown widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
|
||||
- Copy : Clicking on this you can ducplicate the image widget.
|
||||
- **Radio button**: Once you drop the radio button widget, a popup will open where you can set the radio button name and options. Additionally, there is few option available like you can set default value, also whether this radio button is readonly also hide label option.
|
||||
- Add Signer/Change Signer: Clicking the first icon on the Radio button widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
|
||||
- Copy : Clicking on this you can ducplicate the image widget.
|
||||
- **Image**: After placing the Image widget, you will see the options on the widget such as:
|
||||
- Setting icon: By clicking on the option, you can specify whether this widget is mandatory or optional during the document signing.
|
||||
- Add Signer/Change Signer: Clicking the first icon on the Image widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
|
||||
- Copy : Clicking on this you can ducplicate the image widget.
|
||||
- **Email**: After placing the email widget, you will see the options on the widget such as:
|
||||
- Setting icon: By clicking on the option, you can set the color and font.
|
||||
- Add Signer/Change Signer: Clicking the first icon on the Email widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
|
||||
- Copy : Clicking on this you can duplicate the email widget.
|
||||
|
||||
### Save Template
|
||||
**Next button**: Once you’ve organized your widgets and set their properties, simply click the “Next” button to save your template.
|
||||
|
||||
After doing so, a “Create document” popup will appear, prompting you with the question: “Do you want to create a document using the template you just created?” You’ll have the option to choose either “Yes” or “No.”
|
||||
|
||||
**If you select "Yes"**: It will create a document using the template you just created.
|
||||
|
||||
**If you select "No"**: You will be redirected to the Manage templates form.
|
||||
|
||||
## Step 3:
|
||||
### Viewing and Managing Templates
|
||||
|
||||
<img width="828" alt="Manage Template" src="https://github.com/user-attachments/assets/06b80221-5c42-451c-af03-44cc12e6aa2d" />
|
||||
|
||||
On the Manage templates page you will see a list of templates you have created or have access to. The list includes details such as the template title, file, owner, signers, and whether the template is public.
|
||||
|
||||
**Download Template**: If you need to download the template file, click on the "Download" link under the "File" column next to the respective template.
|
||||
|
||||
**View Signers**: This will display the roles or the list of signers along with their assigned roles, if assigned during template creation.
|
||||
|
||||
**Public/Private Toggle**: You can set your template to public or private by toggling the switch under the "Public" column. Public templates can be accessed by anyone via the public URL, allowing them to open and sign the document after registering.
|
||||
|
||||
**Use Template**: To use a template, click the "+ USE" button next to the desired template. This will open the template, enabling you to create a document for a signature request. Simply assign the signers and send it for signatures.
|
||||
|
||||
**Quick Send**: For faster processing, the Quick Send feature allows you to swiftly create and send a document to a signer using the selected template.
|
||||
|
||||
**Edit**: The "Edit" feature is crucial for keeping your document templates up-to-date and relevant. Whether you need to make minor tweaks or major changes, OpenSign's editing capabilities are user-friendly and efficient.
|
||||
Click on the three dots next to the template you want to edit.
|
||||
Select "Edit." Make the necessary changes and save them.
|
||||
|
||||
**Share With Team**: Collaboration is essential for any successful team, and OpenSign simplifies sharing document templates with your team. Here's how you can utilize the "Share With Team" feature:
|
||||
Click on the three dots next to the template you want to share.
|
||||
Select "Share With Team."
|
||||
|
||||
**Embed**: The "Embed" option provides you with a code to embed the template into a website or other platforms, allowing users to interact with it directly from the external site.
|
||||
Click "Embed" to generate the code that can be copied and pasted into your desired web location. We currently support React, HTML/JavaScript and Angular-based websites.
|
||||
|
||||
<img width="828" alt="Embed" src="https://github.com/user-attachments/assets/05dcaf5d-07b0-4069-bcd5-83e2daf71e29" />
|
||||
|
||||
**Copy template id**: This action copies the unique ID associated with the template, which is useful for embedding or sharing with public users when your template is set to public.
|
||||
|
||||
**Copy public URL**: This generates a public link for the template, allowing external users to access it without logging into OpenSign.
|
||||
Click "Copy Public URL" to generate the link, then share it as needed.
|
||||
|
||||
**Delete**: Sometimes, it's necessary to clean up your templates to keep your workspace organized. The "Delete" feature allows you to remove outdated or unnecessary templates with ease.
|
||||
Click on the three dots next to the template you want to delete.
|
||||
Select "Delete." Confirm the deletion.
|
||||
|
||||
## Additional Information
|
||||
- The fields with an asterisk (*) are mandatory.
|
||||
- Make sure your document is in PDF, PNG, JPG, JPEG, or DOCX format.
|
||||
- You can access your signed documents in the folder you've selected by visiting OpenSign™ Drive anytime. You can also access the documents from reports section.
|
||||
|
||||
If you require more help, feel free to reach out to our customer support on support@opensignlabs.com.
|
||||
|
||||
Happy signing with OpenSign™!
|
||||
@@ -0,0 +1,138 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
title: Embedding OpenSign templates
|
||||
---
|
||||
import ReactPlayer from 'react-player';
|
||||
|
||||
# What is OpenSign Template Embedding?
|
||||
OpenSign Template Embedding allows users to seamlessly integrate public document templates into their websites or applications. By embedding templates, you can provide a direct and interactive signing experience for your users without requiring them to leave your platform. This feature supports various technologies like React, Next.js, HTML, JavaScript, and Angular, making it easy to add signing capabilities to different web projects.
|
||||
With OpenSign Template Embedding, businesses can offer a streamlined and professional document signing process, enhancing user experience and workflow efficiency.
|
||||
|
||||
## How to set up a Public profile, Design templates, and Embed a template?
|
||||
|
||||
### Step 1: Set up your Public profile (Username & Tagline)
|
||||
|
||||
- **Navigate to your profile**: On the top right, click your profile icon, select "Edit profile," and enter a public username (e.g., "OpenSignPublicProfile").
|
||||
- **Add a tagline**(Optional): Enter a custom tagline (e.g., "Seal the deal openly") and save the changes.
|
||||
|
||||
<img width="828" alt="Set up Public Profile" src="https://github.com/user-attachments/assets/6c9cbd4b-eb1a-4a5b-bb0a-21777621555c" />
|
||||
|
||||
### Step 2: Create a new template
|
||||
|
||||
- **Navigate to Templates**: On the left sidebar, click "Templates" and select "Create template."
|
||||
|
||||
<img width="828" alt="Create Template" src="https://github.com/user-attachments/assets/95ee5c26-4284-46aa-9de7-3f492ad34feb" />
|
||||
|
||||
### Upload your document and fill in the template details:
|
||||
|
||||
- **[1] Choose file**: Select the document to upload (supported formats: PDF, PNG, JPG, JPEG, DOCX).
|
||||
- **[2] Choose file from Dropbox**: Click the dropbox icon to select the document file from your dropbox account.
|
||||
- **[3] Title** *(Required)*: Provide a title for your template.
|
||||
- **[4] Description**: Optionally add a description to give context or instructions regarding the template.
|
||||
- **[5] Note**: Add additional notes or instructions.
|
||||
- **[6] Send in Order**: Choose "Yes" or "No" for sending in a specific order.
|
||||
- **[7] Auto reminder**: Set up automatic email reminders for signers.
|
||||
- **[8] Enable OTP verification** : Choose "Yes" or "No" for requiring email verification via OTP.
|
||||
- **[9] Enable tour**: Select "Yes" or "No" for enabling the tour feature.
|
||||
|
||||
### Proceed to template creation panel
|
||||
- **Next**: Click the "Next" button to proceed to the next stage of template creation, where you can add widgets and finalize the template.
|
||||
- **Cancel**: If you need to start over or make changes, click Cancel button to clear the form.
|
||||
|
||||
### Step 3: Template creation
|
||||
|
||||
<img width="828" alt="Create Template" src="https://github.com/user-attachments/assets/36a269fb-179b-462e-abc0-f436ec195a4a" />
|
||||
|
||||
- **[1] Define roles**:
|
||||
- **Add Roles**: In the roles section on the right, click "+ Add role" to specify the roles involved in the document, such as Candidate, HR, and Manager.
|
||||
|
||||
**Note**: Make sure the public role is positioned at the top if 'Send in Order' is set to Yes; Otherwise, you will not be able to make the template public.
|
||||
|
||||
- **[2] Assign widgets to roles**: Click on each role to highlight it, then drag and drop the widget to assign it to that role. The widgets will appear in the same colour as the role name once you drop it on the document.
|
||||
- **[1] Assign signature widget**: Select the Role from the right side panel, click on the signature widget, and position it where the signature is required. You can place multiple signature widgets for each Role, as required.
|
||||
- **[2] Add other widgets**: Depending on your needs, you can include additional widgets such as:
|
||||
Stamps, Initials, Name, Date, Text, Checkbox, and more.
|
||||
|
||||
**Important**: Before proceeding, ensure that all roles have assigned signers, except for the public role, since we are making this template public.
|
||||
|
||||
### Save template
|
||||
- **Next button**: Once you’ve organized your widgets and set their properties, simply click the “Next” button to save your template.
|
||||
|
||||
- After doing so, a “Create document” popup will appear, prompting you with the question: “Do you want to create a document using the template you just created?” You’ll have the option to choose either “Yes” or “No.”
|
||||
|
||||
- Choose "No" you will be redirected to the Manage templates screen.
|
||||
|
||||
### Step 4: Managing and Embedding the template
|
||||
|
||||
<img width="828" alt="Manage Template" src="https://github.com/user-attachments/assets/4fd68285-d489-4998-bcf1-1cf40eada723" />
|
||||
|
||||
On the Manage templates page, you'll see a list of templates you've created or have access to. This list provides details such as the template title, file, owner, signers, and whether the template is public.
|
||||
|
||||
- To embed a template, you first need to make it public by clicking the toggle button in the public column of the template.
|
||||
|
||||
- A confirmation popup will appear with the message, 'Are you sure you want to make this template public?' You can choose either Yes or No. Select Yes to make the template public.
|
||||
|
||||
- A public profile popup will appear, displaying the code to embed the template.
|
||||
|
||||
- We support embedding the template in React/Next.js, HTML/JavaScript, and Angular application.
|
||||
|
||||
After making the template public, you’ll have an additional option to view the template embedding code.
|
||||
To access it:
|
||||
|
||||
- Click on the three dots (options menu) next to the template.
|
||||
|
||||
- Select the Embed option from the dropdown menu.
|
||||
|
||||
**Embed the template in a React or Next.js application**
|
||||
- Copy the code and paste it into your React or Next.js application.
|
||||
- Install the required OpenSign dependencies and run your project.
|
||||
|
||||
Watch the video below to see how to embed the template in a React or Next.js application.
|
||||
|
||||
<div>
|
||||
<ReactPlayer playing={false} controls url='https://youtu.be/W5tCPVNVNvg?si=IE0k33Gwzt3pwdxF' />
|
||||
</div>
|
||||
|
||||
**Embed the template in an HTML or JavaScript project**
|
||||
- Copy the code and paste it into your HTML or JavaScript application.
|
||||
|
||||
Watch the video below to see how to embed the template in HTML or JavaScript application.
|
||||
|
||||
<div>
|
||||
<ReactPlayer playing={false} controls url='https://youtu.be/0CXZGRiGIjw?si=MqGkTZ1uz-2F-5Qn' />
|
||||
</div>
|
||||
|
||||
**Embed the template in an Angular project**
|
||||
- Copy the code and paste it into your an Angular application.
|
||||
- Install the required OpenSign dependencies and run your project.
|
||||
|
||||
Watch the video below to see how to embed the template in an Angular application.
|
||||
|
||||
<div>
|
||||
<ReactPlayer playing={false} controls url='https://youtu.be/3zz5flzql8M?si=2TgnLgjd0laCX3fu' />
|
||||
</div>
|
||||
|
||||
### Step 5: Sign the document through the Embed public template.
|
||||
|
||||
- Once the document loads, click Sign Now in the top right corner. A popup will appear asking for signer details such as Name, Email, and Phone Number.
|
||||
|
||||
- Enter the required details and click Submit.
|
||||
|
||||
- You can now fill in the necessary fields within the document's widgets and sign it.
|
||||
|
||||
- After you finish signing, the document will be completed and automatically sent to the next signer for their signature.
|
||||
|
||||
### Step 6: Print document, Download completion certificate, and Download Document
|
||||
|
||||
You’ll see options to Print or Download the signed document for your records.
|
||||
|
||||
If you are the only signer, the signing process is finished, and you will have the options to Print document, Download completion certificate, and Download document.
|
||||
|
||||
|
||||
## Additional Information
|
||||
- All fields marked with an asterisk (*) must be completed before the document can be submitted.
|
||||
- Ensure that the document format is supported by OpenSign before uploading.
|
||||
|
||||
If you require more help, feel free to reach out to our customer support on support@opensignlabs.com.
|
||||
|
||||
Happy signing with OpenSign™!write
|
||||
@@ -0,0 +1,104 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
title: Setting up an OpenSign template for public signing
|
||||
---
|
||||
|
||||
# What is the OpenSign Public profile?
|
||||
|
||||
The OpenSign Public profile feature offers the ultimate public document signing solution without any need for integrations. With this feature, users can share document templates publicly, allowing anyone to access and sign the documents directly through the shared templates. This streamlines the signing process by providing a seamless, accessible way for public signers to complete documents without additional steps or integrations.
|
||||
|
||||
## How to setup Public profile, Design templates, and Enable public signing?
|
||||
|
||||
### Step 1: Set up your Public profile (Username & Tagline)
|
||||
|
||||
- **Navigate to your profile**: On the top right, click your profile icon, select "Edit profile," and enter a public username (e.g., "OpenSignPublicProfile").
|
||||
- **Add a tagline**(Optional): Enter a custom tagline (e.g., "Seal the deal openly") and save the changes.
|
||||
|
||||
<img width="828" alt="Set up Public Profile" src="https://github.com/user-attachments/assets/6c9cbd4b-eb1a-4a5b-bb0a-21777621555c" />
|
||||
|
||||
### Step 2: Create a new template
|
||||
|
||||
- **Navigate to Templates**: On the left sidebar, click "Templates" and select "Create template."
|
||||
|
||||
<img width="828" alt="Create Template" src="https://github.com/user-attachments/assets/95ee5c26-4284-46aa-9de7-3f492ad34feb" />
|
||||
|
||||
### Upload your document and fill in the template details:
|
||||
|
||||
- **[1] Choose file**: Select the document to upload (supported formats: PDF, PNG, JPG, JPEG, DOCX).
|
||||
- **[2] Choose file from Dropbox**: Click the dropbox icon to select the document file from your dropbox account.
|
||||
- **[3] Title** *(Required)*: Provide a title for your template.
|
||||
- **[4] Description**: Optionally add a description to give context or instructions regarding the template.
|
||||
- **[5] Note**: Add additional notes or instructions.
|
||||
- **[6] Send in Order**: Choose "Yes" or "No" for sending in a specific order.
|
||||
- **[7] Auto reminder**: Set up automatic email reminders for signers.
|
||||
- **[8] Enable OTP verification** : Choose "Yes" or "No" for requiring email verification via OTP.
|
||||
- **[9] Enable tour**: Select "Yes" or "No" for enabling the tour feature.
|
||||
|
||||
### Proceed to template creation panel
|
||||
- **Next**: Click the "Next" button to proceed to the next stage of template creation, where you can add widgets and finalize the template.
|
||||
- **Cancel**: If you need to start over or make changes, click Cancel button to clear the form.
|
||||
|
||||
### Step 3: Template creation
|
||||
|
||||
<img width="828" alt="Create Template" src="https://github.com/user-attachments/assets/36a269fb-179b-462e-abc0-f436ec195a4a" />
|
||||
|
||||
- **[1] Define roles**:
|
||||
- **Add Roles**: In the roles section on the right, click "+ Add role" to specify the roles involved in the document, such as Candidate, HR, and Manager.
|
||||
|
||||
**Note**: Make sure the public role is positioned at the top if 'Send in Order' is set to Yes; Otherwise, you will not be able to make the template public.
|
||||
|
||||
- **[2] Assign widgets to roles**: Click on each role to highlight it, then drag and drop the widget to assign it to that role. The widgets will appear in the same colour as the role name once you drop it on the document.
|
||||
- **[1] Assign signature widget**: Select the Role from the right side panel, click on the signature widget, and position it where the signature is required. You can place multiple signature widgets for each Role, as required.
|
||||
- **[2] Add other widgets**: Depending on your needs, you can include additional widgets such as:
|
||||
Stamps, Initials, Name, Date, Text, Checkbox, and more.
|
||||
|
||||
**Important**: Before proceeding, ensure that all roles have assigned signers, except for the public role, since we are making this template public.
|
||||
|
||||
### Save template
|
||||
- **Next button**: Once you’ve organized your widgets and set their properties, simply click the “Next” button to save your template.
|
||||
|
||||
- After doing so, a “Create document” popup will appear, prompting you with the question: “Do you want to create a document using the template you just created?” You’ll have the option to choose either “Yes” or “No.”
|
||||
|
||||
- Choose "No" you will be redirected to the Manage templates screen.
|
||||
|
||||
### Step 4: Managing and making template public
|
||||
|
||||
<img width="828" alt="Manage Template" src="https://github.com/user-attachments/assets/4fd68285-d489-4998-bcf1-1cf40eada723" />
|
||||
|
||||
On the Manage templates page, you'll see a list of templates you've created or have access to. This list provides details such as the template title, file, owner, signers, and whether the template is public.
|
||||
|
||||
- To make a template public, click the toggle button in the public column on the template.
|
||||
|
||||
- A confirmation popup will appear with the message, 'Are you sure you want to make this template public?' You can choose either Yes or No. Select Yes to make the template public.
|
||||
|
||||
- A public profile popup will appear, where you can copy the public URL.
|
||||
|
||||
- Copy and share this link, and anyone with it can view your publicly available templates by pasting the URL into their browser.
|
||||
|
||||
<img width="828" alt="Manage Template" src="https://github.com/user-attachments/assets/99977728-86de-4913-8d2e-f54ab0b18033" />
|
||||
|
||||
### Step 5: Sign the document through the public template.
|
||||
|
||||
- Click the Sign now button next to the template you want to sign. Once the document loads, click Sign Now in the top right corner. A popup will appear asking for signer details such as Name, Email, and Phone Number.
|
||||
|
||||
- Enter the required details and click Submit.
|
||||
|
||||
- You can now fill in the necessary fields within the document's widgets and sign it.
|
||||
|
||||
- After you finish signing, the document will be completed and automatically sent to the next signer for their signature.
|
||||
|
||||
<img width="828" alt="Signed the template" src="https://github.com/user-attachments/assets/0c667098-1c79-4c6a-b59f-03d20ac85552" />
|
||||
|
||||
### Step 6: Print document, Download completion certificate, and Download Document
|
||||
|
||||
You’ll see options to Print or Download the signed document for your records.
|
||||
|
||||
If you are the only signer, the signing process is finished, and you will have the options to Print document, Download completion certificate, and Download document.
|
||||
|
||||
## Additional Information
|
||||
- All fields marked with an asterisk (*) must be completed before the document can be submitted.
|
||||
- Ensure that the document format is supported by OpenSign before uploading.
|
||||
|
||||
If you require more help, feel free to reach out to our customer support on support@opensignlabs.com.
|
||||
|
||||
Happy signing with OpenSign™!write
|
||||
@@ -0,0 +1,111 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
title: Quickly Send the Document for Signature Using Template
|
||||
---
|
||||
|
||||
# How to use the OpenSign Quick Send feature to send a document for signature using a template
|
||||
|
||||
### Step 1: Begin New Template Creation
|
||||
|
||||
- **Navigate to New template form**: On the left sidebar, click on "Templates" to expand the menu. and Click on the "Create template" option.
|
||||
|
||||
<img width="828" alt="Create Template" src="https://github.com/user-attachments/assets/fe7b0bd0-bb45-4f64-8450-83ffb5c3d7fc" />
|
||||
|
||||
### Step 2: Uploading Your Document
|
||||
|
||||
- **[1] Choose File**: Once the "New template" page opens, click here to select and upload the document file from your computer that needs to be signed. Supported formats include PDF, PNG, JPG, JPEG, and DOCX.
|
||||
- **[2] Choose File from Dropbox**: Click the dropbox icon to select the document file from your dropbox account.
|
||||
|
||||
### Step 3: Entering Template Details
|
||||
|
||||
- **[3] Title** *(Required)*: Provide a title for your template. For example, "Demo Custom Template."
|
||||
- **[4] Description**: Optionally add a description to give context or instructions regarding the template.
|
||||
- **[5] Note**: Optionally add a note to give context or instructions regarding the document.
|
||||
|
||||
### Step 4: Set the sending order
|
||||
- **[6] Send in Order**
|
||||
- **If you choose:**
|
||||
- **Yes**: Selecting this option will send the signing request to the first signer initially. Once the first signer completes their part, the next signer in the sequence will receive the request. This process continues until all signers have signed the document. This method ensures that the document is signed in a specific order.
|
||||
- **No**: Selecting this option will send the signing links to all signers simultaneously. Every signer can sign the document at their convenience, regardless of whether other signers have completed their signatures. This method is faster but does not enforce any signing order among the participants.
|
||||
Select the option that best suits the needs of your document processing.
|
||||
### Step 5: Auto reminder (feature only avilable for the subscribed user)
|
||||
- **[7]** Once you enable the auto reminder, a text field will appear allowing you to set the reminder for a specific number of days.
|
||||
- **Remind once in every (Days)**: Here, you can set the number of days for the reminder.
|
||||
|
||||
### Step 6: Proceed to Template Creation Panel
|
||||
- **Next**: Click the "Next" button to proceed to the next stage of template creation, where you can add widgets and finalize the template.
|
||||
- **Cancel**: If you need to start over or make changes, click Cancel button to clear the form.
|
||||
### Step 7: Template creation
|
||||
|
||||
<img width="828" alt="Create Template" src="https://github.com/user-attachments/assets/986a0068-e711-4367-91b6-349dc1db8c43" />
|
||||
|
||||
- **[1] Define Roles**:
|
||||
- **Add Roles**: In the roles section on the right, click "+ Add role" to specify the roles involved in the document, such as Candidate, HR, and Manager.
|
||||
- **[2] Assign Widgets to Roles**: Click on each role to highlight it, then drag and drop the widget to assign it to that role.
|
||||
- **[1] Assign signature widget**: Select the Role from the right side panel, click on the signature widget, and position it where the signature is required. You can place multiple signature widgets for each Role, as required.
|
||||
|
||||
After placing the Signature widget, you will see the options on the widget such as:
|
||||
- **Add Signer/Change Signer**: Clicking the first icon on the signature widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
|
||||
- **Copy Signature**: Clicking on this option reveals the following choices.
|
||||
- All pages: It will copy the signature widget to all pages.
|
||||
- All pages but last: It will copy the signature widget to all pages except the last page.
|
||||
- All pages but first: It will copy the signature widget to all pages except the first page.
|
||||
- **[2] Add other widgets**: Depending on your needs, you can include additional widgets such as:
|
||||
Stamps, Initials, Name, Date, Text, Checkbox, and more.
|
||||
|
||||
### Step 8: Save Template
|
||||
**Next button**: Once you’ve organized your widgets and set their properties, simply click the “Next” button to save your template.
|
||||
|
||||
After doing so, a “Create Document” popup will appear, prompting you with the question: “Do you want to create a document using the template you just created?” You’ll have the option to choose either “Yes” or “No.”
|
||||
**If you select "Yes"**: It will create a document using the template you just created.
|
||||
**If you select "No"**: You will be redirected to the Manage templates form.
|
||||
|
||||
### Step 9: Viewing and Managing Templates
|
||||
|
||||
<img width="828" alt="Manage Template" src="https://github.com/user-attachments/assets/86bf3628-987d-4ae2-89c3-b24ec1f6bdc2" />
|
||||
|
||||
On the Manage Templates page, you'll see a list of templates you've created or have access to. This list provides details such as the template title, file, owner, signers, and whether the template is public. You’ll also find actions like "Use Template," "Quick Send," "Edit," "Delete," and more.
|
||||
|
||||
### Step 10: Quick Send
|
||||
For faster processing, the Quick Send feature allows you to swiftly create and send a document to a signer using the selected template.
|
||||
|
||||
<img width="828" alt="Manage Template" src="https://github.com/user-attachments/assets/02334ff3-eab6-4a11-aba2-d95a5cba2935" />
|
||||
|
||||
How to Send the Document:
|
||||
- Click the Quick Send button next to the template in the list.
|
||||
|
||||
- A popup will open where you can assign signers to each role by simply adding their email addresses.
|
||||
|
||||
- If you need to create multiple documents, click the Add New button.
|
||||
|
||||
After adding the signers, click the Send button. This will generate the document and send an email to the signers with a signature request.
|
||||
|
||||
## Signers Signing Process
|
||||
### Step 11: Email OTP verification
|
||||
Once the email is received, the signer can click the 'Sign Here' button. This will open the email verification page. After clicking the 'Get Verification Code' button, an OTP (one-time password) will be sent to the signer’s email address. Enter the received OTP into the verification textbox and click the 'Verify' button.
|
||||
|
||||
<div>
|
||||
<img width="800" alt="OpenSign send OTP" src="https://github.com/user-attachments/assets/b82c796a-98e3-4296-bde1-fe86b1b993ad" />
|
||||
</div>
|
||||
<div>
|
||||
<img width="800" alt="OpenSign verify otp" src="https://github.com/user-attachments/assets/63cf4b75-9d47-4630-a83c-e916a5c13b3c" />
|
||||
</div>
|
||||
|
||||
### Step 12: Finalizing the Process:
|
||||
|
||||
After verification, the signer will be redirected to the document signing page, where he can view the document received for signing. To sign, the signer simply clicks on the signature widget, which allows them to draw, upload a digitally scanned signature, or type the signature.
|
||||
|
||||
After filling out all assigned widgets, click the 'Finish' button. Once the document is finished,.
|
||||
- The signer has the option of downloading or printing the signed document. He will also obtain the completion certificate if he is the final signer.
|
||||
|
||||
- If there are more than one signer, the document will be immediately sent to the next signer. Once all signers have finished their signatures, they can download and print the signed document as well as the completion certificate.
|
||||
<img width="800" alt="OpenSignFinalStep" src="https://github.com/user-attachments/assets/f4783aa0-2879-4ec2-9ddc-16d59f3a1fc0" />
|
||||
|
||||
## Additional Information
|
||||
- All fields marked with an asterisk (*) must be completed before the document can be submitted.
|
||||
- Ensure that the document format is supported by OpenSign before uploading.
|
||||
- Signed documents can be accessed in the designated 'Root' folder or the one you have specified.
|
||||
|
||||
If you require more help, feel free to reach out to our customer support on support@opensignlabs.com.
|
||||
|
||||
Happy signing with OpenSign™!write
|
||||
@@ -0,0 +1,126 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
title: Use template to create documents
|
||||
---
|
||||
# How to use template to create documents in OpenSign™
|
||||
|
||||
### Step 1: Begin New Template Creation
|
||||
|
||||
- **Navigate to New template form**: On the left sidebar, click on "Templates" to expand the menu. and Click on the "Create template" option.
|
||||
|
||||
<img width="828" alt="Create Template" src="https://github.com/user-attachments/assets/fe7b0bd0-bb45-4f64-8450-83ffb5c3d7fc" />
|
||||
|
||||
### Step 2: Uploading Your Document
|
||||
|
||||
- **[1] Choose File**: Once the "New template" page opens, click here to select and upload the document file from your computer that needs to be signed. Supported formats include PDF, PNG, JPG, JPEG, and DOCX.
|
||||
- **[2] Choose File from Dropbox**: Click the dropbox icon to select the document file from your dropbox account.
|
||||
|
||||
### Step 3: Entering Template Details
|
||||
|
||||
- **[3] Title** *(Required)*: Provide a title for your template. For example, "Demo Custom Template."
|
||||
- **[4] Description**: Optionally add a description to give context or instructions regarding the template.
|
||||
- **[5] Note**: Optionally add a note to give context or instructions regarding the document.
|
||||
|
||||
### Step 4: Set the sending order
|
||||
- **[6] Send in Order**
|
||||
- **If you choose:**
|
||||
- **Yes**: Selecting this option will send the signing request to the first signer initially. Once the first signer completes their part, the next signer in the sequence will receive the request. This process continues until all signers have signed the document. This method ensures that the document is signed in a specific order.
|
||||
- **No**: Selecting this option will send the signing links to all signers simultaneously. Every signer can sign the document at their convenience, regardless of whether other signers have completed their signatures. This method is faster but does not enforce any signing order among the participants.
|
||||
Select the option that best suits the needs of your document processing.
|
||||
### Step 5: Auto reminder (feature only avilable for the subscribed user)
|
||||
- **[7]** Once you enable the auto reminder, a text field will appear allowing you to set the reminder for a specific number of days.
|
||||
- **Remind once in every (Days)**: Here, you can set the number of days for the reminder.
|
||||
|
||||
### Step 6: Proceed to Template Creation Panel
|
||||
- **Next**: Click the "Next" button to proceed to the next stage of template creation, where you can add widgets and finalize the template.
|
||||
- **Cancel**: If you need to start over or make changes, click Cancel button to clear the form.
|
||||
### Step 7: Template creation
|
||||
|
||||
<img width="828" alt="Create Template" src="https://github.com/user-attachments/assets/986a0068-e711-4367-91b6-349dc1db8c43" />
|
||||
|
||||
- **[1] Define Roles**:
|
||||
- **Add Roles**: In the roles section on the right, click "+ Add role" to specify the roles involved in the document, such as Candidate, HR, and Manager.
|
||||
- **[2] Assign Widgets to Roles**: Click on each role to highlight it, then drag and drop the widget to assign it to that role.
|
||||
- **[1] Assign signature widget**: Select the Role from the right side panel, click on the signature widget, and position it where the signature is required. You can place multiple signature widgets for each Role, as required.
|
||||
|
||||
After placing the Signature widget, you will see the options on the widget such as:
|
||||
- **Add Signer/Change Signer**: Clicking the first icon on the signature widget allows you to change the signer. You can choose from existing signers in the dropdown or add a new signer.
|
||||
- **Copy Signature**: Clicking on this option reveals the following choices.
|
||||
- All pages: It will copy the signature widget to all pages.
|
||||
- All pages but last: It will copy the signature widget to all pages except the last page.
|
||||
- All pages but first: It will copy the signature widget to all pages except the first page.
|
||||
- **[2] Add other widgets**: Depending on your needs, you can include additional widgets such as:
|
||||
Stamps, Initials, Name, Date, Text, Checkbox, and more.
|
||||
|
||||
### Step 8: Save Template
|
||||
**Next button**: Once you’ve organized your widgets and set their properties, simply click the “Next” button to save your template.
|
||||
|
||||
After doing so, a “Create Document” popup will appear, prompting you with the question: “Do you want to create a document using the template you just created?” You’ll have the option to choose either “Yes” or “No.”
|
||||
- **If you select "Yes"**: It will create a document using the template you just created.
|
||||
- **If you select "No"**: You will be redirected to the Manage templates form.
|
||||
|
||||
### Step 9:
|
||||
**You now have two options to create a document from a template**:
|
||||
- **1) Instant Document Creation with 'Yes' Option**:
|
||||
|
||||
Select the "Yes" option from the popup. This will open the template, enabling you to create a document for a signature request.
|
||||
|
||||
<img width="800" alt="request signatures" src="https://github.com/user-attachments/assets/d9b80b9e-390f-4382-9b81-8b91ec2efeba" />
|
||||
|
||||
- **2) Create Documents via 'Use Template' in Manage Templates**:
|
||||
|
||||
Select the "No" option from the popup, and you'll be redirected to the Manage Templates form. To use a template, click the "+ USE" button next to the desired template. This will open the template and allow you to create a document for a signature request. displaying all the widgets that were set up during template creation.
|
||||
|
||||
<img width="800" alt="request signatures" src="https://github.com/user-attachments/assets/e33f63b4-5b1a-430d-9fae-44a6ea316ba2" />
|
||||
|
||||
You can view all the widgets configured during template creation and also add, remove, or adjust them as needed. Before sending the document for signatures, it's essential to assign signers to each role.
|
||||
|
||||
**Option1**: To assign a signer, simply double-click on any widget corresponding to that role. A popup will appear, allowing you to either select an existing signer or add a new one.
|
||||
|
||||
**Option2**: Every widget includes an option to assign a signer. Clicking the second option on the widget allows you to assign the signer, either by selecting from existing signers in the dropdown or by adding a new signer.
|
||||
|
||||
### Step 10: Next:
|
||||
- **Next**: Once the signers are assigned to all the roles, click the "Next" button. The document will then be created.
|
||||
|
||||
### Step 11: Send Mail
|
||||
After finishing the document creation, a 'Send Mail' popup will appear, offering options to Send Email, Customize Email, Copy Link, or Share the document.
|
||||
- Send Email: Click the 'Send' button to send the document for signing to all signers. If the sending order is set to 'Yes', it will send the document to the first signer.
|
||||
|
||||
- Customize Email: Click the 'Customize Email' button to open the email editor. Here, you can set variables and customize the content. After clicking 'Send', the document will be sent for signing to all signers, or if the sending order is set to 'Yes', it will be sent to the first signer with the customized email.
|
||||
|
||||
- Copy Link: You can copy the link to sign the document.
|
||||
|
||||
- Share: Use this option to share the document via email, WhatsApp and other Windows apps
|
||||
|
||||
<img width="800" alt="request signatures" src="https://github.com/user-attachments/assets/e2344479-daae-43ff-a61a-14ea98b237d6" />
|
||||
|
||||
## Signers Signing Process
|
||||
### Step 12: Email OTP verification
|
||||
Once the email is received, the signer can click the 'Sign Here' button. This will open the email verification page. After clicking the 'Get Verification Code' button, an OTP (one-time password) will be sent to the signer’s email address. Enter the received OTP into the verification textbox and click the 'Verify' button.
|
||||
|
||||
<div>
|
||||
<img width="800" alt="OpenSign send OTP" src="https://github.com/user-attachments/assets/b82c796a-98e3-4296-bde1-fe86b1b993ad" />
|
||||
</div>
|
||||
<div>
|
||||
<img width="800" alt="OpenSign verify otp" src="https://github.com/user-attachments/assets/63cf4b75-9d47-4630-a83c-e916a5c13b3c" />
|
||||
</div>
|
||||
|
||||
### Step 13: Finalizing the Process:
|
||||
|
||||
After verification, the signer will be redirected to the document signing page, where he can view the document received for signing. To sign, the signer simply clicks on the signature widget, which allows them to draw, upload a digitally scanned signature, or type the signature.
|
||||
|
||||
After filling out all assigned widgets, click the 'Finish' button. Once the document is finished,.
|
||||
- The signer has the option of downloading or printing the signed document. He will also obtain the completion certificate if he is the final signer.
|
||||
|
||||
- If there are more than one signer, the document will be immediately sent to the next signer. Once all signers have finished their signatures, they can download and print the signed document as well as the completion certificate.
|
||||
|
||||
<img width="800" alt="OpenSignFinalStep" src="https://github.com/user-attachments/assets/f4783aa0-2879-4ec2-9ddc-16d59f3a1fc0" />
|
||||
|
||||
## Additional Information
|
||||
- All fields marked with an asterisk (*) must be completed before the document can be submitted.
|
||||
- Ensure that the document format is supported by OpenSign before uploading.
|
||||
- Signed documents can be accessed in the designated 'Root' folder or the one you have specified.
|
||||
|
||||
If you require more help, feel free to reach out to our customer support on support@opensignlabs.com.
|
||||
|
||||
Happy signing with OpenSign™!
|
||||
@@ -0,0 +1,18 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
import ReactPlayer from 'react-player';
|
||||
|
||||
# Intro
|
||||
|
||||
🌟Get ready for an electrifying journey at [OpenSign™](https://app.opensignlabs.com), the most incredibly documented open source document signing solution! 🚀 This is your go-to spot for diving deep into everything OpenSign™ has to offer. Whether you’re just starting out or you’re a seasoned pro eager to uncover even more cool features, we’ve got you covered with the most awesome, top-notch guides and resources around. Get ready to make the most out of OpenSign™ 🎉📚🔍 Your adventure in excellence starts here! 🌈✨🌟
|
||||
<div>
|
||||
<ReactPlayer playing controls url='https://www.youtube.com/watch?v=GY_OP697EiU' />
|
||||
</div>
|
||||
## Getting Started
|
||||
|
||||
Try OpenSign on cloud at **[OpenSignLabs](https://app.opensignlabs.com)**.
|
||||
|
||||
Or
|
||||
|
||||
Get started by deploying a new instance of **OpenSign** by following the **[installation guide](https://docs.opensignlabs.com/docs/self-host/intro).**
|
||||
@@ -0,0 +1,47 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Tutorial Intro
|
||||
|
||||
Let's discover **Docusaurus in less than 5 minutes**.
|
||||
|
||||
## Getting Started
|
||||
|
||||
Get started by **creating a new site**.
|
||||
|
||||
Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**.
|
||||
|
||||
### What you'll need
|
||||
|
||||
- [Node.js](https://nodejs.org/en/download/) version 18.0 or above:
|
||||
- When installing Node.js, you are recommended to check all checkboxes related to dependencies.
|
||||
|
||||
## Generate a new site
|
||||
|
||||
Generate a new Docusaurus site using the **classic template**.
|
||||
|
||||
The classic template will automatically be added to your project after you run the command:
|
||||
|
||||
```bash
|
||||
npm init docusaurus@latest my-website classic
|
||||
```
|
||||
|
||||
You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor.
|
||||
|
||||
The command also installs all necessary dependencies you need to run Docusaurus.
|
||||
|
||||
## Start your site
|
||||
|
||||
Run the development server:
|
||||
|
||||
```bash
|
||||
cd my-website
|
||||
npm run start
|
||||
```
|
||||
|
||||
The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there.
|
||||
|
||||
The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/.
|
||||
|
||||
Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes.
|
||||
@@ -0,0 +1,15 @@
|
||||
---
|
||||
title: Digital Ocean
|
||||
---
|
||||
# Digital Ocean
|
||||
|
||||
OpenSign application consistes of 3 components -
|
||||
- ReactJS frontend
|
||||
- NodeJS API
|
||||
- MongoDB database
|
||||
|
||||
You can install all 3 components on digital ocean using the button below -
|
||||
|
||||
[](https://cloud.digitalocean.com/apps/new?repo=https://github.com/OpenSignLabs/Deploy-OpenSign-to-Digital-Ocean/tree/main&refcode=30db1c901ab0)
|
||||
|
||||
**Note:** This button is not intended for production installations because it sets up the OpenSign database within an app platform container that lacks persistent storage. Instead, in the next step, replace the MongoDB connection string with one from a managed MongoDB instance, which you should set up on DigitalOcean.
|
||||
@@ -0,0 +1,8 @@
|
||||
{
|
||||
"label": "One-click Install",
|
||||
"position": 2,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"description": "Start with installing OpenSign in your own cloud infrastructure."
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,7 @@
|
||||
{
|
||||
"label": "Cloud Storage",
|
||||
"position": 3,
|
||||
"link": {
|
||||
"type": "generated-index"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,85 @@
|
||||
---
|
||||
title: AWS S3
|
||||
---
|
||||
## You can create an AWS S3 bucket to store your uploaded documents using OpenSign™
|
||||
|
||||
### AWS S3 -
|
||||
- **Step 1 : Create a S3 bucket**
|
||||
- Login to [AWS console](https://aws.amazon.com/console/)
|
||||
- Navigate to S3 under services.
|
||||

|
||||
- Hit "Create Bucket" button on upper right corner.
|
||||

|
||||
- Now provide bucket name and don't change any other options scroll down and click on "Create Bucket" button.
|
||||

|
||||

|
||||
- Click on name of bucket from list which we have just created.
|
||||
- Now go to permission Tab and scroll down to botton.
|
||||

|
||||
- At the bottom you will see cross-origin resource sharign (cors) section click on "Edit" button.
|
||||

|
||||
- Now paste below line of code and add origin url in AllowedOrigins array and click on "Save changes".
|
||||
```
|
||||
[
|
||||
{
|
||||
"AllowedHeaders": [
|
||||
"*"
|
||||
],
|
||||
"AllowedMethods": [
|
||||
"GET",
|
||||
"PUT",
|
||||
"POST"
|
||||
],
|
||||
"AllowedOrigins": [
|
||||
"https://localhost:3001",
|
||||
"https://app.opensignlabs.com"
|
||||
],
|
||||
"ExposeHeaders": [
|
||||
"x-amz-server-side-encryption",
|
||||
"x-amz-request-id",
|
||||
"x-amz-id-2"
|
||||
],
|
||||
"MaxAgeSeconds": 3000
|
||||
}
|
||||
]
|
||||
```
|
||||
- Once completed, navigate to "Properties," where you'll find the bucket region (e.g., us-east-1).
|
||||
- Set the bucket name you created in step 1 as the value for "DO_SPACE" in the ENV file.
|
||||
- Assign the region value to the "DO_REGION" variable in the ENV file.
|
||||
- Replace the region in the URL s3.region.amazonaws.com and set it as "DO_ENDPOINT" in the ENV file.
|
||||
- Replace both the bucket name and region in the URL https://bucketName.s3.region.amazonaws.com and set it as "DO_BASEURL" in the ENV file.
|
||||
|
||||
- **Step 2 : Create a aws policy**
|
||||
- Navigate to IAM under services
|
||||

|
||||
- Now click on "Polices" from left side "access management" menu.
|
||||
- Hit "Create Policy" button on upper right corner.
|
||||

|
||||
- Search for S3 and Tick "PutObject" and "GetObject" from "Specify permissions" screen.
|
||||

|
||||

|
||||
- Select "All" under Resources
|
||||

|
||||
- provide policy name and hit on 'Create Policy".
|
||||

|
||||
- Step 3 : Create IAM user.
|
||||
- Now click on "Users" from left side "access management" menu and then click on "Create User" button.
|
||||

|
||||
- Provide username and click on Next button.
|
||||
- Now select "Attach policies directly" from Permissions options.
|
||||

|
||||
- Now, search for the policy we created in the previous step within the "Permissions Policies" section.
|
||||

|
||||
- Now scroll down and Click on "Create User" Button.
|
||||
- Step 4 : Generate Credentials
|
||||
- Now Click on username form list which we have created in previous step.
|
||||
- Navigate to "Security credentials".
|
||||
- Click on "Create Access Key" from right corner.
|
||||

|
||||
- In the next step select "Application running outside AWS".
|
||||

|
||||
- In the next step, you will see the "Access key" and "Secret Access key." Copy both values.
|
||||
- Assign the "Access key" value to the "DO_ACCESS_KEY_ID" environment variable.
|
||||
- Assign the "Secret Access key" value to the "DO_SECRET_ACCESS_KEY" environment variable.
|
||||
|
||||
If you encounter any issues while following these instructions, refer to the link below: - https://repost.aws/knowledge-center/create-access-key
|
||||
@@ -0,0 +1,7 @@
|
||||
{
|
||||
"label": "Docker",
|
||||
"position": 2,
|
||||
"link": {
|
||||
"type": "generated-index"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,122 @@
|
||||
---
|
||||
title: Self-host OpenSign™ with Docker on Linux/MacOS/Windows
|
||||
---
|
||||
import ReactPlayer from 'react-player';
|
||||
|
||||
## Steps to run OpenSign™ with docker on Linux/MacOS/Windows:
|
||||
|
||||
### Step 1. Download and Install [Docker](https://www.docker.com/products/docker-desktop/):
|
||||
|
||||
Follow the official Docker installation guide based on your operating system.
|
||||
|
||||
Create a Docker Hub account if you don't already have one.
|
||||
|
||||
**Important:** Don't forget to verify your Docker Hub account via the email verification link. If you skip this step, the deployment might fail due to unauthorized access errors when pulling Docker images.
|
||||
|
||||
### Step 2. Open the terminal and execute the below commands as per your operating system.
|
||||
|
||||
Make sure Docker is running in the background before proceeding.
|
||||
|
||||
**Warning:** The commands below should only be used when installing OpenSign for the first time. You may loose your settings as this will overwrite .env & caddy files.
|
||||
|
||||
### Running on a custom domain
|
||||
Command for linux/MacOS
|
||||
```
|
||||
export HOST_URL=https://opensign.yourdomain.com && curl --remote-name-all https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/docker-compose.yml https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/Caddyfile https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/.env.local_dev && mv .env.local_dev .env.prod && docker compose up --force-recreate
|
||||
```
|
||||
Command for Windows (**Powershell**)
|
||||
```
|
||||
$env:HOST_URL="https://opensign.yourdomain.com"; Invoke-WebRequest -Uri https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/docker-compose.yml -OutFile docker-compose.yml; Invoke-WebRequest -Uri https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/Caddyfile -OutFile Caddyfile; Invoke-WebRequest -Uri https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/.env.local_dev -OutFile .env.local_dev; Rename-Item -Path .env.local_dev -NewName .env.prod; docker compose up --force-recreate
|
||||
```
|
||||
Command for Windows (**CMD/Terminal**)
|
||||
```
|
||||
set HOST_URL=https://opensign.yourdomain.com && curl -O https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/docker-compose.yml && curl -O https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/Caddyfile && curl -O https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/.env.local_dev && rename .env.local_dev .env.prod && docker compose up --force-recreate
|
||||
```
|
||||
|
||||
Copy the command above, paste it into the terminal, and press Enter to pull and start the containers automatically.
|
||||
|
||||
Make sure to replace the host URL with your subdomain where OpenSign will be accessible.
|
||||
|
||||
You will also need to point the subdomain to the server executing these commands by adding the correct A record to your DNS settings.
|
||||
|
||||
### Running locally
|
||||
If instead want to run locally try out below commands.
|
||||
|
||||
Command for linux/MacOS (localhost)
|
||||
```
|
||||
curl --remote-name-all https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/docker-compose.yml https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/Caddyfile https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/.env.local_dev && mv .env.local_dev .env.prod && docker compose up --force-recreate
|
||||
```
|
||||
Command for Windows (**Powershell**) (localhost)
|
||||
```
|
||||
Invoke-WebRequest -Uri https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/docker-compose.yml -OutFile docker-compose.yml; Invoke-WebRequest -Uri https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/Caddyfile -OutFile Caddyfile; Invoke-WebRequest -Uri https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/.env.local_dev -OutFile .env.local_dev; Rename-Item -Path .env.local_dev -NewName .env.prod; docker compose up --force-recreate
|
||||
```
|
||||
Command for Windows (**CMD/Terminal**) (localhost)
|
||||
```
|
||||
curl -O https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/docker-compose.yml && curl -O https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/Caddyfile && curl -O https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/.env.local_dev && rename .env.local_dev .env.prod && docker compose up --force-recreate
|
||||
```
|
||||
|
||||
Once the deployment is successful, the application will be accessible at [https://localhost:3001](https://localhost:3001). You will need to accept Chrome's insecure certificate warning. Follow the steps in the screenshots to proceed.
|
||||
<div>
|
||||
<img width="700" alt="localhost" src="https://github.com/user-attachments/assets/f5de1882-64d0-44ea-86e3-3a7c8405272c"/>
|
||||
</div>
|
||||
|
||||
<div>
|
||||
<img width="700" alt="proceedtolocalhost" src="https://github.com/user-attachments/assets/33f975b9-4a9a-431e-a869-72e38f3b6754"/>
|
||||
</div>
|
||||
|
||||
**Note:** If you wish to incorporate our latest features into your Docker container, follow the [Upgrade Deployment](https://docs.opensignlabs.com/docs/self-host/docker/upgrade-deployment) steps.
|
||||
|
||||
## Information About ENV variables which are used to setup OpenSign™ with Docker on Localhost
|
||||
To set up OpenSign™ locally using Docker, the following prerequisites are required:
|
||||
|
||||
Add below Environment Varaibles to the ".env.prod" file that is automatically created in order to personalize your installation:
|
||||
|
||||
| Environment Varibale | Value | Description |
|
||||
| ------------- | ------------- | ------------- |
|
||||
| PUBLIC_URL | https://localhost:3001 or https://opensign.yourdomain.com | Set it to the URL form where the app home page will be accessed |
|
||||
| APP_ID | opensign | A 12 character long random app identifier. The value of this should be same as REACT_APP_APPID which is a variable used by Frontend React App. |
|
||||
| MASTER_KEY | XnAadwKxxByMr | A 12 character long random secret key that allows access to all the data. It is used in Parse dashboard config to view all the data in the database. |
|
||||
| MONGODB_URI | mongodb://mongo-container:27017/OpenSignDB | Mongodb URI to connect to |
|
||||
| PARSE_MOUNT | /app | Path on which APIs should be mounted. Do not change this. This variable shall be removed & value hardcoded in the source code in coming versions. |
|
||||
| SERVER_URL | http://localhost:8080/app | Set it to the URL from where APIs will be accessible to the NodeJS functions, for local development it should be localhost:8080/app|
|
||||
| DO_SPACE | DOSPACENAME | Digital ocean space name or AWS S3 bucket name for uploading documents |
|
||||
| DO_ENDPOINT | ams3.digitaloceanspaces.com | Digital ocean spaces endpoint or AWS S3 endpoint for uploading documents |
|
||||
| DO_BASEURL | https://dospace.ams3.digitaloceanspaces.com | Digital ocean baseurl or AWS S3 base URL |
|
||||
| DO_ACCESS_KEY_ID | YOUR_S3_ACCESS_ID | Digital ocean spaces access key ID or AWS s3 Access key ID for uploading the docs |
|
||||
| DO_SECRET_ACCESS_KEY | YOUR_S3_ACCESS_KEY | Digital ocean spaces secret access key or AWS s3 secret access key for uploading the docs |
|
||||
| DO_REGION | YOUR_S3_REGION | Digital ocean spaces region or AWS s3 region |
|
||||
| USE_LOCAL | true | If this is set to true, local file storage will be used to save files, and DO credentials will be ignored. |
|
||||
| MAILGUN_API_KEY | YOUR_MAILGUNAPI_KEY | Mailgun API Key |
|
||||
| MAILGUN_DOMAIN | YOUR_MAILGUNAPI_DOMAIN | Mailgun API Domain |
|
||||
| MAILGUN_SENDER | - | Mailgun Sender Mail ID |
|
||||
| SMTP_ENABLE | false | If this is set to true, emails will be sent through SMTP, and Mailgun credentials will be ignored.
|
||||
| SMTP_HOST | smtp.yourhost.com | Provide smtp host
|
||||
| SMTP_PORT | 443 | Provide smtp port number
|
||||
| SMTP_USER_EMAIL | mailer@yourdomain.com | Provide user email of smtp
|
||||
| SMTP_PASS | password | Provide smtp password
|
||||
| PFX_BASE64 | - | Base64 encoded PFX or p12 document signing certificate file. You can generate base64 encoded self sign certificate using the passphrase. |
|
||||
| PASS_PHRASE | opensign | Pass phrase of PFX or p12 document signing certificate file.|
|
||||
|
||||
# Steps to Generate Self Sign Certificate
|
||||
```
|
||||
# execute below command and use passphrase 'opensign'
|
||||
openssl genrsa -des3 -out ./local_dev.key 2048
|
||||
openssl req -key ./local_dev.key -new -x509 -days 365 -out ./local_dev.crt
|
||||
openssl pkcs12 -inkey ./local_dev.key -in ./local_dev.crt -export -out ./local_dev.pfx
|
||||
openssl base64 -in ./local_dev.pfx -out ./base64_pfx
|
||||
```
|
||||
Please note that when signing a document using a certificate generated through this process, it won’t be recognized as valid by Adobe Acrobat. To get the green tick on your signed documents, you'll need to purchase a document signing certificate (a p12 certificate in pfx format) from an [AATL-approved Certificate Authority](https://helpx.adobe.com/in/acrobat/kb/approved-trust-list1.html).
|
||||
|
||||
# CORS Configuration
|
||||
|
||||
As document storage is delegated to S3-compatible services that reside in a different host than the OpenSign one, document operations (loading, storing, deleting) are subject to [Cross-Origin Resource Sharing](https://en.wikipedia.org/wiki/Cross-origin_resource_sharing) restriction policies; as a consequence, OpenSign app may fail with (browser console) errors like the following:
|
||||
```
|
||||
Access to fetch at 'https://foo.nyc3.digitaloceanspaces.com/exported_file_4627_0000-00-00T00%3A45%3A43.344Z.pdf'
|
||||
from origin 'http://localhost:3000' has been blocked by CORS policy: No 'Access-Control-Allow-Origin' header
|
||||
is present on the requested resource. If an opaque response serves your needs, set the request's mode to
|
||||
'no-cors' to fetch the resource with CORS disabled.
|
||||
```
|
||||
|
||||
In order to address this, your document storage system must be instructed to accept requests from other hosts; below the relevant documentation links:
|
||||
- [How to Configure CORS on DigitalOcean Spaces](https://docs.digitalocean.com/products/spaces/how-to/configure-cors/)
|
||||
- [Configuring cross-origin resource sharing on AWS S3](https://docs.aws.amazon.com/AmazonS3/latest/userguide/enabling-cors-examples.html)
|
||||
@@ -0,0 +1,68 @@
|
||||
---
|
||||
title: OpenSign™ Self-Hosted 'Upgrade Deployment' Guide Using Docker on Linux, macOS, or Windows
|
||||
---
|
||||
import ReactPlayer from 'react-player';
|
||||
|
||||
This guide provides step-by-step instructions to upgrade the deployment of OpenSign using Docker.
|
||||
|
||||
### Step 1: Open the Terminal
|
||||
- **Windows:** Press Win + X and select Windows PowerShell or Windows Terminal from the menu.
|
||||
- **macOS:** Go to Applications > Utilities > Terminal or search for "Terminal" using Spotlight (Cmd + Space).
|
||||
- **Linux:** Open the terminal from the application menu or by pressing Ctrl + Alt + T.
|
||||
|
||||
### Step 2: Pull the Latest Docker Images
|
||||
1) Before executing the commands below, make sure Docker is running on your machine.
|
||||
2) Ensure that you are in the same directory where you executed the `build` or `compose` Docker command.
|
||||
|
||||
Run the following command to pull the latest OpenSign Docker images:
|
||||
|
||||
**Note:** If you've made any custom changes to your docker-compose.yml file, they will be lost when running the command below. This command is intended only for those who haven't made any custom modifications to their docker-compose.yml file.
|
||||
|
||||
**linux/MacOS**
|
||||
```
|
||||
curl --remote-name-all https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/docker-compose.yml && docker compose pull
|
||||
```
|
||||
**Windows** (Powershell)
|
||||
```
|
||||
Invoke-WebRequest -Uri https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/docker-compose.yml -OutFile docker-compose.yml; docker compose pull
|
||||
```
|
||||
**Windows** (Command Prompt)
|
||||
```
|
||||
curl -O https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/docker-compose.yml && docker compose pull
|
||||
```
|
||||
- This command will fetch the most recent versions of the Docker images required by OpenSign.
|
||||
- Wait for the pulling process to complete. You should see messages indicating the progress and completion of the download.
|
||||
|
||||
<img width="550" alt="Pulling completed" src="https://github.com/user-attachments/assets/1b708b04-e6e6-45a0-9625-94e420a68343" />
|
||||
|
||||
### Step 3: Start the Updated OpenSign Deployment
|
||||
After the images have been successfully pulled, run the following command to start the updated OpenSign deployment:
|
||||
```
|
||||
docker compose up
|
||||
```
|
||||
- This command will recreate and start all the necessary containers with the updated images.
|
||||
- You should see logs indicating that the containers are being created or updated, and eventually, that they are up and running.
|
||||
|
||||
### Running Docker Compose in Detached Mode
|
||||
|
||||
To start your Docker Compose services in detached mode (running in the background), use the following command:
|
||||
|
||||
```
|
||||
docker-compose up -d
|
||||
```
|
||||
**Explanation:**
|
||||
- docker-compose up: This command starts the services defined in your docker-compose.yml file.
|
||||
- -d: The detached mode flag, which runs the containers in the background and frees up your terminal.
|
||||
|
||||
<img width="550" alt="Docker compose up" src="https://github.com/user-attachments/assets/c573baaf-f70d-468e-a531-75b85a275647" />
|
||||
|
||||
## Note:
|
||||
- The docker compose pull command ensures that you have the latest version of the Docker images, while the docker compose up command applies any updates and starts the containers.
|
||||
|
||||
## Troubleshooting:
|
||||
- If you encounter any errors, check Docker logs by running docker compose logs to get more details.
|
||||
- Verify that your environment variables and Docker configuration files are set correctly.
|
||||
|
||||
If you require more help, feel free to reach out to our customer support on support@opensignlabs.com.
|
||||
|
||||
For instant help and support, **[join our Discord community!](https://discord.com/invite/xe9TDuyAyj)**
|
||||
@@ -0,0 +1,7 @@
|
||||
{
|
||||
"label": "Guides",
|
||||
"position": 4,
|
||||
"link": {
|
||||
"type": "generated-index"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,42 @@
|
||||
---
|
||||
title: ENV variables which are used to setup OpenSign™ with Docker on Localhost
|
||||
---
|
||||
|
||||
## Information About ENV variables which are used to setup OpenSign™ with Docker on Localhost
|
||||
To set up OpenSign™ locally using Docker, the following prerequisites are required:
|
||||
|
||||
Environment Varaibles:
|
||||
|
||||
| Environment Varibale | Value | Description |
|
||||
| ------------- | ------------- | ------------- |
|
||||
| PUBLIC_URL | http://localhost:3000 | Set it to the URL form where the app home page will be accessed |
|
||||
| GENERATE_SOURCEMAP | false | Set it to true if you want to generate the Sourcemap for debugging |
|
||||
| REACT_APP_SERVERURL | http://localhost:8080/app | Set it to the URL from where APIs will be accessible, for local development it should be localhost:8080/app (use your local port number instead) |
|
||||
| REACT_APP_APPID | opensignstgn | A 12 character long random app identifier. The value of this should be same as APP_ID which is a variable used by backend API. |
|
||||
| APP_ID | opensignstgn | A 12 character long random app identifier. The value of this should be same as REACT_APP_APPID which is a variable used by Frontend React App. |
|
||||
| appName | open_sign_server | Name of the app. It will be visible in the verification emails sent out. |
|
||||
| MASTER_KEY | XnAadwKxxByMr | A 12 character long random secret key that allows access to all the data. It is used in Parse dashboard config to view all the data in the database. |
|
||||
| MONGODB_URI | mongodb://host.docker.internal:27017/OpenSignDB | Mongodb URI to connect to |
|
||||
| PARSE_MOUNT |/app | Path on which APIs should be mounted. Do not change this. This variable shall be removed & value hardcoded in the source code in coming versions. |
|
||||
| SERVER_URL | http://localhost:8080/app | Set it to the URL from where APIs will be accessible to the NodeJS functions, for local development it should be localhost:8080/app (use your local port number instead) |
|
||||
| DO_SPACE | DOSPACENAME | Digital ocean space name or AWS S3 bucket name for uploading documents |
|
||||
| DO_ENDPOINT | ams3.digitaloceanspaces.com | Digital ocean spaces endpoint or AWS S3 endpoint for uploading documents |
|
||||
| DO_BASEURL |https://DOSPACENAME.ams3.digitaloceanspaces.com | Digital ocean baseurl or AWS S3 base URL |
|
||||
| DO_ACCESS_KEY_ID | YOUR_S3_ACCESS_ID | Digital ocean spaces access key ID or AWS s3 Access key ID for uploading the docs |
|
||||
| DO_SECRET_ACCESS_KEY | YOUR_S3_ACCESS_KEY | Digital ocean spaces secret access key or AWS s3 secret access key for uploading the docs |
|
||||
| DO_REGION | YOUR_S3_REGION | Digital ocean spaces region or AWS s3 region |
|
||||
| USE_LOCAL | FALSE | To use local file storage to save file |
|
||||
| MAILGUN_API_KEY | YOUR_MAILGUNAPI_KEY | Mailgun API Key |
|
||||
| MAILGUN_DOMAIN | YOUR_MAILGUNAPI_DOMAIN | Mailgun API Domain |
|
||||
| MAILGUN_SENDER | - | Mailgun Sender Mail ID |
|
||||
| PFX_BASE64 | - | Base64 encoded PFX or p12 document signing certificate file. You can generate base64 encoded self sign certificate using the passphrase. |
|
||||
| PASS_PHRASE | opensign | Pass phrase of PFX or p12 document signing certificate file.|
|
||||
|
||||
# Steps to generate self-signed document singing certificate
|
||||
```
|
||||
# execute below command and use passphrase 'opensign'
|
||||
openssl genrsa -des3 -out ./local_dev.key 2048
|
||||
openssl req -key ./local_dev.key -new -x509 -days 365 -out ./local_dev.crt
|
||||
openssl pkcs12 -inkey ./local_dev.key -in ./local_dev.crt -export -out ./local_dev.pfx
|
||||
openssl base64 -in ./local_dev.pfx -out ./base64_pfx
|
||||
```
|
||||
@@ -0,0 +1,11 @@
|
||||
---
|
||||
title: How to generate self-signed document signing certificate?
|
||||
---
|
||||
# Steps to generate self-signed document signing certificate for testing OpenSign
|
||||
```
|
||||
# execute below command and use passphrase 'opensign'
|
||||
openssl genrsa -des3 -out ./local_dev.key 2048
|
||||
openssl req -key ./local_dev.key -new -x509 -days 365 -out ./local_dev.crt
|
||||
openssl pkcs12 -inkey ./local_dev.key -in ./local_dev.crt -export -out ./local_dev.pfx
|
||||
openssl base64 -in ./local_dev.pfx -out ./base64_pfx
|
||||
```
|
||||
@@ -0,0 +1,22 @@
|
||||
---
|
||||
title: How to upgrade self-hosted OpenSign to v2.1.0?
|
||||
---
|
||||
# Steps to upgrade any previous self-hosted OpenSign to v2.1.0
|
||||
|
||||
For self-hosted deployments, version 2.1.0 introduces changes to the signup process:
|
||||
|
||||
**New Deployment:** The signup button has been removed. During a fresh deployment, an admin creation wizard will guide you through creating an Admin user.
|
||||
|
||||
**Migration from Previous Versions:** For those upgrading from any previous version to 2.1.0, follow these steps to promote an existing user to Admin:
|
||||
|
||||
After upgrading, visit "https://public_url/upgrade-2.1" and enter the requested details to change the role of an existing user to Admin.
|
||||
Ensure you have your master key (set in the environment variable during installation) and the email ID of the user to be promoted ready.
|
||||
|
||||
**User Roles and Capabilities**
|
||||
In the self-hosted version, Admins have comprehensive control:
|
||||
|
||||
Admin: Admins can manage users and share templates with the entire organization. Only Admins can create users, with roles being assigned as OrgAdmin, Editor, or User.
|
||||
OrgAdmin: OrgAdmins have the same access as Admins. Essentially they are new admins that can be created as and when needed.
|
||||
Editor: Editors can share templates with all users but cannot create users.
|
||||
User: Users cannot share templates or create users. They can only create emplates for themselves.
|
||||
All other features remain accessible to all roles.
|
||||
@@ -0,0 +1,6 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
# Self-Hosting OpenSign
|
||||
|
||||
This section of the OpenSign™ documentation is dedicated to guiding you through the process of self-hosting the OpenSign platform. Self-hosting OpenSign allows for greater control and customization, ensuring that it aligns perfectly with your specific needs and infrastructure requirements. We cover everything from initial setup, configuration options, to maintenance best practices. Whether you are an individual enthusiast or a professional looking to deploy OpenSign in a corporate environment, this guide will provide you with the necessary steps and tips to successfully self-host OpenSign™ - the best open source document signing infrastructure.
|
||||
@@ -0,0 +1,213 @@
|
||||
// @ts-check
|
||||
// `@type` JSDoc annotations allow editor autocompletion and type checking
|
||||
// (when paired with `@ts-check`).
|
||||
// There are various equivalent ways to declare your Docusaurus config.
|
||||
// See: https://docusaurus.io/docs/api/docusaurus-config
|
||||
|
||||
import {themes as prismThemes} from 'prism-react-renderer';
|
||||
|
||||
|
||||
/** @type {import('@docusaurus/types').Config} */
|
||||
const config = {
|
||||
title: 'OpenSign™',
|
||||
tagline: 'Official OpenSign™ Docs - tutorials, API documentation, self-host help & much more.',
|
||||
favicon: 'img/favicon.ico',
|
||||
|
||||
// Set the production url of your site here
|
||||
url: 'https://docs.opensignlabs.com',
|
||||
// Set the /<baseUrl>/ pathname under which your site is served
|
||||
// For GitHub pages deployment, it is often '/<pro jectName>/'
|
||||
baseUrl: '/',
|
||||
|
||||
// GitHub pages deployment config.
|
||||
// If you aren't using GitHub pages, you don't ne ed these.
|
||||
organizationName: 'opensignlabs', // Usually your GitHub org/user name.
|
||||
projectName: 'opensign', // Usually your repo name.
|
||||
|
||||
onBrokenLinks: 'throw',
|
||||
onBrokenMarkdownLinks: 'warn',
|
||||
|
||||
// Even if you don't use internationalization, you can use this field to set
|
||||
// useful metadata like html lang. For example, if your site is Chinese, you
|
||||
// may want to replace "en" with "zh-Hans".
|
||||
i18n: {
|
||||
defaultLocale: 'en',
|
||||
locales: ['en'],
|
||||
},
|
||||
|
||||
presets: [
|
||||
[
|
||||
'classic',
|
||||
/** @type {import('@docusaurus/preset-classic').Options} */
|
||||
({
|
||||
docs: {
|
||||
sidebarPath: './sidebars.js',
|
||||
// Please change this to your repo.
|
||||
// Remove this to remove the "edit this page" links.
|
||||
editUrl:
|
||||
'https://github.com/opensignlabs/opensign/tree/feat-docs/docs/',
|
||||
docItemComponent: "@theme/ApiItem" // derived from docusaurus-theme-openapi-docs
|
||||
},
|
||||
blog: {
|
||||
showReadingTime: true,
|
||||
// Please change this to your repo.
|
||||
// Remove this to remove the "edit this page" links.
|
||||
editUrl:
|
||||
'https://github.com/facebook/docusaurus/tree/feat-docs/docs/',
|
||||
},
|
||||
theme: {
|
||||
customCss: './src/css/custom.css',
|
||||
},
|
||||
})
|
||||
],
|
||||
],
|
||||
|
||||
plugins: [
|
||||
[
|
||||
"docusaurus-plugin-openapi-docs",
|
||||
{
|
||||
id: "openapi",
|
||||
docsPluginId: "default", // e.g. "classic" or the plugin-content-docs id
|
||||
config: {
|
||||
opensign: { // "petstore" is considered the <id> that you will reference in the CLI
|
||||
specPath: "docs/API-docs/opensign.yaml", // path or URL to the OpenAPI spec
|
||||
outputDir: "docs/API-docs", // output directory for generated *.mdx and sidebar.js files
|
||||
sidebarOptions: {
|
||||
groupPathsBy: "tag", // generate a sidebar.js slice that groups operations by tag
|
||||
},
|
||||
}
|
||||
}
|
||||
},
|
||||
]
|
||||
],
|
||||
themes: ["docusaurus-theme-openapi-docs"], // exports ApiItem and ApiDemoPanel
|
||||
themeConfig:
|
||||
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
|
||||
({
|
||||
announcementBar: {
|
||||
id: 'support_us',
|
||||
content:
|
||||
'Help use spread the word - ⭐ OpenSign on <a target="_blank" rel="noopener" href="https://github.com/opensignlabs/opensign">GitHub</a>',
|
||||
backgroundColor: '#cae4fa',
|
||||
textColor: '#091E42',
|
||||
isCloseable: false,
|
||||
},
|
||||
// Replace with your project's social card
|
||||
image: 'img/docusaurus-social-card.png',
|
||||
navbar: {
|
||||
title: 'OpenSign™',
|
||||
logo: {
|
||||
alt: 'OpenSign™ Logo',
|
||||
src: 'img/logo.png',
|
||||
},
|
||||
items: [
|
||||
{
|
||||
type: 'docSidebar',
|
||||
sidebarId: 'tutorialSidebar',
|
||||
position: 'left',
|
||||
label: 'Help',
|
||||
},
|
||||
{
|
||||
type: 'docSidebar',
|
||||
sidebarId: 'apiSidebar',
|
||||
position: 'left',
|
||||
label: 'APIs',
|
||||
},
|
||||
{
|
||||
type: 'docSidebar',
|
||||
sidebarId: 'contributeSidebar',
|
||||
position: 'left',
|
||||
label: 'Contribute',
|
||||
},
|
||||
{
|
||||
href: 'https://www.opensignlabs.com/plans-pricing',
|
||||
label: 'Cloud Pricing',
|
||||
position: 'left',
|
||||
},
|
||||
//{to: '/blog', label: 'Blog', position: 'left'},
|
||||
{
|
||||
type: 'docSidebar',
|
||||
sidebarId: 'selfhostSidebar',
|
||||
position: 'left',
|
||||
label: 'Self-host',
|
||||
},
|
||||
{
|
||||
href: 'https://github.com/opensignlabs/opensign',
|
||||
label: 'GitHub',
|
||||
position: 'right',
|
||||
},
|
||||
],
|
||||
},
|
||||
footer: {
|
||||
style: 'dark',
|
||||
links: [
|
||||
{
|
||||
title: 'Docs',
|
||||
items: [
|
||||
{
|
||||
label: 'Help',
|
||||
to: '/docs/help/intro',
|
||||
},
|
||||
{
|
||||
label: 'APIs',
|
||||
to: '/docs/API-docs/opensign-api-v-1',
|
||||
},
|
||||
{
|
||||
label: 'Contribute',
|
||||
to: '/docs/contribute/intro',
|
||||
},
|
||||
{
|
||||
label: 'Self-host',
|
||||
to: '/docs/self-host/intro',
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
title: 'Community',
|
||||
items: [
|
||||
{
|
||||
label: 'Discord',
|
||||
href: 'https://discord.com/invite/xe9TDuyAyj',
|
||||
},
|
||||
{
|
||||
label: 'LinkedIn',
|
||||
href: 'https://www.linkedin.com/company/opensign%E2%84%A2/',
|
||||
},
|
||||
{
|
||||
label: 'Twitter',
|
||||
href: 'https://www.twitter.com/opensignhq',
|
||||
},
|
||||
{
|
||||
label: 'Facebook',
|
||||
href: 'https://www.facebook.com/profile.php?id=61551030403669',
|
||||
},
|
||||
],
|
||||
},
|
||||
{
|
||||
title: 'More',
|
||||
items: [
|
||||
// {
|
||||
// label: 'Blog',
|
||||
// to: '/blog',
|
||||
// },
|
||||
{
|
||||
label: 'Official Website',
|
||||
href: 'https://www.opensignlabs.com',
|
||||
},
|
||||
{
|
||||
label: 'GitHub',
|
||||
href: 'https://github.com/opensignlabs/opensign',
|
||||
},
|
||||
],
|
||||
},
|
||||
],
|
||||
copyright: `Copyright © ${new Date().getFullYear()} OpenSign™. <br>The best Open Source DocuSign alternative.`,
|
||||
},
|
||||
prism: {
|
||||
theme: prismThemes.github,
|
||||
darkTheme: prismThemes.dracula,
|
||||
},
|
||||
}),
|
||||
};
|
||||
|
||||
export default config;
|
||||
@@ -0,0 +1,49 @@
|
||||
{
|
||||
"name": "OpenSign-Docs",
|
||||
"version": "0.1.0",
|
||||
"private": true,
|
||||
"scripts": {
|
||||
"docusaurus": "docusaurus",
|
||||
"start": "docusaurus start",
|
||||
"build": "docusaurus build",
|
||||
"swizzle": "docusaurus swizzle",
|
||||
"deploy": "docusaurus deploy",
|
||||
"clear": "docusaurus clear",
|
||||
"serve": "docusaurus serve",
|
||||
"write-translations": "docusaurus write-translations",
|
||||
"write-heading-ids": "docusaurus write-heading-ids"
|
||||
},
|
||||
"dependencies": {
|
||||
"@docusaurus/core": "3.0.1",
|
||||
"@docusaurus/plugin-content-docs": "^3.0.1",
|
||||
"@docusaurus/preset-classic": "3.0.1",
|
||||
"@mdx-js/react": "^3.0.0",
|
||||
"add": "^2.0.6",
|
||||
"clsx": "^1.2.1",
|
||||
"docusaurus-plugin-openapi-docs": "^3.0.0-beta.3",
|
||||
"docusaurus-theme-openapi-docs": "^3.0.0-beta.3",
|
||||
"prism-react-renderer": "^2.1.0",
|
||||
"react": "^18.0.0",
|
||||
"react-dom": "^18.0.0",
|
||||
"react-player": "2.14.1"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@docusaurus/module-type-aliases": "3.0.0",
|
||||
"@docusaurus/types": "3.0.0"
|
||||
},
|
||||
"browserslist": {
|
||||
"production": [
|
||||
">0.5%",
|
||||
"not dead",
|
||||
"not op_mini all"
|
||||
],
|
||||
"development": [
|
||||
"last 3 chrome version",
|
||||
"last 3 firefox version",
|
||||
"last 5 safari version"
|
||||
]
|
||||
},
|
||||
"engines": {
|
||||
"node": ">=18.0"
|
||||
}
|
||||
}
|
||||
@@ -0,0 +1,38 @@
|
||||
/**
|
||||
* Creating a sidebar enables you to:
|
||||
- create an ordered group of docs
|
||||
- render a sidebar for each doc of that group
|
||||
- provide next/previous navigation
|
||||
|
||||
The sidebars can be generated from the filesystem, or explicitly defined here.
|
||||
|
||||
Create as many sidebars as you want.
|
||||
*/
|
||||
|
||||
// @ts-check
|
||||
import apiSidebar from './docs/API-docs/sidebar.ts';
|
||||
|
||||
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
|
||||
const sidebars = {
|
||||
// By default, Docusaurus generates a sidebar from the docs folder structure
|
||||
tutorialSidebar: [{type: 'autogenerated', dirName: 'help'}],
|
||||
selfhostSidebar: [{type: 'autogenerated', dirName: 'self-host'}],
|
||||
contributeSidebar: [{type: 'autogenerated', dirName: 'contribute'}],
|
||||
apiSidebar: apiSidebar,
|
||||
|
||||
|
||||
// But you can create a sidebar manually
|
||||
/*
|
||||
tutorialSidebar: [
|
||||
'intro',
|
||||
'hello',
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Tutorial',
|
||||
items: ['tutorial-basics/create-a-document'],
|
||||
},
|
||||
],
|
||||
*/
|
||||
};
|
||||
|
||||
export default sidebars;
|
||||
@@ -0,0 +1,94 @@
|
||||
import React from 'react';
|
||||
import clsx from 'clsx';
|
||||
import styles from './styles.module.css';
|
||||
|
||||
|
||||
|
||||
const FeatureList = [
|
||||
{
|
||||
title: 'What is OpenSign™?',
|
||||
PNGUrl: '/img/logo.svg',
|
||||
description: (
|
||||
<>
|
||||
<div style={{ textAlign: 'justify' }}>At OpenSign Labs, we're redefining the landscape of digital signatures. Our mission is to make digital document signing not just a formality, but an integral part of your organization's digital transformation journey. OpenSign™ Docs is your gateway to a world where efficiency, security and simplicity reign supreme.</div>
|
||||
</>
|
||||
),
|
||||
},
|
||||
{
|
||||
title: 'Why Choose OpenSign™?',
|
||||
PNGUrl: '/img/whychooseus.svg',
|
||||
description: (
|
||||
<>
|
||||
<div style={{ textAlign: 'justify' }}>
|
||||
<ul>
|
||||
<li>
|
||||
<strong>Innovative Technology</strong>: Harness the latest advancements in e-signature technology.
|
||||
</li>
|
||||
<li>
|
||||
<strong>Data-Driven Security</strong>: With encryption and compliance at the forefront, your documents are in safe hands. We also provide self host option for those who want full control of their data.
|
||||
</li>
|
||||
<li>
|
||||
<strong>User-Centric Design</strong>: Experience unparalleled ease of use, designed for individuals and businesses alike. OpenSign™ user experience is designed while keeping the most novice user in mind. Finally, a tool that does not need numerous hours of training to get started.
|
||||
</li>
|
||||
<li>
|
||||
<strong>Scalable Solutions</strong>: From small startups to large corporations, our platform grows with your needs. From free for life plan for individuals to branding and single-sign-on support for enterprises, our platform supports everything.
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
</>
|
||||
),
|
||||
},
|
||||
{
|
||||
title: 'Getting Started',
|
||||
PNGUrl: '/img/getstarted.svg',
|
||||
description: (
|
||||
<>
|
||||
<div style={{ textAlign: 'justify' }}>
|
||||
<p>
|
||||
Dive into our comprehensive guides and tutorials. Whether you're a new user or looking to integrate OpenSign™ into your existing workflow, we have everything you need to get started.
|
||||
</p>
|
||||
<ul>
|
||||
<li>
|
||||
<strong><a href='https://docs.opensignlabs.com/docs/help/intro'>Tutorial</a></strong>: Get up and running in no time. Get all the help you need to navigate you through the already seamless UX of OpenSign.
|
||||
</li>
|
||||
<li>
|
||||
<strong><a href='https://github.com/OpenSignLabs/OpenSign/discussions'>Github Discussions</a></strong>: Discuss your ideas & issues with the community.
|
||||
</li>
|
||||
<li>
|
||||
<strong>Social media</strong>: Join us on <a href='https://discord.com/invite/xe9TDuyAyj'>Discord</a>, <a href='https://www.twitter.com/opensignhq'>Twitter</a>, <a href='https://www.linkedin.com/company/opensign%E2%84%A2'>LinkedIn</a> & <a href='https://www.facebook.com/profile.php?id=61551030403669'>Facebook</a>.
|
||||
</li>
|
||||
</ul>
|
||||
</div>
|
||||
|
||||
</>
|
||||
),
|
||||
},
|
||||
];
|
||||
|
||||
function Feature({PNGUrl, title, description}) {
|
||||
return (
|
||||
<div className={clsx('col col--4')}>
|
||||
<div className="text--center">
|
||||
<img src={PNGUrl} />
|
||||
</div>
|
||||
<div className="text--center padding-horiz--md">
|
||||
<h3>{title}</h3>
|
||||
<p>{description}</p>
|
||||
</div>
|
||||
</div>
|
||||
);
|
||||
}
|
||||
|
||||
export default function HomepageFeatures() {
|
||||
return (
|
||||
<section className={styles.features}>
|
||||
<div className="container">
|
||||
<div className="row">
|
||||
{FeatureList.map((props, idx) => (
|
||||
<Feature key={idx} {...props} />
|
||||
))}
|
||||
</div>
|
||||
</div>
|
||||
</section>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,11 @@
|
||||
.features {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
padding: 2rem 0;
|
||||
width: 100%;
|
||||
}
|
||||
|
||||
.featureSvg {
|
||||
height: 200px;
|
||||
width: 200px;
|
||||
}
|
||||
@@ -0,0 +1,38 @@
|
||||
/**
|
||||
* Any CSS included here will be global. The classic template
|
||||
* bundles Infima by default. Infima is a CSS framework designed to
|
||||
* work well for content-centric websites.
|
||||
*/
|
||||
|
||||
/* You can override the default Infima variables here. */
|
||||
:root {
|
||||
--ifm-color-primary: #3254A0;
|
||||
--ifm-color-primary-dark: #0A1026;
|
||||
--ifm-color-primary-darker: #080F27;
|
||||
--ifm-color-primary-darkest: #070E2A;
|
||||
--ifm-color-primary-light: #0B194B;
|
||||
--ifm-color-primary-lighter: #0E205F;
|
||||
--ifm-color-primary-lightest: #112775;
|
||||
--ifm-code-font-size: 95%;
|
||||
--docusaurus-highlighted-code-line-bg: rgba(215, 16, 16, 0.1);
|
||||
--ifm-color-primary-gradient: linear-gradient(45deg, #c6cde4, #112775); /* created by chatgpt */
|
||||
}
|
||||
|
||||
/* For readability concerns, you should choose a lighter palette in dark mode. */
|
||||
[data-theme='dark'] {
|
||||
--ifm-color-primary: #5768a3;
|
||||
--ifm-color-primary-dark: #21af90;
|
||||
--ifm-color-primary-darker: #1fa588;
|
||||
--ifm-color-primary-darkest: #1a8870;
|
||||
--ifm-color-primary-light: #29d5b0;
|
||||
--ifm-color-primary-lighter: #32d8b4;
|
||||
--ifm-color-primary-lightest: #4fddbf;
|
||||
--docusaurus-highlighted-code-line-bg: rgba(0, 0, 0, 0.3);
|
||||
}
|
||||
|
||||
/* created by chatgpt */
|
||||
|
||||
|
||||
.hero.hero--primary.heroBannerGradient {
|
||||
background: var(--ifm-color-primary-gradient);
|
||||
}
|
||||
@@ -0,0 +1,40 @@
|
||||
import React from 'react';
|
||||
import clsx from 'clsx';
|
||||
import Layout from '@theme/Layout';
|
||||
import Link from '@docusaurus/Link';
|
||||
import useDocusaurusContext from '@docusaurus/useDocusaurusContext';
|
||||
import styles from './index.module.css';
|
||||
import HomepageFeatures from '@site/src/components/HomepageFeatures';
|
||||
|
||||
function HomepageHeader() {
|
||||
const {siteConfig} = useDocusaurusContext();
|
||||
return (
|
||||
<header className={clsx('hero hero--primary', styles.heroBanner)}>
|
||||
<div className="container">
|
||||
<h1 className="hero__title">{siteConfig.title}</h1>
|
||||
<p className="hero__subtitle">{siteConfig.tagline}</p>
|
||||
<div className={styles.buttons}>
|
||||
<Link
|
||||
className="button button--secondary button--lg"
|
||||
to="/docs/help/intro">
|
||||
Access Docs 🚀
|
||||
</Link>
|
||||
</div>
|
||||
</div>
|
||||
</header>
|
||||
);
|
||||
}
|
||||
|
||||
export default function Home() {
|
||||
const {siteConfig} = useDocusaurusContext();
|
||||
return (
|
||||
<Layout
|
||||
title={`Official OpenSign™ Docs - tutorials, API documentation, self-host help & much more.`}
|
||||
description="Explore the official OpenSign™ documentation! Find comprehensive tutorials, API guides, self-hosting help, and much more to enhance your digital signing experience.">
|
||||
<HomepageHeader />
|
||||
<main>
|
||||
<HomepageFeatures />
|
||||
</main>
|
||||
</Layout>
|
||||
);
|
||||
}
|
||||
@@ -0,0 +1,23 @@
|
||||
/**
|
||||
* CSS files with the .module.css suffix will be treated as CSS modules
|
||||
* and scoped locally.
|
||||
*/
|
||||
|
||||
.heroBanner {
|
||||
padding: 4rem 0;
|
||||
text-align: center;
|
||||
position: relative;
|
||||
overflow: hidden;
|
||||
}
|
||||
|
||||
@media screen and (max-width: 996px) {
|
||||
.heroBanner {
|
||||
padding: 2rem;
|
||||
}
|
||||
}
|
||||
|
||||
.buttons {
|
||||
display: flex;
|
||||
align-items: center;
|
||||
justify-content: center;
|
||||
}
|
||||
@@ -0,0 +1,7 @@
|
||||
---
|
||||
title: Markdown page example
|
||||
---
|
||||
|
||||
# Markdown page example
|
||||
|
||||
You don't need React to write simple standalone pages.
|
||||
@@ -0,0 +1 @@
|
||||
docs.opensignlabs.com
|
||||
|
After Width: | Height: | Size: 2.6 KiB |
|
After Width: | Height: | Size: 54 KiB |
|
After Width: | Height: | Size: 490 KiB |
|
After Width: | Height: | Size: 5.0 KiB |
|
After Width: | Height: | Size: 3.4 KiB |
|
After Width: | Height: | Size: 15 KiB |
|
After Width: | Height: | Size: 15 KiB |
|
After Width: | Height: | Size: 102 KiB |
|
After Width: | Height: | Size: 59 KiB |
|
After Width: | Height: | Size: 222 KiB |