mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-09-03 16:28:56 +02:00
Compare commits
113
Commits
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
d705a4314f | ||
|
|
095040713e | ||
|
|
ac884185b4 | ||
|
|
eede170d16 | ||
|
|
c4d6d8e442 | ||
|
|
14a2f6f78a | ||
|
|
dd28cefac8 | ||
|
|
00179f5415 | ||
|
|
7b465687ef | ||
|
|
e67fdfb134 | ||
|
|
ceee0e1089 | ||
|
|
1d184a69b0 | ||
|
|
8e09d7235b | ||
|
|
a39c01ef12 | ||
|
|
d96504bb30 | ||
|
|
0b8c4eac6e | ||
|
|
98f7de5e0c | ||
|
|
998a50412a | ||
|
|
e16c5e08a8 | ||
|
|
72a61bc621 | ||
|
|
f095629134 | ||
|
|
a0c1e08091 | ||
|
|
3583d7a549 | ||
|
|
69e679982a | ||
|
|
3303fcb895 | ||
|
|
6b5815f52a | ||
|
|
a01e361d14 | ||
|
|
c059e95fa9 | ||
|
|
70abddec3a | ||
|
|
ca8eaa492c | ||
|
|
94806c895f | ||
|
|
8b08995e7d | ||
|
|
de9c58e5fd | ||
|
|
6d914829e9 | ||
|
|
0193e4946f | ||
|
|
14c6b14c27 | ||
|
|
794365f6dc | ||
|
|
d0a0a28dec | ||
|
|
1385f12543 | ||
|
|
0d81ffe677 | ||
|
|
9d7376aedb | ||
|
|
5eb7d8ce13 | ||
|
|
4609bba4c1 | ||
|
|
de0de1973e | ||
|
|
16c48e9d23 | ||
|
|
344ccadfb1 | ||
|
|
eb1086e5b1 | ||
|
|
ae568a89d5 | ||
|
|
daa348c2e3 | ||
|
|
78532731da | ||
|
|
2e26d5687e | ||
|
|
4b8b7ed8d9 | ||
|
|
ac986af20f | ||
|
|
a96333bba5 | ||
|
|
78ca0d1fdb | ||
|
|
415760ba52 | ||
|
|
67bd246ef9 | ||
|
|
4963a7ad7f | ||
|
|
94b02105f3 | ||
|
|
6aaeeeeaf5 | ||
|
|
8039f5a744 | ||
|
|
a5ebd67967 | ||
|
|
266a4c5654 | ||
|
|
406a29054e | ||
|
|
57f8ba8a72 | ||
|
|
f1a70eac5a | ||
|
|
f228ae5ba8 | ||
|
|
2c1239dcf0 | ||
|
|
6ca9cbab16 | ||
|
|
9922f22ef7 | ||
|
|
84cc1d65fe | ||
|
|
7a5db1ca40 | ||
|
|
de79c9a4b3 | ||
|
|
7a7e1b506a | ||
|
|
fa2e66914d | ||
|
|
b0c65fe5f1 | ||
|
|
b0440876cd | ||
|
|
6359067839 | ||
|
|
71f36ff383 | ||
|
|
beab4bdfc9 | ||
|
|
c9e6750724 | ||
|
|
06c7355efd | ||
|
|
73f7d1b32f | ||
|
|
fecc87d8c3 | ||
|
|
57c89bf601 | ||
|
|
b10b2617b8 | ||
|
|
eaed35cefd | ||
|
|
44e92344fc | ||
|
|
9aebbde627 | ||
|
|
8ece6ef046 | ||
|
|
7d46e26365 | ||
|
|
e2646bd49f | ||
|
|
6158ac7bc4 | ||
|
|
596340bea9 | ||
|
|
73d1cdee00 | ||
|
|
f88f2c681b | ||
|
|
25ecf7221d | ||
|
|
bb18feaacf | ||
|
|
19324ad0d8 | ||
|
|
8a0f5c460f | ||
|
|
625689b203 | ||
|
|
d919e8514b | ||
|
|
18f183f48b | ||
|
|
69135afe6b | ||
|
|
474a20aa41 | ||
|
|
19478536b3 | ||
|
|
dc29d7a23b | ||
|
|
f5137f54b0 | ||
|
|
42f2122070 | ||
|
|
e4ca29c2c3 | ||
|
|
b8a039bc20 | ||
|
|
331b2d5a40 | ||
|
|
46e390d3c5 |
+6
-1
@@ -24,4 +24,9 @@ yarn-debug.log*
|
||||
yarn-error.log*
|
||||
apps/OpenSign/public/mfbuild/*
|
||||
microfrontends/SignDocuments/build/*
|
||||
apps/OpenSignServer/files/files/*
|
||||
apps/OpenSignServer/files/files/*
|
||||
# ignore generated API documentation
|
||||
/docs/docs/API-docs/*
|
||||
!/docs/docs/API-docs/opensign.yaml
|
||||
!/docs/docs/API-docs/intro.md
|
||||
/docs/docs/API-docs-1.1/
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,242 +0,0 @@
|
||||
---
|
||||
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>
|
||||
|
||||
@@ -1,112 +0,0 @@
|
||||
---
|
||||
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>
|
||||
|
||||
@@ -1,101 +0,0 @@
|
||||
---
|
||||
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>
|
||||
|
||||
@@ -1,510 +0,0 @@
|
||||
---
|
||||
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>
|
||||
|
||||
@@ -1,510 +0,0 @@
|
||||
---
|
||||
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>
|
||||
|
||||
@@ -1,125 +0,0 @@
|
||||
---
|
||||
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>
|
||||
|
||||
@@ -1,499 +0,0 @@
|
||||
---
|
||||
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>
|
||||
|
||||
@@ -1,219 +0,0 @@
|
||||
---
|
||||
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>
|
||||
|
||||
@@ -1,111 +0,0 @@
|
||||
---
|
||||
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>
|
||||
|
||||
+2156
-54
File diff suppressed because one or more lines are too long
@@ -1,118 +0,0 @@
|
||||
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;
|
||||
@@ -1,297 +0,0 @@
|
||||
---
|
||||
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>
|
||||
|
||||
@@ -1,117 +0,0 @@
|
||||
---
|
||||
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>
|
||||
|
||||
File diff suppressed because it is too large
Load Diff
@@ -1,178 +0,0 @@
|
||||
---
|
||||
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>
|
||||
|
||||
@@ -1,183 +0,0 @@
|
||||
---
|
||||
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,27 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
title: Editing Your Document Before Sending
|
||||
---
|
||||
|
||||
# How to edit a document before sending in OpenSign™?
|
||||
|
||||
OpenSign™ lets you polish your PDF before you send it out—whether you’re signing it yourself, requesting signatures, or saving it as a template. You get three core editing controls right in the preview:
|
||||
|
||||
1. **Add Pages**
|
||||
|
||||
* Click the **“+”** icon.
|
||||
* Upload one or more PDF files.
|
||||
* New pages are appended to the end of your current document.
|
||||
|
||||
2. **Rotate Pages**
|
||||
|
||||
* Use the **left-rotate** or **right-rotate** icons on any page.
|
||||
* See the orientation update instantly in the real-time preview.
|
||||
|
||||
3. **Delete Pages**
|
||||
|
||||
* Click the **trash bin** icon on the page you want to remove.
|
||||
* Confirm the deletion when prompted.
|
||||
* **Warning:** This action is permanent and cannot be undone.
|
||||
|
||||

|
||||
@@ -5,5 +5,5 @@ 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 -
|
||||

|
||||
To navigate between pages of a document that you have uploaded either click on the previous page `<<` & next page `>>` buttons at the top or click on any of the page previews loaded on the left side -
|
||||

|
||||
|
||||
@@ -19,7 +19,7 @@ The OpenSign™ Request signatures interface is designed to streamline the proce
|
||||
|
||||
### 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.
|
||||
- **[2] Choose File**: Once the "Request signature" form opens, click "Choose file" button to select and upload the document file from your computer that needs to be signed. Currently you can upload only 1 file at a time but you can add additional documents by clicking "Add pages" in the next step.
|
||||
- **[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
|
||||
@@ -42,7 +42,7 @@ The OpenSign™ Request signatures interface is designed to streamline the proce
|
||||
- **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)
|
||||
### Step 7: Auto reminder (feature only available 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.
|
||||
|
||||
@@ -81,41 +81,41 @@ Use the option on the right side to add recipients if you need to include additi
|
||||
- **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.
|
||||
- Copy : Clicking on this you can duplicate 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.
|
||||
- Copy : Clicking on this you can duplicate 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.
|
||||
- Copy : Clicking on this you can duplicate 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.
|
||||
- Copy : Clicking on this you can duplicate 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.
|
||||
- Copy : Clicking on this you can duplicate 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.
|
||||
- Copy : Clicking on this you can duplicate 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 are a few options available such as setting the minimum and maximum checks, making the checkbox read-only, and hiding the label.
|
||||
- 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.
|
||||
- Copy : Clicking on this you can duplicate 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 are a few options available such as setting a default value and marking the dropdown as 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.
|
||||
- Copy : Clicking on this you can duplicate 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 are a few options available such as setting a default value, making the radio button read-only, and hiding the label.
|
||||
- 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.
|
||||
- Copy : Clicking on this you can duplicate 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.
|
||||
- Copy : Clicking on this you can duplicate 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.
|
||||
|
||||
@@ -17,7 +17,7 @@ After login, you will be directed to the OpenSign dashboard. From the left-side
|
||||
- **[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.```
|
||||
```The maximum document size allowed is 10MB.```
|
||||
|
||||
### Step 2: Document Information
|
||||
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
{
|
||||
"label": "Reports",
|
||||
"label": "Documents",
|
||||
"position": 2,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
|
||||
@@ -12,7 +12,7 @@ The "Completed documents" report within OpenSign serves as a vital tool for mana
|
||||
### 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.
|
||||
2. Click on **"Documents"** 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
|
||||
|
||||
@@ -13,7 +13,7 @@ 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.
|
||||
3. Click on the `Contactbook` link under the Documents section.
|
||||
|
||||
<img width="828" alt="Add contact" src="https://github.com/user-attachments/assets/80308df4-33a8-41ee-a240-801f775dcec0" />
|
||||
|
||||
|
||||
@@ -9,7 +9,7 @@ The "Declined documents" report within OpenSign serves as a vital tool for manag
|
||||
### 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.
|
||||
2. Click on **"Documents"** 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
|
||||
|
||||
@@ -9,7 +9,7 @@ The Draft documents section in OpenSign helps you manage all your in-progress do
|
||||
### 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.
|
||||
2. Click on **"Documents"** 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
|
||||
|
||||
@@ -13,7 +13,7 @@ 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.
|
||||
3. Click on the `Expired` link under the **Documents** section.
|
||||
|
||||
<img width="828" alt="Expired document" src="https://github.com/user-attachments/assets/01f3626f-d694-4d3b-82da-2f2b77693b76" />
|
||||
|
||||
|
||||
@@ -8,7 +8,7 @@ The In-Progress documents report in OpenSign helps you monitor and manage docume
|
||||
### 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.
|
||||
2. Click on **"Documents"** 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
|
||||
|
||||
@@ -9,7 +9,7 @@ The "Need your sign" feature in OpenSign is designed to simplify the process of
|
||||
## 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.
|
||||
- **Navigate to "Need your sign"**: Once logged in, you will find a navigation panel on the left side of your screen. Under the "Documents" section, click on "Need your sign" to view all documents that require your signature.
|
||||
|
||||
## Understanding the "Need your sign" report
|
||||
|
||||
|
||||
@@ -0,0 +1,62 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
title: API Token
|
||||
---
|
||||
|
||||
# 🔐 API Authentication – Setting Up Your `x-api-token`
|
||||
|
||||
To authenticate and use OpenSign API endpoints, you’ll need a valid API token (`x-api-token`).
|
||||
|
||||
Follow the steps below to generate one.
|
||||
|
||||
> **Note:** You can generate both **Live** and **Sandbox** API tokens from your OpenSign account.
|
||||
|
||||
---
|
||||
|
||||
## 🧭 Step-by-Step Guide to Generate Your API Token
|
||||
|
||||
**Step 1:** Log in to your OpenSign account using valid credentials.
|
||||
|
||||
**Step 2:** Navigate to the **Settings** section and click on **API Token**.
|
||||
|
||||
<img width="436" alt="Navigate-to-Api-token" src="https://github.com/user-attachments/assets/8079ecb5-ad5b-4ce6-8d6c-14395130a654" />
|
||||
|
||||
**Step 3:** On the API Token page, click the **Generate Live API Token** button.
|
||||
|
||||
> **Note:** To generate a **Live API Token**, you must upgrade to a **paid plan** — either the **Professional** or **Teams** plan.
|
||||
|
||||
<img width="436" alt="Generate token" src="https://github.com/user-attachments/assets/6188ae46-0f40-4de6-9903-33ae0aa4e63f" />
|
||||
|
||||
- Your `x-api-token` will now be generated and displayed.
|
||||
- **Copy this token** — you’ll need it to authenticate your OpenSign API requests.
|
||||
|
||||
---
|
||||
|
||||
### 🧪 Sandbox API Token
|
||||
|
||||
You’ll also find the option to generate a **Sandbox API Token** on the same page.
|
||||
|
||||
- **Sandbox API tokens** are available on all plans, including the **free plan**, and are intended for development and testing.
|
||||
- **Do not upload confidential data** to the Sandbox environment.
|
||||
|
||||
---
|
||||
|
||||
## 🧠 Frequently Asked Questions
|
||||
|
||||
**1. What is the OpenSign Sandbox environment?**
|
||||
The Sandbox is a testing environment designed for developers to safely experiment with OpenSign APIs and workflows. It mirrors the live environment but with certain limitations.
|
||||
|
||||
**2. Can I upload large documents to the Sandbox?**
|
||||
No. Please avoid uploading documents larger than **5MB** in the Sandbox. It is optimized for lightweight testing only.
|
||||
|
||||
**3. Can I use my Live API Token in the Sandbox?**
|
||||
No. **Live API Tokens do not work** in the Sandbox environment. You’ll need to generate a separate token specifically for Sandbox testing.
|
||||
|
||||
**4. Why can’t I use a live template in the Sandbox?**
|
||||
Live and Sandbox environments are **separate**. Templates created in the Live environment cannot be used in the Sandbox, and vice versa.
|
||||
|
||||
**5. Can I use the API in the free self-hosted environment?**
|
||||
No. The **free self-hosted version** does not support API token generation.
|
||||
To use OpenSign APIs in a self-hosted setup, you must upgrade to a **paid self-hosted plan**.
|
||||
|
||||
If you need additional assistance setting up OpenSign APIs, feel free to contact our support team at support@opensignlabs.com.
|
||||
@@ -0,0 +1,49 @@
|
||||
---
|
||||
sidebar_position: 8
|
||||
title: Custom email templates
|
||||
---
|
||||
|
||||
# 📧 Email Templates
|
||||
|
||||
## 🚀 Steps to Set Up Custom Email Templates
|
||||
|
||||
**Step 1:** Log in to your OpenSign account using valid credentials.
|
||||
**Step 2:** Navigate to the **Settings** section and click on **Preferences**.
|
||||
**Step 3:** Click on the **Email** tab. Here, users can configure and edit custom email templates for different stages of the document lifecycle.
|
||||
|
||||
<img width="800" alt="add team" src="https://github.com/user-attachments/assets/dc1efaab-c7f9-4f82-abc4-1cafd587f7ce"></img>
|
||||
|
||||
---
|
||||
|
||||
## ✉️ Request Signature Email
|
||||
|
||||
This email is automatically sent to all signers when a document is shared with them for signing.
|
||||
|
||||
- Customize the subject line, greeting, message body, and footer to match your tone and branding.
|
||||
- Use dynamic placeholders like `{{document_title}}`, `{{receiver_name}}`, and `{{signing_url}}` to personalize each message.
|
||||
- Personalized messages improve open rates and help recipients understand the context of the request.
|
||||
|
||||
## 📩 Document Completion Email
|
||||
|
||||
This email is sent to all signers and the document owner once the signing process is complete.
|
||||
|
||||
- Includes a summary message along with the signed document and completion certificate as attachments.
|
||||
- Template customization allows teams to reinforce brand messaging post-signature.
|
||||
- Ideal for legal confirmations, audit trails, and archival communication.
|
||||
|
||||
### 🔄 Reset Template Text
|
||||
|
||||
Click the **Reset** button to restore the template content to its default version.
|
||||
Don’t forget to click **Save** afterward to apply the changes.
|
||||
|
||||
---
|
||||
|
||||
## 🛠️ Additional Notes
|
||||
|
||||
- All custom email templates support **rich text formatting** and **variables** for dynamic content.
|
||||
- Changes to templates take immediate effect and apply to all new documents created after the update.
|
||||
- Organizations can define a consistent template style across all teams to ensure compliance and branding.
|
||||
|
||||
> 💡 **Tip:** Preview your templates before saving to ensure correct formatting and placeholder usage.
|
||||
|
||||
For more assistance with OpenSign™ features or APIs, contact our support team at **[support@opensignlabs.com](mailto:support@opensignlabs.com)**.
|
||||
@@ -0,0 +1,191 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
title: Preferences
|
||||
---
|
||||
|
||||
# 🔧 Preferences
|
||||
|
||||
The **Preferences** page in **OpenSign™** allows users and administrators to tailor the signing experience to suit individual, team, or organizational needs. Below is a breakdown of all configurable options and what they control.
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Steps to Navigate to Preferences
|
||||
|
||||
**Step 1:** Log in to your OpenSign account using valid credentials.
|
||||
|
||||
**Step 2:** Navigate to the **Settings** section and click on **Preferences**.
|
||||
|
||||
---
|
||||
|
||||
## 📌 Signature Types Control
|
||||
|
||||
The **Allowed Signature Types** section defines which signature methods are available to signers:
|
||||
|
||||
- ✅ **Draw**: Create a handwritten signature using a mouse, stylus, or finger.
|
||||
- ✅ **Type**: Type your name and apply it using pre-set font styles.
|
||||
- ✅ **Upload**: Upload a scanned or saved image of your signature.
|
||||
- ✅ **Default**: Use the default signature stored under *My Signature* in settings.
|
||||
|
||||
⚙️ The options selected here determine what appears in the signature widget during document creation and signing. You can also change these preferences while creating a document.
|
||||
|
||||
---
|
||||
|
||||
## 🔄 Multi-Level Signature Type Control
|
||||
|
||||
**OpenSign™** introduces flexible control over signature options at three levels:
|
||||
|
||||
### 🏢 Organization-Level
|
||||
|
||||
Admins can enforce company-wide signing policies by restricting available signature methods platform-wide.
|
||||
|
||||
**Step 1:** Open the profile menu and select **Console Application** to launch the console.
|
||||
|
||||
**Step 2:** Once the Console Application loads, navigate to the **General** menu. Here, admins can configure the allowed signature types at the organization level.
|
||||
|
||||
All users created under your account will only see the signing methods you enable here in their **Preferences**. They will be restricted from using any methods you don't select.
|
||||
|
||||
**Example:**
|
||||
Adam, the administrator of your company account, disables the **Typed** signature option in the **Manage Signature Types** settings. As a result, Ursula, a team member, will no longer see the **Typed** signature option in her preferences.
|
||||
|
||||
Ursula can enable or disable any of the remaining three signature methods for each document she creates.
|
||||
|
||||
When she sends a document to Sofia, a signer, Sofia will only see the signature methods that Ursula selected during the document creation process.
|
||||
|
||||
**Note:** Managing **Signature Types** at the organization level is only available on the **Teams** plan. This feature is not included in the **Professional** or **Free** plans.
|
||||
|
||||

|
||||
|
||||
### 👤 User-Level
|
||||
|
||||
Navigate to **Settings > Preferences** to configure user-level signature types.
|
||||
|
||||
If a user sets preferred types here, only those will appear when adding signature or initial widgets during document creation.
|
||||
|
||||

|
||||
|
||||
### 📄 Document-Level
|
||||
|
||||
While creating a document, users can specify allowed signature types.
|
||||
|
||||
Only these will be available to the signer—useful for legal or regulatory requirements.
|
||||
|
||||

|
||||
|
||||
---
|
||||
|
||||
## 🔔 Notify on Signatures
|
||||
|
||||
The document owner can choose to receive email notifications when a document is signed.
|
||||
|
||||
- **Yes** – Get notified each time a signer completes their part.
|
||||
- **No** – Turn off real-time signature notifications.
|
||||
|
||||
This setting can be adjusted while creating a document or template.
|
||||
|
||||
Regardless of this preference, a **final completion email**—including the signed document and completion certificate—is **always sent** to both the document owner and all signers.
|
||||
|
||||
**Note:** Notify on Signatures feature is only available on the **Professional** and higher plans—it is not included in the **Free** plan.
|
||||
|
||||

|
||||
|
||||
---
|
||||
|
||||
## 📬 Send in Order
|
||||
|
||||
Decide whether the document should be signed **sequentially** or **simultaneously** by multiple signers.
|
||||
|
||||
- **Yes** – Signers receive the document in a set order. The next signer gains access only after the previous one completes signing.
|
||||
- **No** – All signers receive the document at once and can sign independently.
|
||||
|
||||
> Users can change this option while creating the document or a template.
|
||||
|
||||
---
|
||||
|
||||
## 🚫 Enable Tour
|
||||
|
||||
The tour feature provides guidance for first-time users. You can turn this off for a cleaner, uninterrupted experience:
|
||||
|
||||
- **Yes** – Show onboarding tips. Enables guided tooltips for the signer during the signing process.
|
||||
- **No** – Disable tour prompts *(recommended for experienced users)*. Speeds up the signing experience.
|
||||
|
||||
> Users can change this option while creating the document or a template.
|
||||
|
||||
💡 **Tip**: Disable if your users are already familiar with OpenSign™.
|
||||
|
||||
---
|
||||
|
||||
## 🧭 Timezone & Date Format
|
||||
|
||||
Customize the **Timezone** and **Date Format** according to your regional preferences.
|
||||
These settings are reflected in:
|
||||
|
||||
- Document Completion Certificates
|
||||
- Signing Logs
|
||||
- Webhooks
|
||||
|
||||
### 📅 Date Format
|
||||
|
||||
- The selected date format will be applied by default to the date widget if no specific format is chosen during document creation.
|
||||
- This default format also applies in all API flows.
|
||||
|
||||
### 🕒 Time Format
|
||||
|
||||
- Supports **12-hour** and **24-hour** formats.
|
||||
- Affects timestamps in certificates, logs, and webhooks.
|
||||
|
||||

|
||||
|
||||
---
|
||||
|
||||
## 🧪 LTV-Enabled Signatures
|
||||
|
||||
**LTV (Long-Term Validation)** ensures that signatures remain valid and verifiable even after certificates expire or are revoked.
|
||||
|
||||
### 🔐 Key Features:
|
||||
|
||||
- Embeds certificate chain
|
||||
- Includes CRLs and OCSP responses
|
||||
- Enables offline verification
|
||||
- Complies with PDF standards like **PAdES**
|
||||
|
||||
### 📌 Why It Matters:
|
||||
|
||||
Even if a certificate becomes invalid in the future, the LTV-enabled signature remains verifiable.
|
||||
|
||||
### ✅ Use Cases:
|
||||
|
||||
- Legal Contracts
|
||||
- Financial or Medical Records
|
||||
- Long-term archiving requirements
|
||||
|
||||
---
|
||||
|
||||
## 📧 Email Templates
|
||||
|
||||
In the **Preferences > Email** tab, users can customize email templates to personalize communication with signers and stakeholders.
|
||||
This feature helps maintain brand consistency and enhances engagement throughout the signing workflow.
|
||||
|
||||
👉 [📄 Step-by-step guide to setting up custom email templates](https://docs.opensignlabs.com/docs/help/Settings/Custom-email-templates)
|
||||
|
||||
**Note:** The custom email templates feature is only available on the **Professional** and higher plans—it is not included in the **Free** plan.
|
||||
|
||||
---
|
||||
|
||||
## 🔒 Security
|
||||
|
||||
The **Security** tab in OpenSign (found under **Settings > Preferences > Security**) allows users to manage key authentication methods to protect their account access.
|
||||
|
||||
### 🧩 Features Available:
|
||||
|
||||
#### ✅ Two-Factor Authentication (2FA)
|
||||
|
||||
Enhance your account security by enabling 2FA. Once activated, you'll enter a time-based code from an authenticator app each time you log in.
|
||||
|
||||
#### 🛡️ Passkey Authentication
|
||||
|
||||
Passkeys offer a **passwordless**, **phishing-resistant** login experience using your device’s built-in security features such as fingerprint, Face ID, or PIN.
|
||||
|
||||
👉 For full details on setting up **Two-Factor Authentication (2FA)** and **Passkey Authentication**:
|
||||
[🔒 View Security Setup Guide](https://docs.opensignlabs.com/docs/help/Settings/SecurityManagement)
|
||||
|
||||
For more assistance with OpenSign™ features or APIs, contact our support team at **[support@opensignlabs.com](mailto:support@opensignlabs.com)**.
|
||||
@@ -0,0 +1,87 @@
|
||||
---
|
||||
sidebar_position: 9
|
||||
title: Security
|
||||
---
|
||||
import ReactPlayer from 'react-player';
|
||||
|
||||
### ✅ Two-Factor Authentication (2FA)
|
||||
|
||||
Two-Factor Authentication (2FA) adds a second layer of security to your account by requiring **not just your password, but also a time-sensitive code** from a trusted device.
|
||||
|
||||
#### 🔐 What is 2FA?
|
||||
|
||||
2FA combines **something you know** (your password) with **something you have** (like a smartphone or hardware token). This significantly reduces the risk of unauthorized access—even if someone has your password.
|
||||
|
||||
#### 🛡️ Benefits:
|
||||
|
||||
- Enhances account protection against phishing and brute-force attacks
|
||||
- Reduces the risk of unauthorized access from compromised credentials
|
||||
- Helps meet compliance requirements for security-conscious organizations
|
||||
- Only the account owner with access to the authenticator app can log in
|
||||
|
||||
#### 📲 How to Enable:
|
||||
|
||||
1. Go to **Settings > Preferences > Security**
|
||||
2. Click "Setup 2FA" button and scan the displayed QR code with an app like Google Authenticator, Authy, or Microsoft Authenticator.
|
||||
3. Save the recovery codes in a secure location (they allow access if you lose your phone)
|
||||
4. Enter the 6-digit verification code shown in your app to complete setup
|
||||
|
||||
> 🔁 The verification code refreshes every 30 seconds and is unique to your device.
|
||||
> 🔐 If 2FA is enabled, you will be prompted for a verification code every time you log in.
|
||||
|
||||
#### 📹 Watch the Setup Tutorial:
|
||||
|
||||
<div>
|
||||
<ReactPlayer playing controls url='https://www.youtube.com/watch?v=cgVBBetnbO8' />
|
||||
</div>
|
||||
|
||||
### 🛡️ Passkey Authentication
|
||||
|
||||
Passkeys offer **passwordless**, **phishing-resistant**, and **device-bound** sign-in using modern authentication standards.
|
||||
|
||||
#### 🔐 What Are Passkeys?
|
||||
|
||||
Passkeys are cryptographic credentials tied to your device and identity, replacing traditional passwords. They’re based on **FIDO2/WebAuthn** standards and work using **public-private key encryption**, making them highly secure.
|
||||
|
||||
- Instead of typing passwords, you authenticate using biometrics (like Face ID or fingerprint) or a device PIN.
|
||||
- A passkey is stored securely on your device and never shared—so even if attackers phish you, they can’t steal your login info.
|
||||
|
||||
#### 💡 Key Features:
|
||||
|
||||
- Use **fingerprint**, **Face ID**, or **device PIN**
|
||||
- **Passwordless** and **secure** authentication
|
||||
- Resistant to **phishing** and **credential stuffing**
|
||||
- Syncs across devices (when using platforms like iCloud Keychain or Google Password Manager)
|
||||
- Fast, one-tap login experience
|
||||
|
||||
#### 🛠 How to Register a Passkey:
|
||||
|
||||
1. Go to **Settings > Preferences > Security**
|
||||
2. Click **Register passkey**
|
||||
3. Your device prompts biometric or PIN-based authentication
|
||||
4. On success, the passkey is saved and listed under **Your Passkeys**
|
||||
|
||||
> 📌 A passkey is unique to each device/browser combination. You can register multiple passkeys for different environments.
|
||||
|
||||
#### 📹 Watch the Setup Tutorial:
|
||||
|
||||
<div>
|
||||
<ReactPlayer playing controls url='https://www.youtube.com/watch?v=lLfcu9oSbew' />
|
||||
</div>
|
||||
|
||||
#### 🧾 Managing Your Passkeys
|
||||
|
||||
##### ✏️ Rename:
|
||||
|
||||
Click the **pencil icon** to rename a passkey for easy identification.
|
||||
|
||||
##### 🗑 Delete:
|
||||
|
||||
Click the **trash icon** to remove a passkey.
|
||||
⚠️ This revokes access via that method and may require alternate login or re-registration.
|
||||
|
||||
> 🔐 Tip: Register multiple passkeys on different devices for redundancy and ease of access.
|
||||
|
||||
---
|
||||
|
||||
For more assistance with OpenSign™ features or APIs, contact our support team at **[support@opensignlabs.com](mailto:support@opensignlabs.com)**.
|
||||
@@ -0,0 +1,102 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
title: Manage Teams
|
||||
---
|
||||
|
||||
# 👥 Teams Management in OpenSign
|
||||
|
||||
The **Teams** feature in OpenSign allows you to organize your users into structured groups for easier management, permissions control, and streamlined workflow configuration.
|
||||
|
||||
---
|
||||
|
||||
## 🧭 How to Access the Teams Page
|
||||
|
||||
1. Log in to your OpenSign account.
|
||||
2. In the left-hand sidebar, navigate to **Settings → Teams**.
|
||||
|
||||
<img width="436" alt="Navigate-to-Teams" src="https://github.com/user-attachments/assets/2e292fc2-83b9-41b4-b133-451286744547"></img>
|
||||
|
||||
---
|
||||
|
||||
## 📋 Teams Overview
|
||||
|
||||
On the Teams page, you'll see a list of all existing teams. Each row includes:
|
||||
|
||||
| Column | Description |
|
||||
|----------------|------------------------------------------------------------------------------|
|
||||
| **Sr. No** | Serial number of the team in the list. |
|
||||
| **Name** | The name of the team. |
|
||||
| **Parent Team**| The parent team this team belongs to (useful for hierarchical grouping). |
|
||||
| **Active** | Toggle to activate or deactivate the team. |
|
||||
| **Edit** | Click the pencil icon to edit the team name or parent team. |
|
||||
|
||||
- 🟢 **Active** teams are currently usable across OpenSign modules.
|
||||
- ⚪ **Inactive** teams are hidden from functional views but not deleted.
|
||||
|
||||
---
|
||||
|
||||
## ➕ Adding a New Team
|
||||
|
||||
To create a new team:
|
||||
|
||||
1. Click the **➕ Add Team** button at the top-right of the page.
|
||||
2. A modal will appear titled **Add Team**.
|
||||
|
||||
**Fill in the following details:**
|
||||
|
||||
- **Name** (Required): Enter a name for the new team.
|
||||
- **Parent Team**: Choose a parent group (default is **All Users**).
|
||||
|
||||
<img width="436" alt="add team" src="https://github.com/user-attachments/assets/74c042b1-2c31-4d00-81f4-0abeaf0c985c"></img>
|
||||
|
||||
3. Click **Submit** to create the team or **Reset** to clear the form.
|
||||
|
||||
> 📝 **Tip:** Use parent teams to build a team hierarchy — for example, placing _Marketing_ under _HR_.
|
||||
|
||||
<img width="436" alt="New team" src="https://github.com/user-attachments/assets/7f69afeb-c96e-46d4-b5ee-5af9dd656d2a"></img>
|
||||
|
||||
---
|
||||
|
||||
## 🖊️ Editing an Existing Team
|
||||
|
||||
To edit a team:
|
||||
|
||||
1. Click the **pencil icon** next to the team name.
|
||||
2. Modify the team name or parent group.
|
||||
3. Save the changes.
|
||||
|
||||
---
|
||||
|
||||
## 🌐 Where You Can Use the Teams
|
||||
|
||||
1. **Active teams** are available when creating new users — you can select a team from the dropdown and add multiple users under one team.
|
||||
|
||||
<img width="436" alt="create new user" src="https://github.com/user-attachments/assets/3aea0ff3-5aa2-416c-b6cc-7148e7d694e6"></img>
|
||||
|
||||
2. You can also **share templates** with teams. Once a template is shared with a team, **all users in that team can access the template**.
|
||||
|
||||
<img width="436" alt="Share template" src="https://github.com/user-attachments/assets/22ddde66-7cd9-4e4b-a012-8e1e72043d20"></img>
|
||||
<img width="436" alt="Share template with team" src="https://github.com/user-attachments/assets/534556ce-1641-44c1-a794-54033ca01376"></img>
|
||||
|
||||
---
|
||||
|
||||
## 🚫 Deactivating a Team
|
||||
|
||||
To deactivate a team, toggle the **Active** switch off. This will:
|
||||
|
||||
- Prevent users in this team from logging into their OpenSign accounts.
|
||||
- Hide the team from the **Teams dropdown** when adding new users.
|
||||
- Prevent template sharing with deactivated teams.
|
||||
- Preserve team data for future reactivation and audit purposes.
|
||||
|
||||
---
|
||||
|
||||
## ℹ️ Notes
|
||||
|
||||
- The **All Users** team is the default root and **cannot be deleted**.
|
||||
- **Deactivated teams** can be re-enabled anytime using the toggle.
|
||||
- Only users with **administrative privileges** can access and manage the Teams page.
|
||||
|
||||
If you require more help, feel free to reach out to our customer support at **support@opensignlabs.com**.
|
||||
|
||||
**Happy signing with OpenSign™!**
|
||||
@@ -0,0 +1,216 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
title: Webhook
|
||||
---
|
||||
|
||||
# 🔁 Webhook
|
||||
|
||||
## 🔔 What is a Webhook?
|
||||
|
||||
A **webhook** allows one system (like OpenSign) to automatically send real-time data or notifications to another system (like your server) when a specific event occurs.
|
||||
|
||||
Think of it as a **push notification for your backend** — instead of continuously checking for updates (polling), a webhook pushes data to your endpoint **as soon as an event happens**.
|
||||
|
||||
---
|
||||
|
||||
## 🧠 Simple Example
|
||||
|
||||
Suppose you're using OpenSign to collect eSignatures:
|
||||
|
||||
- When someone **signs a document**, OpenSign triggers a **POST request** to your server.
|
||||
- The request includes data such as the document ID, signer email, and signature status.
|
||||
- Your server can then process this information — for example, update your CRM, trigger a workflow, or send a confirmation email.
|
||||
|
||||
---
|
||||
|
||||
## 🧭 How to Add a Webhook in OpenSign
|
||||
|
||||
**Step 1:** Log in to your OpenSign account using your credentials.
|
||||
**Step 2:** Navigate to **Settings → Webhook**.
|
||||
|
||||

|
||||
|
||||
**Step 3:** Click **Add Webhook**.
|
||||
|
||||
- A popup will appear. Enter your **Webhook URL** and click **Yes** to save it.
|
||||
|
||||
> **Note:** To enable **Live Webhook** support, you must upgrade to a **paid plan** — either the **Professional** or **Teams** plan.
|
||||
|
||||

|
||||
|
||||
---
|
||||
|
||||
## 🧪 Sandbox Webhook
|
||||
|
||||
- You can also add webhook for the **Sandbox** environment on the same page.
|
||||
- **Sandbox webhook** are available on all plans, including the **Free** plan, and are ideal for development and testing.
|
||||
|
||||
> **Caution:** Avoid sending sensitive or confidential data to the Sandbox environment.
|
||||
|
||||
📘 **API Reference:**
|
||||
You can also manage your webhooks via our API.
|
||||
See the API documentation here: [Save/Update Webhook API](https://docs.opensignlabs.com/docs/API-docs/save-update-webhook)
|
||||
|
||||
---
|
||||
|
||||
## 📋 Supported Webhook Events
|
||||
|
||||
OpenSign sends event notifications to your configured webhook URL when any of the following actions occur:
|
||||
|
||||
- **Document Created** – A document is created.
|
||||
- **Document Viewed** – A signer viewed the document.
|
||||
- **Document Signed** – A signer signed the document.
|
||||
- **Document Completed** – All required signatures are completed.
|
||||
- **Document Revoked or Declined** – The document was revoked or declined.
|
||||
|
||||
Each notification is sent as a **POST request** with a **JSON payload** containing relevant event data.
|
||||
|
||||
---
|
||||
|
||||
### 🔍 Example Payload: `Document Created`
|
||||
|
||||
```json
|
||||
{
|
||||
"event": "created",
|
||||
"type": "request-sign",
|
||||
"objectId": "kpeg6Q2rO7",
|
||||
"file": "https://legadratw3d.ams3.digitaloceanspaces.com/851de61f62b60a1f62e03232464fa4bf_81wV17MTebsrRoov.pdf?...",
|
||||
"name": "Sample Test Doc",
|
||||
"note": "Please review and sign this document",
|
||||
"description": "",
|
||||
"signers": [
|
||||
{
|
||||
"name": "Peter Mark",
|
||||
"email": "peter.mark1093@gmail.com",
|
||||
"phone": "3556567789"
|
||||
}
|
||||
],
|
||||
"createdAt": "Fri, 16 May 2025 15:02:42 IST"
|
||||
}
|
||||
```
|
||||
### 🔍 Example Payload: `Document Viewed`
|
||||
|
||||
```json
|
||||
{
|
||||
"event": "viewed",
|
||||
"type": "request-sign",
|
||||
"objectId": "kpeg6Q2rO7",
|
||||
"file": "https://legadratw3d.ams3.digitaloceanspaces.com/851de61f62b60a1f62e03232464fa4bf_81wV17MTebsrRoov.pdf?...",
|
||||
"name": "Sample Test Doc",
|
||||
"note": "Please review and sign this document",
|
||||
"description": "",
|
||||
"signers": [
|
||||
{
|
||||
"name": "Peter Mark",
|
||||
"email": "peter.mark1093@gmail.com",
|
||||
"phone": "3556567789"
|
||||
}
|
||||
],
|
||||
"viewedBy": "peter.mark1093@gmail.com",
|
||||
"viewedAt": "Fri, 16 May 2025 16:18:16 IST",
|
||||
"createdAt": "Fri, 16 May 2025 15:02:28 IST"
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 🔍 Example Payload: `Document Signed`
|
||||
|
||||
```json
|
||||
{
|
||||
"event": "signed",
|
||||
"type": "request-sign",
|
||||
"objectId": "kpeg6Q2rO7",
|
||||
"file": "https://legadratw3d.ams3.digitaloceanspaces.com/bc2eb56cc9d29a5f222e4a4b5dbbcfbf_signed_sample_test_doc_4858.pdf?...",
|
||||
"name": "Sample Test Doc",
|
||||
"note": "Please review and sign this document",
|
||||
"description": "",
|
||||
"signer": {
|
||||
"name": "Peter Mark",
|
||||
"email": "peter.mark1093@gmail.com",
|
||||
"phone": "3556567789"
|
||||
},
|
||||
"signedAt": "Fri, 16 May 2025 16:18:34 GMT+5:30",
|
||||
"createdAt": "Fri, 16 May 2025 15:02:28 GMT+5:30"
|
||||
}
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
### 🔍 Example Payload: `Document Completed`
|
||||
|
||||
```json
|
||||
{
|
||||
"event": "completed",
|
||||
"type": "request-sign",
|
||||
"objectId": "kpeg6Q2rO7",
|
||||
"file": "https://legadratw3d.ams3.digitaloceanspaces.com/bc2eb56cc9d29a5f222e4a4b5dbbcfbf_signed_sample_test_doc_4858.pdf?...",
|
||||
"certificate": "https://legadratw3d.ams3.digitaloceanspaces.com/9c954912f529acb7e4d065ec0521a63b_certificate.pdf?...",
|
||||
"name": "Sample Test Doc",
|
||||
"note": "Please review and sign this document",
|
||||
"description": "",
|
||||
"signers": [
|
||||
{
|
||||
"name": "Peter Mark",
|
||||
"email": "peter.mark1093@gmail.com",
|
||||
"phone": "3556567789"
|
||||
}
|
||||
],
|
||||
"completedAt": "Fri, 16 May 2025 16:18:35 GMT+5:30",
|
||||
"createdAt": "Fri, 16 May 2025 15:02:28 GMT+5:30"
|
||||
}
|
||||
```
|
||||
---
|
||||
|
||||
### 🔍 Example Payload: `Document Declined`
|
||||
|
||||
```json
|
||||
{
|
||||
"event": "declined",
|
||||
"type": "request-sign",
|
||||
"objectId": "1gtDMBHpEY",
|
||||
"file": "https://legadratw3d.ams3.digitaloceanspaces.com/e90c32a45351eb52eb00e0054ae50566_581ZmOn4CwAqnxSF.pdf?...",
|
||||
"name": "Sample Test Doc ",
|
||||
"note": "Please review and sign this document",
|
||||
"description": "",
|
||||
"signers": [
|
||||
{
|
||||
"name": "Peter Mark",
|
||||
"email": "peter.mark1093@gmail.com",
|
||||
"phone": "9283784545554"
|
||||
}
|
||||
],
|
||||
"declinedBy": "peter.mark1093@gmail.com",
|
||||
"declinedReason": "Invalid date format used.",
|
||||
"declinedAt": "Fri, 16 May 2025 16:25:38 IST",
|
||||
"createdAt": "Fri, 16 May 2025 16:24:28 IST"
|
||||
}
|
||||
```
|
||||
---
|
||||
|
||||
## ❓ Frequently Asked Questions
|
||||
|
||||
### 1. What is the OpenSign Sandbox environment?
|
||||
|
||||
The Sandbox is a testing environment designed for developers to safely experiment with OpenSign APIs and workflows. It mirrors the live environment but with testing limitations.
|
||||
|
||||
---
|
||||
|
||||
### 2. Can I use my Live Webhook in the Sandbox?
|
||||
|
||||
No. **Live Webhooks do not work** in the Sandbox environment. You must configure a separate webhook specifically for Sandbox testing.
|
||||
|
||||
---
|
||||
|
||||
### 3. Can I test all webhook events in the Sandbox?
|
||||
|
||||
Yes. The Sandbox environment supports all event types, including `created`, `viewed`, `signed`, `completed`, and `revoked/declined`.
|
||||
However, some behaviors may be simulated for testing purposes.
|
||||
|
||||
---
|
||||
|
||||
## 💬 Need Help?
|
||||
|
||||
If you need help testing your webhook or integrating it into your application, feel free to reach out to our support team at [support@opensignlabs.com](mailto:support@opensignlabs.com).
|
||||
|
||||
**Happy signing with OpenSign™!**
|
||||
@@ -1,17 +1,17 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
sidebar_position: 7
|
||||
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.
|
||||
Using this id you can verify 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
|
||||
- Turn the 'Disable DocumentId' switch to on
|
||||
- Click 'save'
|
||||
|
||||
<img width="436" alt="image" src="https://github.com/OpenSignLabs/OpenSign/assets/5486116/ee4433c7-1af7-4b74-800d-500060c0642d"></img>
|
||||
|
||||
@@ -1,52 +1,137 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
sidebar_position: 6
|
||||
title: Manage users
|
||||
---
|
||||
|
||||
# User Management
|
||||
# 👤 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.
|
||||
The **User Management** feature in OpenSign allows administrators to add, edit, and manage users within the platform. This functionality is available on **Self-Hosted**, **Teams**, and **Enterprise** plans.
|
||||
|
||||
## 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.
|
||||
> ✅ Only users with the roles **Admin** or **OrgAdmin** have permission to access and manage users.
|
||||
|
||||
---
|
||||
|
||||
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)
|
||||
## 🧭 Accessing User Management
|
||||
|
||||
To access the user management panel:
|
||||
|
||||
1. Log in to your OpenSign account.
|
||||
2. In the left-hand sidebar, navigate to **Settings → Users**.
|
||||
|
||||
<img width="436" alt="Navigate-to-users" src="https://github.com/user-attachments/assets/9f34201c-fda7-406b-9a78-49a5459269cd"></img>
|
||||
|
||||
A list of existing users will be displayed.
|
||||
|
||||
---
|
||||
|
||||
## ➕ Adding a New User
|
||||
|
||||
To add a new user:
|
||||
|
||||
1. **Click the ➕ Add User Button**
|
||||
|
||||
2. **Fill in the User Information**
|
||||
|
||||
| Field | Required | Description |
|
||||
|--------------|----------|-----------------------------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| **Name** | ✅ Yes | Enter the user's full name. |
|
||||
| **Email** | ✅ Yes | Enter a valid email address. |
|
||||
| **Password** | ✅ Yes | The system auto-generates a password. **Copy it immediately** as it will be shown only once. |
|
||||
| **Phone** | ❌ No | (Optional) Enter the user’s phone number. |
|
||||
| **Team** | ✅ Yes | Select the team the user belongs to from the dropdown.<br />_Note: Teams must be created beforehand under **Settings → Teams** (available in Teams & Enterprise plans)._ |
|
||||
| **Role** | ✅ Yes | Choose one of the following roles: |
|
||||
| | | - **OrgAdmin**: Full access, including user and team management. |
|
||||
| | | - **Editor**: Can create and share templates but **cannot manage users**. |
|
||||
| | | - **User**: Can use templates for signing but **cannot share** them or manage users. |
|
||||
|
||||
<img width="436" alt="Add-user-form" src="https://github.com/user-attachments/assets/c176dd4f-257d-42e2-be7f-a05a1f7e4094"></img>
|
||||
|
||||
3. **Submit or Cancel**
|
||||
- Click **Submit** to create the user.
|
||||
- Click **Cancel** to exit without saving.
|
||||
|
||||
> 🔒 **Note:** Once a user is created, the password will not be visible again. If needed, you can use the **"Forgot Password"** option on the login page to reset it.
|
||||
|
||||
<img width="436" alt="new user" src="https://github.com/user-attachments/assets/647c40d8-061d-4e0a-b62c-302296e83493"></img>
|
||||
|
||||
---
|
||||
|
||||
## 🔁 Managing User Status
|
||||
|
||||
- **Activate/Deactivate Users**
|
||||
- Use the toggle in the **Active** column to enable or disable a user’s account.
|
||||
- **Deactivated users** will not be able to log in to OpenSign until reactivated.
|
||||
|
||||
---
|
||||
|
||||
## 🔐 Permissions by Role
|
||||
|
||||
| Role | Manage Users | Create Templates | Share Templates with Teams | Use Templates |
|
||||
|-------------|---------------|------------------|-----------------------------|---------------|
|
||||
| **OrgAdmin** | ✅ Yes | ✅ Yes | ✅ Yes | ✅ Yes |
|
||||
| **Editor** | ❌ No | ✅ Yes | ✅ Yes | ✅ Yes |
|
||||
| **User** | ❌ No | ✅ Yes | ❌ No | ✅ Yes |
|
||||
|
||||
---
|
||||
|
||||
## 👥 Buy More Users (Buy Additional Seats)
|
||||
|
||||
OpenSign allows you to create users based on the number of seats included in your selected plan. For example, if your current plan includes **2 users**, you can only create **2 users** by default. To add a **third user**, you must **purchase additional seats**.
|
||||
|
||||
### Steps to Buy More Users
|
||||
|
||||
1. **Click "Buy more users"**
|
||||
2. A popup titled **Add Seats** will appear.
|
||||
3. **Enter Quantity** – specify how many additional users (seats) you want to purchase.
|
||||
4. The **cost** will be calculated automatically based on your plan rate (e.g., USD 100 per user).
|
||||
5. Click the **Proceed** button to finalize the purchase.
|
||||
6. The seats will be **immediately added** to your account.
|
||||
|
||||
<img width="436" alt="buy-more-seats" src="https://github.com/user-attachments/assets/2e093a64-1b75-4543-b4c4-1186d4c02b09"></img>
|
||||
|
||||
7. Once you’ve purchased additional seats, click the **"+" Add User** button to create the new user.
|
||||
|
||||
> 💡 **Tip:** You can also purchase additional seats in advance to avoid interruptions during user onboarding.
|
||||
|
||||
---
|
||||
|
||||
### 🔢 Understanding "Available Seats"
|
||||
|
||||
At the bottom-right of the **Users** page, you’ll see the **Available seats** status.
|
||||
|
||||
<img width="436" alt="seat-availability" src="https://github.com/user-attachments/assets/37c2a5c7-0d4b-4bd2-8fb1-11def9e65b42"></img>
|
||||
|
||||
**Example:**
|
||||
`Available seats: 2/3`
|
||||
|
||||
This means:
|
||||
- **2 seats** are currently available for creating new users.
|
||||
- **3** is the **total number of user seats** your organization has purchased.
|
||||
|
||||
If the available seats count is **0**, you must **buy more seats** before adding new users.
|
||||
|
||||
---
|
||||
|
||||
## 📌 Frequently Asked Questions (FAQ)
|
||||
|
||||
**Q: How do I pay for purchased add-on users?**
|
||||
**A:** After purchasing additional users (seats), your saved card will be charged automatically, and an invoice will be emailed to your registered address.
|
||||
If no card is on saved, a payment link will be sent to your email to complete the transaction.
|
||||
|
||||
---
|
||||
|
||||
## 📣 Need Help?
|
||||
|
||||
If you need further assistance, feel free to reach out to our customer support at **support@opensignlabs.com**.
|
||||
|
||||
For more support and updates, follow us on:
|
||||
|
||||
- 🌐 [Website](http://www.opensignlabs.com)
|
||||
- 🐦 [Twitter](https://twitter.com/OpenSignHQ)
|
||||
- 📘 [Facebook](https://www.facebook.com/profile.php?id=61551030403669)
|
||||
- 💼 [LinkedIn](https://www.linkedin.com/company/opensignhq/)
|
||||
- 📺 [YouTube](https://www.youtube.com/@opensignhq)
|
||||
|
||||
---
|
||||
|
||||
Happy signing with **OpenSign™**!
|
||||
|
||||
@@ -33,11 +33,11 @@ Creating a template in OpenSign is straightforward and can significantly enhance
|
||||
- **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)
|
||||
### Auto reminder (feature only available 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** :
|
||||
- **[8] Enable OTP Verification** :
|
||||
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**:
|
||||
@@ -81,41 +81,41 @@ If set to "Yes," the signer will see the tour guide while signing the document.
|
||||
- **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.
|
||||
- Copy : Clicking on this you can duplicate 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.
|
||||
- Copy : Clicking on this you can duplicate 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.
|
||||
- Copy : Clicking on this you can duplicate 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.
|
||||
- Copy : Clicking on this you can duplicate 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.
|
||||
- Copy : Clicking on this you can duplicate 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.
|
||||
- Copy : Clicking on this you can duplicate 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 are a few options available such as setting the minimum and maximum checks, making the checkbox read-only, and hiding the label.
|
||||
- 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.
|
||||
- Copy : Clicking on this you can duplicate 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 are a few options available such as setting a default value and marking the dropdown as 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.
|
||||
- Copy : Clicking on this you can duplicate 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 are a few options available such as setting a default value, making the radio button read-only, and hiding the label.
|
||||
- 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.
|
||||
- Copy : Clicking on this you can duplicate 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.
|
||||
- Copy : Clicking on this you can duplicate 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.
|
||||
|
||||
@@ -97,7 +97,7 @@ If you are the only signer, the signing process is finished, and you will have t
|
||||
|
||||
## 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.
|
||||
- This feature is available on all paid plans.
|
||||
|
||||
If you require more help, feel free to reach out to our customer support on support@opensignlabs.com.
|
||||
|
||||
|
||||
@@ -28,7 +28,7 @@ title: Quickly Send the Document for Signature Using Template
|
||||
- **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)
|
||||
### Step 5: Auto reminder (feature only available 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.
|
||||
|
||||
|
||||
@@ -27,7 +27,7 @@ title: Use template to create documents
|
||||
- **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)
|
||||
### Step 5: Auto reminder (feature only available 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.
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@ title: Digital Ocean
|
||||
---
|
||||
# Digital Ocean
|
||||
|
||||
OpenSign application consistes of 3 components -
|
||||
OpenSign application consists of 3 components -
|
||||
- ReactJS frontend
|
||||
- NodeJS API
|
||||
- MongoDB database
|
||||
|
||||
@@ -14,7 +14,7 @@ title: AWS S3
|
||||

|
||||

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

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

|
||||
@@ -32,7 +32,8 @@ title: AWS S3
|
||||
],
|
||||
"AllowedOrigins": [
|
||||
"https://localhost:3001",
|
||||
"https://app.opensignlabs.com"
|
||||
"https://app.opensignlabs.com",
|
||||
"https://eu-app.opensignlabs.com"
|
||||
],
|
||||
"ExposeHeaders": [
|
||||
"x-amz-server-side-encryption",
|
||||
|
||||
@@ -69,12 +69,11 @@ Once the deployment is successful, the application will be accessible at [https:
|
||||
## 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:
|
||||
Add below Environment Variables to the ".env.prod" file that is automatically created in order to personalize your installation:
|
||||
|
||||
| Environment Varibale | Value | Description |
|
||||
| Environment Variable | 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. |
|
||||
@@ -89,13 +88,16 @@ Add below Environment Varaibles to the ".env.prod" file that is automatically cr
|
||||
| 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
|
||||
| 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_USERNAME | - | Provide username of smtp |
|
||||
| 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.|
|
||||
| PASS_PHRASE | opensign | Pass phrase of PFX or p12 document signing certificate file. |
|
||||
| APP_ID | opensign | (DEPRECATED) This should not be changed if provided; it should be 'opensign'. |
|
||||
|
||||
|
||||
# Steps to Generate Self Sign Certificate
|
||||
```
|
||||
|
||||
@@ -18,46 +18,56 @@ 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.
|
||||
|
||||
## Running on a custom domain
|
||||
**linux/MacOS**
|
||||
```
|
||||
curl --remote-name-all https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/docker-compose.yml && docker compose pull
|
||||
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 && 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
|
||||
$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; docker compose pull
|
||||
```
|
||||
**Windows** (Command Prompt)
|
||||
```
|
||||
curl -O https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/docker-compose.yml && docker compose pull
|
||||
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 && 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.
|
||||
|
||||
## Running locally
|
||||
**linux/MacOS**
|
||||
```
|
||||
curl --remote-name-all https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/docker-compose.yml https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/Caddyfile && docker compose pull
|
||||
```
|
||||
**Windows** (Powershell)
|
||||
```
|
||||
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; docker compose pull
|
||||
```
|
||||
**Windows** (Command Prompt)
|
||||
```
|
||||
curl -O https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/docker-compose.yml && curl -O https://raw.githubusercontent.com/OpenSignLabs/OpenSign/main/Caddyfile && 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
|
||||
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.
|
||||
- If you want to view the logs, avoid using the -d flag.
|
||||
|
||||
<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.
|
||||
**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.
|
||||
|
||||
@@ -0,0 +1,197 @@
|
||||
---
|
||||
title: OpenSign Deployment Guide on Azure VM via command-line
|
||||
---
|
||||
|
||||
# 🚀 OpenSign Deployment Guide on Azure VM (Frontend + Backend + MongoDB + Caddy)
|
||||
|
||||
## 🧱 Prerequisites
|
||||
|
||||
- Azure CLI installed
|
||||
- A domain you control (e.g., `yourdomain.com`)
|
||||
- Subdomain pointing to your VM (e.g., `opensign.yourdomain.com`)
|
||||
- SSH access
|
||||
|
||||
---
|
||||
|
||||
## 🔧 Step 1: Create an Azure VM
|
||||
|
||||
### 1.1 Create Resource Group
|
||||
```bash
|
||||
az group create --name OpenSignRG --location eastus
|
||||
```
|
||||
|
||||
### 1.2 Create Ubuntu VM
|
||||
```bash
|
||||
az vm create \
|
||||
--resource-group OpenSignRG \
|
||||
--name opensign-vm \
|
||||
--image Ubuntu2404 \
|
||||
--admin-username azureuser \
|
||||
--generate-ssh-keys \
|
||||
--size Standard_B1ms
|
||||
```
|
||||
|
||||
### 1.3 Get VM IP
|
||||
```bash
|
||||
az vm list-ip-addresses --name opensign-vm --resource-group OpenSignRG --output table
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔐 Step 2: Open Required Ports
|
||||
|
||||
Azure’s default port-opening approach conflicts if you use the same priorities. So instead, **add rules with increasing priorities** manually:
|
||||
|
||||
### 2.1 Get NSG name
|
||||
```bash
|
||||
az network nsg list --resource-group OpenSignRG --query "[].name"
|
||||
```
|
||||
|
||||
Assume it’s `opensign-vmNSG`. Then:
|
||||
|
||||
### 2.2 Add inbound port rules
|
||||
```bash
|
||||
az network nsg rule create \
|
||||
--resource-group OpenSignRG \
|
||||
--nsg-name opensign-vmNSG \
|
||||
--name Allow-HTTP \
|
||||
--priority 1001 \
|
||||
--direction Inbound \
|
||||
--protocol Tcp \
|
||||
--access Allow \
|
||||
--destination-port-ranges 80
|
||||
|
||||
az network nsg rule create \
|
||||
--resource-group OpenSignRG \
|
||||
--nsg-name opensign-vmNSG \
|
||||
--name Allow-HTTPS \
|
||||
--priority 1002 \
|
||||
--direction Inbound \
|
||||
--protocol Tcp \
|
||||
--access Allow \
|
||||
--destination-port-ranges 443
|
||||
|
||||
az network nsg rule create \
|
||||
--resource-group OpenSignRG \
|
||||
--nsg-name opensign-vmNSG \
|
||||
--name Allow-Caddy-Internal \
|
||||
--priority 1003 \
|
||||
--direction Inbound \
|
||||
--protocol Tcp \
|
||||
--access Allow \
|
||||
--destination-port-ranges 3001
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🌍 Step 3: Point Domain to VM
|
||||
|
||||
In your DNS provider (e.g., GoDaddy, Cloudflare):
|
||||
|
||||
- Add an **A record**:
|
||||
- Name: `opensign`
|
||||
- Value: `<your VM public IP>`
|
||||
- TTL: 1 min or Auto
|
||||
|
||||
Let it propagate (~5–10 mins).
|
||||
|
||||
---
|
||||
|
||||
## 📦 Step 4: SSH into the VM
|
||||
|
||||
```bash
|
||||
ssh azureuser@<your-vm-ip>
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🐳 Step 5: Install Docker + Compose V2
|
||||
|
||||
```bash
|
||||
sudo apt update && sudo apt install docker.io -y
|
||||
|
||||
# Install Compose V2 (CLI plugin)
|
||||
mkdir -p ~/.docker/cli-plugins/
|
||||
curl -SL https://github.com/docker/compose/releases/download/v2.24.5/docker-compose-linux-x86_64 -o ~/.docker/cli-plugins/docker-compose
|
||||
chmod +x ~/.docker/cli-plugins/docker-compose
|
||||
|
||||
# Enable Docker
|
||||
sudo systemctl enable docker
|
||||
```
|
||||
|
||||
Verify:
|
||||
```bash
|
||||
docker compose version
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📁 Step 6: Set Up Project and Volumes
|
||||
|
||||
### 6.1 Create a working directory
|
||||
```bash
|
||||
mkdir opensign && cd opensign
|
||||
```
|
||||
|
||||
### 6.2 Download files
|
||||
```bash
|
||||
export 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
|
||||
mv .env.local_dev .env.prod
|
||||
```
|
||||
Make sure that you update the SMTP settings by editing the .env.prod file in order to receive emails.
|
||||
---
|
||||
|
||||
|
||||
## ⚙️ Step 7: Start the Stack
|
||||
|
||||
Now boot the containers using Compose V2:
|
||||
|
||||
```bash
|
||||
docker compose up -d --force-recreate
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ✅ Step 8: Verify Everything
|
||||
|
||||
- `https://opensign.yourdomain.com` loads the app with HTTPS
|
||||
- Caddy fetched SSL certs automatically
|
||||
- Backend routes work at `/api/*`
|
||||
- MongoDB persists data
|
||||
- Uploaded files persist via `opensign-files` volume
|
||||
|
||||
Test:
|
||||
|
||||
```bash
|
||||
docker exec -it OpenSignServer-container ls /usr/src/app/files
|
||||
docker volume inspect opensign-files
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📦 Step 9: Auto-start on Reboot (optional)
|
||||
|
||||
```bash
|
||||
crontab -e
|
||||
```
|
||||
|
||||
Add:
|
||||
```bash
|
||||
@reboot cd /home/azureuser/opensign && docker compose up -d
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔄 Backups (optional)
|
||||
|
||||
```bash
|
||||
# Backup MongoDB volume
|
||||
docker run --rm -v opensign_data-volume:/data -v $(pwd):/backup ubuntu tar czvf /backup/mongo-backup.tar.gz /data
|
||||
|
||||
# Backup OpenSign files
|
||||
docker run --rm -v opensign_opensign-files:/data -v $(pwd):/backup ubuntu tar czvf /backup/files-backup.tar.gz /data
|
||||
```
|
||||
@@ -5,32 +5,39 @@ title: ENV variables which are used to setup OpenSign™ with Docker on Localhos
|
||||
## 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 Variables:
|
||||
|
||||
| Environment Varibale | Value | Description |
|
||||
[//]: # "| appName | open_sign_server | Name of the app. It will be visible in the verification emails sent out. |"
|
||||
[//]: # "| 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. |"
|
||||
|
||||
| Environment Variable | 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. |
|
||||
| PUBLIC_URL | https://localhost:3001 | Set it to the URL form where the app home page will be accessed |
|
||||
| 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) |
|
||||
| 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://DOSPACENAME.ams3.digitaloceanspaces.com | Digital ocean baseurl or AWS S3 base URL |
|
||||
| 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 | FALSE | To use local file storage to save file |
|
||||
| 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_USERNAME | - | Provide username of smtp |
|
||||
| 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.|
|
||||
| PASS_PHRASE | opensign | Pass phrase of PFX or p12 document signing certificate file. |
|
||||
| APP_ID | opensign | (DEPRECATED) This should not be changed if provided; it should be 'opensign'. |
|
||||
|
||||
# Steps to generate self-signed document singing certificate
|
||||
```
|
||||
|
||||
@@ -75,6 +75,17 @@ const config = {
|
||||
sidebarOptions: {
|
||||
groupPathsBy: "tag", // generate a sidebar.js slice that groups operations by tag
|
||||
},
|
||||
version: "1.0",
|
||||
label: "v1.0",
|
||||
baseUrl: "1.0",
|
||||
versions: {
|
||||
"1.1": {
|
||||
specPath: "docs/API-docs/opensign.yaml",
|
||||
outputDir: "docs/API-docs-1.1",
|
||||
label: "v1.1",
|
||||
baseUrl: "1.1",
|
||||
},
|
||||
},
|
||||
}
|
||||
}
|
||||
},
|
||||
|
||||
Generated
+12091
-7608
File diff suppressed because it is too large
Load Diff
+8
-8
@@ -14,22 +14,22 @@
|
||||
"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",
|
||||
"@docusaurus/core": "^3.7.0",
|
||||
"@docusaurus/plugin-content-docs": "^3.7.0",
|
||||
"@docusaurus/preset-classic": "^3.7.0",
|
||||
"@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",
|
||||
"docusaurus-plugin-openapi-docs": "^4.3.4",
|
||||
"docusaurus-theme-openapi-docs": "^4.3.4",
|
||||
"prism-react-renderer": "^2.1.0",
|
||||
"react": "^18.0.0",
|
||||
"react-dom": "^18.0.0",
|
||||
"react-player": "2.14.1"
|
||||
"react-player": "^2.16.0"
|
||||
},
|
||||
"devDependencies": {
|
||||
"@docusaurus/module-type-aliases": "3.0.0",
|
||||
"@docusaurus/types": "3.0.0"
|
||||
"@docusaurus/module-type-aliases": "^3.7.0",
|
||||
"@docusaurus/types": "^3.7.0"
|
||||
},
|
||||
"browserslist": {
|
||||
"production": [
|
||||
|
||||
+1
-2
@@ -10,7 +10,6 @@
|
||||
*/
|
||||
|
||||
// @ts-check
|
||||
import apiSidebar from './docs/API-docs/sidebar.ts';
|
||||
|
||||
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
|
||||
const sidebars = {
|
||||
@@ -18,7 +17,7 @@ const sidebars = {
|
||||
tutorialSidebar: [{type: 'autogenerated', dirName: 'help'}],
|
||||
selfhostSidebar: [{type: 'autogenerated', dirName: 'self-host'}],
|
||||
contributeSidebar: [{type: 'autogenerated', dirName: 'contribute'}],
|
||||
apiSidebar: apiSidebar,
|
||||
apiSidebar: [{type: 'autogenerated', dirName: 'API-docs'}],
|
||||
|
||||
|
||||
// But you can create a sidebar manually
|
||||
|
||||
Reference in New Issue
Block a user