mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-08-22 15:42:31 +02:00
version updates
This commit is contained in:
nxglabs
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>
|
||||
|
||||
@@ -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>
|
||||
|
||||
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": [
|
||||
|
||||
Reference in New Issue
Block a user