mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-08-31 04:09:46 +02:00
docs: OpenAPI setup
This commit is contained in:
nxglabs
File diff suppressed because it is too large
Load Diff
@@ -0,0 +1,637 @@
|
||||
---
|
||||
id: create-user
|
||||
title: "Create user"
|
||||
description: "This can only be done by the logged in user."
|
||||
sidebar_label: "Create user"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJztV99v2jAQ/lesPK0SEGi7PfBUVlVVt6qg0WqTKJqc5CBuEzuznVKE8r/vzgkh0F/seUg8kPN35/Pddz7fyrN8brz+xLOQZgm3YLxpy4vAhFpkVijp9b3bWBgWcsmUTJYsABYpCSxYMhsDS9R8DhETkuUGdMdreSoDzUn1KkLlUANavcM1XNLwJwdjv6po6fVXO9ucO2Tk7DAVPEBoUSVU0oK0BOdZlojQmfYfDOmsPBPGkHL6Z5cZoJVaMdPkiBV4IlwVUQMj0OTcOTRTOuW2FH05RQE8c4wDgnrdouWRK5Kn0NA1Vgs5byI9DIM7HyrMhDb25kONbyqWBE/4XmhEGILjSUXyPvYBLZ85XCdUKSll3JiF0tH7er3jk9PPDh5jcvfEUnjGltvcvBrc7fRSiFiF3g78yfFW4Au0/Jy6c5axd/vQflZY50AZbRQ0GVGpHAhxIERFiPZisWiT3XauE5ChiiA6UOT/pggBNZhMSVMmOYIZzxP7sh2ZPAzBmFmesLqjHfrRgVuHfnQgxN6XDcpSsLGil3CmjEs7tzF++esHdyKcGDWeQNNTfOVhu0JEbG1m+r6PpOogU6QRc5nwwFDcUCj8p55XTEkzzLWwyzExrSQTrv5+hGXj0Cj5joLW2uNf7RHXBtqDtVxQCGLgUUVlutB+bJ7rF+vTl0ztdZvcqwm2xa+SRE0OVUSpebJLhiYXqiTW+a6/mzntFeT4TLmDVrEfYqjGGCo2GF0xDNGr0wz+aDlSYZ7ibe4qlmHK2Y42C7jBkQQXadahRZKfdHrMZBCKWVXsHXYv7+VYpUDTC7WMRMhH07+XbTYZzhAmeMJ+QmCEhemndWbxffIis0dO51LYOA+Yhkxt4HMndOlvatUfR3hWCzo1w9kY2SRCqFj0xla+A/tVU+Oha2rr1FSis10ldyugaeyfjQIYXI6uMSxdyk9N3j1c9q+vzi9uxhdklehfpqjX6aIpqnUsmZTLxkblkOhmxN3Mrja9+V9H1qpILDxbH4tSuLvPHWRV1etmQHb1imUXUzmjfLUijtzppChIjBWjsfAm+PeJa8EDIuVkivaq4qICd7XpnZfutm9pd4IneVmqH71hi9baxADfKJl9Q9m9SeiGqK+g0XB8i+Cgmr9TtEa318Zyq/lBbhfFXysscmQ=
|
||||
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"}
|
||||
>
|
||||
Create user
|
||||
</h1>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"post"}
|
||||
path={"/templatelist"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
This can only be done by the logged in user.
|
||||
|
||||
## Request
|
||||
|
||||
<MimeTabs
|
||||
className={"openapi-tabs__mime"}
|
||||
schemaType={"request"}
|
||||
>
|
||||
<TabItem
|
||||
label={"application/json"}
|
||||
value={"application/json"}
|
||||
>
|
||||
<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"}}
|
||||
>
|
||||
|
||||
|
||||
Created user object
|
||||
|
||||
|
||||
</div>
|
||||
</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={"username"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"theUser"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"firstName"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"John"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"lastName"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"James"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"email"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"john@email.com"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"password"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"12345"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"phone"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"12345"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"userStatus"}
|
||||
required={false}
|
||||
schemaName={"int32"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","description":"User Status","format":"int32","example":1}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"application/xml"}
|
||||
value={"application/xml"}
|
||||
>
|
||||
<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"}}
|
||||
>
|
||||
|
||||
|
||||
Created user object
|
||||
|
||||
|
||||
</div>
|
||||
</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={"username"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"theUser"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"firstName"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"John"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"lastName"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"James"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"email"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"john@email.com"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"password"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"12345"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"phone"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"12345"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"userStatus"}
|
||||
required={false}
|
||||
schemaName={"int32"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","description":"User Status","format":"int32","example":1}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"application/x-www-form-urlencoded"}
|
||||
value={"application/x-www-form-urlencoded"}
|
||||
>
|
||||
<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"}}
|
||||
>
|
||||
|
||||
|
||||
Created user object
|
||||
|
||||
|
||||
</div>
|
||||
</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={"username"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"theUser"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"firstName"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"John"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"lastName"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"James"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"email"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"john@email.com"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"password"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"12345"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"phone"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"12345"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"userStatus"}
|
||||
required={false}
|
||||
schemaName={"int32"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","description":"User Status","format":"int32","example":1}}
|
||||
>
|
||||
|
||||
</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={"int64"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int64","example":10}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"username"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"theUser"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"firstName"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"John"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"lastName"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"James"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"email"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"john@email.com"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"password"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"12345"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"phone"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"12345"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"userStatus"}
|
||||
required={false}
|
||||
schemaName={"int32"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","description":"User Status","format":"int32","example":1}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"Example (from schema)"}
|
||||
value={"Example (from schema)"}
|
||||
>
|
||||
<ResponseSamples
|
||||
responseExample={"{\n \"id\": 10,\n \"username\": \"theUser\",\n \"firstName\": \"John\",\n \"lastName\": \"James\",\n \"email\": \"john@email.com\",\n \"password\": \"12345\",\n \"phone\": \"12345\",\n \"userStatus\": 1\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={"username"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"theUser"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"firstName"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"John"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"lastName"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"James"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"email"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"john@email.com"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"password"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"12345"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"phone"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"12345"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"userStatus"}
|
||||
required={false}
|
||||
schemaName={"int32"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","description":"User Status","format":"int32","example":1}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"Example (from schema)"}
|
||||
value={"Example (from schema)"}
|
||||
>
|
||||
<ResponseSamples
|
||||
responseExample={"<root>\n <id>10</id>\n <username>theUser</username>\n <firstName>John</firstName>\n <lastName>James</lastName>\n <email>john@email.com</email>\n <password>12345</password>\n <phone>12345</phone>\n <userStatus>1</userStatus>\n</root>"}
|
||||
language={"xml"}
|
||||
>
|
||||
|
||||
</ResponseSamples>
|
||||
</TabItem>
|
||||
</SchemaTabs>
|
||||
</TabItem>
|
||||
</MimeTabs>
|
||||
</div>
|
||||
</TabItem>
|
||||
</ApiTabs>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -0,0 +1,101 @@
|
||||
---
|
||||
id: delete-order
|
||||
title: "Delete purchase order by ID"
|
||||
description: "For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors"
|
||||
sidebar_label: "Delete purchase order by ID"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJzFVFFr2zAQ/iuHnlpI44SVPYQ9LCxZCStLWTo2aEOR7XMsakuuJKcLwf99nxxnydJtbE+DQOTTd7q777u7rfBy5cToTnguq0J6dmLZEym7xKrKK6PFSLw3ltayUClZdpXRjsnbDSntecWWZhNHz8rnAVMzvaHhYDDo01hvfK70imRs1twaCQ9pozvH4FUUtGLNFoFpfDMjttZYJ3rCVMGI+LMUGaRcsOe5TdnirpJWlvi2IfGt0PgAZl/Ag0qBUSHxSvpcnFYzm5DJyOeMbPAeTtKTZk4deUMx0y5YeMTyU60sjiNva+4Jl+RcSjHaCr+pQsyuEkAzY0vpd6bXl6JplsF9x5YLHpeDQfg7yUXveEVOrq6qQiFW0wP28iW2rR70ecpMrYEDECzk5kBQyw1KHoloz0a0PeKlAcCxXe+Zq20BbO595UZRJKuqD9q1UytdyNj1E1PCqKL1UIRyHCe1VX6zCCzsisLtwyNvjhiB5QMMvb0qXy9upHV8Md7bW2FylkHKUILSmWn9lS+CwxwZLJBB2w6IfCrfba4c4ReuU5PUJWvfNgposXTiTbF0nBIug97hMthf9YfkKk5UppLWtU/3+l4vTMlUO87qggqlH93oXl/Q3TwDTMmCvnDslOfl2Z6w5+fnF4Sdtz5XGIc6xrhU5gBftcaW1WOvHx/nqBVNXbp5toBIKuFOnN+EilpwBK/EgIPEBxrRnyqI2pnenjqF9irwNNoywDuVxlc316BlgLcOPfEXKUfXs3fTj4tpeDV01U6iYX+Ap2CqjPOl1EeBJm2fUlXbJIc03QjGG0zAqdLbtgao+582UNfQnr/5CAOEvm06drbdlB2WJuCj4/2DaclRe4Bst6EHP9uiaYL5qWaLebnDcS2tknFoeoxiqlw4Y5YzWTj+Axdnn7qtdE7/sMp+Wc1+ZnUYzJY7fOHYjvRPC7VZHm+byfR6egvRm+8IziRL
|
||||
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 purchase order by ID
|
||||
</h1>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"delete"}
|
||||
path={"/template/{template_id}"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
|
||||
|
||||
## 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 deleted","required":true,"schema":{"type":"integer","format":"int64"}}}
|
||||
>
|
||||
|
||||
</ParamsItem>
|
||||
</ul>
|
||||
</div>
|
||||
</details><div>
|
||||
<div>
|
||||
<ApiTabs>
|
||||
<TabItem
|
||||
label={"400"}
|
||||
value={"400"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
Invalid ID supplied
|
||||
|
||||
|
||||
</div><div>
|
||||
|
||||
</div>
|
||||
</TabItem><TabItem
|
||||
label={"404"}
|
||||
value={"404"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
Order not found
|
||||
|
||||
|
||||
</div><div>
|
||||
|
||||
</div>
|
||||
</TabItem>
|
||||
</ApiTabs>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -0,0 +1,112 @@
|
||||
---
|
||||
id: delete-pet
|
||||
title: "Deletes a pet"
|
||||
description: "delete a pet"
|
||||
sidebar_label: "Deletes a pet"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJyVVdtq20AQ/ZVlnxJwLIeGPohSGhoTTENj6pQWHBPW0shaIq02u6ukQejfO7O6+QotGFua65kzF1fciY3l4ZJHhXIicpavRjwGGxmpnSwUD/EtAwdMMA2Oj3ihwQhSzeJeOfcaLYzI8c1QwIorfEELoeXTM7yjXlK0FEQMhu8nQYGBl1IawKiJyCyMuI1SyAUPK+7eNYWyzki14XU96qO3sJ9k3CXQwqUH4REgkzFzBWsA76RzpjyWTSoHGw81KUwuXCP6eIX5V+RudaEsWPK4mkzoZzfnTL2KDJMibQyfSiDg3EJUGunePUUdN+FyRTGRvLQYWPWUYjEhD9oyg2qot+YUzLx2dJcmI3qd0zYMAqH1GDulrNyoTKztOCpyFMrg9ZJTqg7GgqpuiujB9Ayg5JvvXEv274u5MBYurjv5dkepOKmSwvtLl5HDPSJYIAJ2PZ8xzLzflodUWoYfUsdFVOaA1ZGOIeVsz5uthYWYodKl4JUk/zC+ZFZDJBMZedcxe1SPalHkwEoLSZmxTKpnGz6qC7a8T9BMioz9grWVDlZnHWFvb28HhJ17n1vp0nLNDOhiMN94oWd126t/OcdacRNye58ssEkygrY5J1IF3jhAr7bDRCPOo8yGIf+y78SR8gxD4xiSedul69v5HdIywVjDTPwD5OBu9nX6fTGlqDRVTYsuxxMMhSJdWJcLtZXoxk+p7S/DTm8rjxr7eXhB2uly8McFOhM4RHULtWoHvj9HaB1urTgOboowyKCqaBx+mqyuSfxSgvF7hNiFkWJN84dbEUtLz8NROQny7Ed7EM7ZkWtxFHO3Jop2oVlxf8n8Fm2fpnqF1u2e/B+qU6mbFMNt7bPv3JGb6d30YYpqURKt24vduLUPhOloMQcb3+SlbzrCR30+0Vqi9efevL1+pxz6v4TGmgpc1XX9F0LcPJ0=
|
||||
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,"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,"schema":{"type":"string"}}}
|
||||
>
|
||||
|
||||
</ParamsItem>
|
||||
</ul>
|
||||
</div>
|
||||
</details><div>
|
||||
<div>
|
||||
<ApiTabs>
|
||||
<TabItem
|
||||
label={"400"}
|
||||
value={"400"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
Invalid pet value
|
||||
|
||||
|
||||
</div><div>
|
||||
|
||||
</div>
|
||||
</TabItem>
|
||||
</ApiTabs>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -0,0 +1,510 @@
|
||||
---
|
||||
id: find-pets-by-status
|
||||
title: "Finds Pets by status"
|
||||
description: "Multiple status values can be provided with comma separated strings"
|
||||
sidebar_label: "Finds Pets by status"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJztVttu4zYQ/RWCT13AsZx20QdjUTTdpkHQbWPAKVogMQpaGlncSCSXpOwYhv69MxRlyXYMBNt9zEtiDedyODeeHfdi5fj0gWc6rStQ3vHFiGfgUiuNl1rxKf+jLr00JTDnha8dW4uyBsdSodgSmLF6LTPI2Eb6gqW6qgRzYIQVHoXOW6kwwohrAyhCj7cZ+sylymbg3S/beXCKCmRSgQdLeHZc4Qcquu5YEpQvNdgtPwY4P8DlC+GZAgzuNQFMtXII0KIg15blssQY6MPCl1qilE9zUToYcXg2pc4wqLc1frq0gErw6Y77rWmh0F1C9FxgTlAk1kKWYlkCSkHVFWVyKDOgstbG6TLji6ZZUGBnEBM48v39ZEL/Di/k6jQF5/K6ZPu0oQ+8iccSkb4wppRpOEg+OzLanQIW1grKlvRQhWD9lR/a/CLCQnv9ly1D3aOdXn6G1NOhpfBetlBlNvAtEcoq5BGTWgnfin58T4l4FhW2C59eTppRrONpEvda2HqrlQSOunghWGmscK//zbC8CsqvGnu1QdXnqiTN2IR7XHjipQ+qHweyPomnyY+eNhZLRpmn5moGNTkGcxi584ygKHYY1q8N8b9SeTZ9p9lClMNE3YtWKU7yi/M0bH4Dvts0UuE0097R9vUTdpJC8EM4M/okreEIRYu3CXqboLcJeuUEkd77l16vW4UvscwO6EKLH9LaSr8N77sw8t8noN8LehTx5S80MYMVhAQLX+BH0tGSUjoSO7DrjiDUWNMpL7w3bpokWLgx1gSf+pXCm7kxMhEUymR9ycl/F3tOI96WbY+gbwcjfwfqh3jxfy5mwjq4uOrkgYQUIJBOhBtJletgH1NzhwjmiIBdzW4ZRj6uzH0hsSYuHHdXCxsoUJMja7YUDkmLbktIhyT/YXzJnIFU5nF5jdmjelRzXQGrHRBnKKV6ctNHdcEe7nJUk6Jkf8PSYTsvvusSttlsThL2LtjcIJGrl8yC0b36KghDVodW+493eFfkVZW7y+dYJJlCLM6ZUElQTiKrEWlgNbh8JRU1in4+NqIuxJ2NQhi059XN7BOmZYK++p54BeTk0+3H6z/n1+SVuqot0eV4gq5oJWnnK6EGgX5D0uoY0Va23LI9Mz0o8a5nad+IOMfe9PDsE1MKbMEmXnQXx6Rn72FMsNsLxE7y3Y56CLdf05C4pc80PJl0NP49+T17ia8j1y+CDsPWM/p2MUx5mM+1sDIsJNoHo27GCGprdYWM2PiB1QkDPtgiN9f3qCtqSs9wvJ/CGMcf5L07UtuB75O5bzHQ32Z0xuYDDSdq/7RXj4vvnEG8YqdNKcLd2/wHPTKgNQ==
|
||||
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,"explode":true,"schema":{"type":"string","default":"available","enum":["available","pending","sold"]}}}
|
||||
>
|
||||
|
||||
</ParamsItem>
|
||||
</ul>
|
||||
</div>
|
||||
</details><div>
|
||||
<div>
|
||||
<ApiTabs>
|
||||
<TabItem
|
||||
label={"200"}
|
||||
value={"200"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
successful operation
|
||||
|
||||
|
||||
</div><div>
|
||||
<MimeTabs
|
||||
className={"openapi-tabs__mime"}
|
||||
schemaType={"response"}
|
||||
>
|
||||
<TabItem
|
||||
label={"application/json"}
|
||||
value={"application/json"}
|
||||
>
|
||||
<SchemaTabs
|
||||
className={"openapi-tabs__schema"}
|
||||
>
|
||||
<TabItem
|
||||
label={"Schema"}
|
||||
value={"Schema"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details response"}
|
||||
data-collapsed={false}
|
||||
open={true}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
className={"openapi-markdown__details-summary-response"}
|
||||
>
|
||||
<strong>
|
||||
Schema
|
||||
</strong>
|
||||
</summary><div
|
||||
style={{"textAlign":"left","marginLeft":"1rem"}}
|
||||
>
|
||||
|
||||
</div><ul
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<li>
|
||||
<div
|
||||
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}
|
||||
>
|
||||
Array [
|
||||
</div>
|
||||
</li><SchemaItem
|
||||
collapsible={false}
|
||||
name={"id"}
|
||||
required={false}
|
||||
schemaName={"int64"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int64","example":10}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"name"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"doggie"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={true}
|
||||
className={"schemaItem"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details"}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
>
|
||||
<span
|
||||
className={"openapi-schema__container"}
|
||||
>
|
||||
<strong
|
||||
className={"openapi-schema__property"}
|
||||
>
|
||||
category
|
||||
</strong><span
|
||||
className={"openapi-schema__name"}
|
||||
>
|
||||
category
|
||||
</span>
|
||||
</span>
|
||||
</summary><div
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<SchemaItem
|
||||
collapsible={false}
|
||||
name={"id"}
|
||||
required={false}
|
||||
schemaName={"int64"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int64","example":1}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"name"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"Dogs"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</div>
|
||||
</details>
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"photoUrls"}
|
||||
required={true}
|
||||
schemaName={"string[]"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"array","xml":{"wrapped":true},"items":{"type":"string","xml":{"name":"photoUrl"}}}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={true}
|
||||
className={"schemaItem"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details"}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
>
|
||||
<span
|
||||
className={"openapi-schema__container"}
|
||||
>
|
||||
<strong
|
||||
className={"openapi-schema__property"}
|
||||
>
|
||||
tags
|
||||
</strong><span
|
||||
className={"openapi-schema__name"}
|
||||
>
|
||||
tag[]
|
||||
</span>
|
||||
</span>
|
||||
</summary><div
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<li>
|
||||
<div
|
||||
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}
|
||||
>
|
||||
Array [
|
||||
</div>
|
||||
</li><SchemaItem
|
||||
collapsible={false}
|
||||
name={"id"}
|
||||
required={false}
|
||||
schemaName={"int64"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int64"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"name"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem><li>
|
||||
<div
|
||||
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}
|
||||
>
|
||||
]
|
||||
</div>
|
||||
</li>
|
||||
</div>
|
||||
</details>
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"status"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={"**Possible values:** [`available`, `pending`, `sold`]"}
|
||||
schema={{"type":"string","description":"pet status in the store","enum":["available","pending","sold"]}}
|
||||
>
|
||||
|
||||
</SchemaItem><li>
|
||||
<div
|
||||
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}
|
||||
>
|
||||
]
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"Example (from schema)"}
|
||||
value={"Example (from schema)"}
|
||||
>
|
||||
<ResponseSamples
|
||||
responseExample={"[\n {\n \"id\": 10,\n \"name\": \"doggie\",\n \"category\": {\n \"id\": 1,\n \"name\": \"Dogs\"\n },\n \"photoUrls\": [\n \"string\"\n ],\n \"tags\": [\n {\n \"id\": 0,\n \"name\": \"string\"\n }\n ],\n \"status\": \"available\"\n }\n]"}
|
||||
language={"json"}
|
||||
>
|
||||
|
||||
</ResponseSamples>
|
||||
</TabItem>
|
||||
</SchemaTabs>
|
||||
</TabItem><TabItem
|
||||
label={"application/xml"}
|
||||
value={"application/xml"}
|
||||
>
|
||||
<SchemaTabs
|
||||
className={"openapi-tabs__schema"}
|
||||
>
|
||||
<TabItem
|
||||
label={"Schema"}
|
||||
value={"Schema"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details response"}
|
||||
data-collapsed={false}
|
||||
open={true}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
className={"openapi-markdown__details-summary-response"}
|
||||
>
|
||||
<strong>
|
||||
Schema
|
||||
</strong>
|
||||
</summary><div
|
||||
style={{"textAlign":"left","marginLeft":"1rem"}}
|
||||
>
|
||||
|
||||
</div><ul
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<li>
|
||||
<div
|
||||
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}
|
||||
>
|
||||
Array [
|
||||
</div>
|
||||
</li><SchemaItem
|
||||
collapsible={false}
|
||||
name={"id"}
|
||||
required={false}
|
||||
schemaName={"int64"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int64","example":10}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"name"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"doggie"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={true}
|
||||
className={"schemaItem"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details"}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
>
|
||||
<span
|
||||
className={"openapi-schema__container"}
|
||||
>
|
||||
<strong
|
||||
className={"openapi-schema__property"}
|
||||
>
|
||||
category
|
||||
</strong><span
|
||||
className={"openapi-schema__name"}
|
||||
>
|
||||
category
|
||||
</span>
|
||||
</span>
|
||||
</summary><div
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<SchemaItem
|
||||
collapsible={false}
|
||||
name={"id"}
|
||||
required={false}
|
||||
schemaName={"int64"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int64","example":1}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"name"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"Dogs"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</div>
|
||||
</details>
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"photoUrls"}
|
||||
required={true}
|
||||
schemaName={"string[]"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"array","xml":{"wrapped":true},"items":{"type":"string","xml":{"name":"photoUrl"}}}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={true}
|
||||
className={"schemaItem"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details"}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
>
|
||||
<span
|
||||
className={"openapi-schema__container"}
|
||||
>
|
||||
<strong
|
||||
className={"openapi-schema__property"}
|
||||
>
|
||||
tags
|
||||
</strong><span
|
||||
className={"openapi-schema__name"}
|
||||
>
|
||||
tag[]
|
||||
</span>
|
||||
</span>
|
||||
</summary><div
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<li>
|
||||
<div
|
||||
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}
|
||||
>
|
||||
Array [
|
||||
</div>
|
||||
</li><SchemaItem
|
||||
collapsible={false}
|
||||
name={"id"}
|
||||
required={false}
|
||||
schemaName={"int64"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int64"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"name"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem><li>
|
||||
<div
|
||||
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}
|
||||
>
|
||||
]
|
||||
</div>
|
||||
</li>
|
||||
</div>
|
||||
</details>
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"status"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={"**Possible values:** [`available`, `pending`, `sold`]"}
|
||||
schema={{"type":"string","description":"pet status in the store","enum":["available","pending","sold"]}}
|
||||
>
|
||||
|
||||
</SchemaItem><li>
|
||||
<div
|
||||
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}
|
||||
>
|
||||
]
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"Example (from schema)"}
|
||||
value={"Example (from schema)"}
|
||||
>
|
||||
<ResponseSamples
|
||||
responseExample={"<0>\n <id>10</id>\n <name>doggie</name>\n <category>\n <id>1</id>\n <name>Dogs</name>\n </category>\n <photoUrls>string</photoUrls>\n <tags>\n <id>0</id>\n <name>string</name>\n </tags>\n <status>available</status>\n</0>"}
|
||||
language={"xml"}
|
||||
>
|
||||
|
||||
</ResponseSamples>
|
||||
</TabItem>
|
||||
</SchemaTabs>
|
||||
</TabItem>
|
||||
</MimeTabs>
|
||||
</div>
|
||||
</TabItem><TabItem
|
||||
label={"400"}
|
||||
value={"400"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
Invalid status value
|
||||
|
||||
|
||||
</div><div>
|
||||
|
||||
</div>
|
||||
</TabItem>
|
||||
</ApiTabs>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -0,0 +1,510 @@
|
||||
---
|
||||
id: find-pets-by-tags
|
||||
title: "Finds Pets by tags"
|
||||
description: "Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing."
|
||||
sidebar_label: "Finds Pets by tags"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJztVt1v2zYQ/1cIPq2AYtltsQejGJq1aRC0Www4xQYkRkFLJ4uNRKokZccw9L/vjqIsxY6BYFvf8iKbx999f/B23ImV5dNbnuqkLkE5yxcRT8EmRlZOasWn/I+6cLIqgBGWJUKxJbDK6LVMIWUb6XKW6LIUzEIljHBItM5ItbIj9tV6tklE39f++4Zl2jAH1iFkxCOuK0Au1HWVorZMqnQGzv6+vSHTIk4yS3BgyM4dV3hAmGsvJRn4owaz5YdmEztzmmWyQGa2JISBH7U0gHoyUViIODxUhU5RoDM1Hm2SQyn4dMfdtiI1whhBjNJBaQf01kHeNM2CpNpKKwse8Ho8pp/Httg6ScDarC7Y3luUmmjlMOaEF1VVyMRfxN8tMe2eYU3vz20bGAxXrp3+agqfyMCnl98hcXRpSL2TrakyHciWaMoKDIIwPaVwLenXt5yCJErMP59Oxk0UEnAYiQEKa2m1ksARiw7BSmNyevz/ZsuzTPmosUwahD6UBSFD9eztwhsnnYd+GND6IB4HP0jaGEwZRZ4qpzlZIYeaO8lUOlHovn+r4j+F8mT4jqOFVg4DdSNakHXC1U+6/Lj4K3CsxTKpmMsBT9pQrYKqSypdsRayEMvC1y+otJVidZHyxbE5KG9ozoyOhBq2UOB46aCXDnrpoGd2EOHePvV6Xam1KGRKjzfDfzW0xkNSG+m2/lUWlfx2D/R/QS8ivte5ptd8BT66wuV4iLslIybbwKy7N73GbE557lxlp3GMKRthNpSVK4U+2RFuF0iU8XrCSXineE7N3SZsr74vhEp+BqqE4PLfZzNhLJydd3S/OeQgUkwtuSNVpj1/CMo1WjBHC9j57Iqh5qP1IpeYDeuvO7/87PHrzQE3WwqLa5Fuk0eXRH8zmjBbQSKzMLZG7E7dqbkugdUWaFsopLq30zt1xm6vM4RJUbC/YGmxkBe/dAHbbDZHAXvleS5xOauXzECle/jKE31Uh1z7wyv0FTem0l5nc0ySTCAk54Sq2IPjsM+IxO8zOHYlJTWQ3h8yUf3htEYiDArz/HL2BcMyRll9TTzD5PjL1YeLP+cXJJWqqk3RZDRGUTSMtHWlUANFn3DLtIz2TFwMWVgmHyV4129nP30DDjXr4MHFVSGwNJsQgF3onX5BRzi9Szm6ROTdjkoLx2HTELldhamnUmlpHvSr7knvnlqUn7TId1i3ebeDYMp9S66FkX76UP9HXVuRGS3POa6/lRtwHa27j6bG5cUNYkVNng87+t53bvhD0rsrtR3IPmr11gb6NtEJnnfUj4j+bQ8Pg+4UQ3CxQ1OAcNA2/wDHj4Is
|
||||
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,"explode":true,"schema":{"type":"array","items":{"type":"string"}}}}
|
||||
>
|
||||
|
||||
</ParamsItem>
|
||||
</ul>
|
||||
</div>
|
||||
</details><div>
|
||||
<div>
|
||||
<ApiTabs>
|
||||
<TabItem
|
||||
label={"200"}
|
||||
value={"200"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
successful operation
|
||||
|
||||
|
||||
</div><div>
|
||||
<MimeTabs
|
||||
className={"openapi-tabs__mime"}
|
||||
schemaType={"response"}
|
||||
>
|
||||
<TabItem
|
||||
label={"application/json"}
|
||||
value={"application/json"}
|
||||
>
|
||||
<SchemaTabs
|
||||
className={"openapi-tabs__schema"}
|
||||
>
|
||||
<TabItem
|
||||
label={"Schema"}
|
||||
value={"Schema"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details response"}
|
||||
data-collapsed={false}
|
||||
open={true}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
className={"openapi-markdown__details-summary-response"}
|
||||
>
|
||||
<strong>
|
||||
Schema
|
||||
</strong>
|
||||
</summary><div
|
||||
style={{"textAlign":"left","marginLeft":"1rem"}}
|
||||
>
|
||||
|
||||
</div><ul
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<li>
|
||||
<div
|
||||
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}
|
||||
>
|
||||
Array [
|
||||
</div>
|
||||
</li><SchemaItem
|
||||
collapsible={false}
|
||||
name={"id"}
|
||||
required={false}
|
||||
schemaName={"int64"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int64","example":10}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"name"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"doggie"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={true}
|
||||
className={"schemaItem"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details"}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
>
|
||||
<span
|
||||
className={"openapi-schema__container"}
|
||||
>
|
||||
<strong
|
||||
className={"openapi-schema__property"}
|
||||
>
|
||||
category
|
||||
</strong><span
|
||||
className={"openapi-schema__name"}
|
||||
>
|
||||
category
|
||||
</span>
|
||||
</span>
|
||||
</summary><div
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<SchemaItem
|
||||
collapsible={false}
|
||||
name={"id"}
|
||||
required={false}
|
||||
schemaName={"int64"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int64","example":1}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"name"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"Dogs"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</div>
|
||||
</details>
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"photoUrls"}
|
||||
required={true}
|
||||
schemaName={"string[]"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"array","xml":{"wrapped":true},"items":{"type":"string","xml":{"name":"photoUrl"}}}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={true}
|
||||
className={"schemaItem"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details"}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
>
|
||||
<span
|
||||
className={"openapi-schema__container"}
|
||||
>
|
||||
<strong
|
||||
className={"openapi-schema__property"}
|
||||
>
|
||||
tags
|
||||
</strong><span
|
||||
className={"openapi-schema__name"}
|
||||
>
|
||||
tag[]
|
||||
</span>
|
||||
</span>
|
||||
</summary><div
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<li>
|
||||
<div
|
||||
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}
|
||||
>
|
||||
Array [
|
||||
</div>
|
||||
</li><SchemaItem
|
||||
collapsible={false}
|
||||
name={"id"}
|
||||
required={false}
|
||||
schemaName={"int64"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int64"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"name"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem><li>
|
||||
<div
|
||||
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}
|
||||
>
|
||||
]
|
||||
</div>
|
||||
</li>
|
||||
</div>
|
||||
</details>
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"status"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={"**Possible values:** [`available`, `pending`, `sold`]"}
|
||||
schema={{"type":"string","description":"pet status in the store","enum":["available","pending","sold"]}}
|
||||
>
|
||||
|
||||
</SchemaItem><li>
|
||||
<div
|
||||
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}
|
||||
>
|
||||
]
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"Example (from schema)"}
|
||||
value={"Example (from schema)"}
|
||||
>
|
||||
<ResponseSamples
|
||||
responseExample={"[\n {\n \"id\": 10,\n \"name\": \"doggie\",\n \"category\": {\n \"id\": 1,\n \"name\": \"Dogs\"\n },\n \"photoUrls\": [\n \"string\"\n ],\n \"tags\": [\n {\n \"id\": 0,\n \"name\": \"string\"\n }\n ],\n \"status\": \"available\"\n }\n]"}
|
||||
language={"json"}
|
||||
>
|
||||
|
||||
</ResponseSamples>
|
||||
</TabItem>
|
||||
</SchemaTabs>
|
||||
</TabItem><TabItem
|
||||
label={"application/xml"}
|
||||
value={"application/xml"}
|
||||
>
|
||||
<SchemaTabs
|
||||
className={"openapi-tabs__schema"}
|
||||
>
|
||||
<TabItem
|
||||
label={"Schema"}
|
||||
value={"Schema"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details response"}
|
||||
data-collapsed={false}
|
||||
open={true}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
className={"openapi-markdown__details-summary-response"}
|
||||
>
|
||||
<strong>
|
||||
Schema
|
||||
</strong>
|
||||
</summary><div
|
||||
style={{"textAlign":"left","marginLeft":"1rem"}}
|
||||
>
|
||||
|
||||
</div><ul
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<li>
|
||||
<div
|
||||
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}
|
||||
>
|
||||
Array [
|
||||
</div>
|
||||
</li><SchemaItem
|
||||
collapsible={false}
|
||||
name={"id"}
|
||||
required={false}
|
||||
schemaName={"int64"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int64","example":10}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"name"}
|
||||
required={true}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"doggie"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={true}
|
||||
className={"schemaItem"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details"}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
>
|
||||
<span
|
||||
className={"openapi-schema__container"}
|
||||
>
|
||||
<strong
|
||||
className={"openapi-schema__property"}
|
||||
>
|
||||
category
|
||||
</strong><span
|
||||
className={"openapi-schema__name"}
|
||||
>
|
||||
category
|
||||
</span>
|
||||
</span>
|
||||
</summary><div
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<SchemaItem
|
||||
collapsible={false}
|
||||
name={"id"}
|
||||
required={false}
|
||||
schemaName={"int64"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int64","example":1}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"name"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","example":"Dogs"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</div>
|
||||
</details>
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"photoUrls"}
|
||||
required={true}
|
||||
schemaName={"string[]"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"array","xml":{"wrapped":true},"items":{"type":"string","xml":{"name":"photoUrl"}}}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={true}
|
||||
className={"schemaItem"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details"}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
>
|
||||
<span
|
||||
className={"openapi-schema__container"}
|
||||
>
|
||||
<strong
|
||||
className={"openapi-schema__property"}
|
||||
>
|
||||
tags
|
||||
</strong><span
|
||||
className={"openapi-schema__name"}
|
||||
>
|
||||
tag[]
|
||||
</span>
|
||||
</span>
|
||||
</summary><div
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<li>
|
||||
<div
|
||||
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem","paddingBottom":".5rem"}}
|
||||
>
|
||||
Array [
|
||||
</div>
|
||||
</li><SchemaItem
|
||||
collapsible={false}
|
||||
name={"id"}
|
||||
required={false}
|
||||
schemaName={"int64"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int64"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"name"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string"}}
|
||||
>
|
||||
|
||||
</SchemaItem><li>
|
||||
<div
|
||||
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}
|
||||
>
|
||||
]
|
||||
</div>
|
||||
</li>
|
||||
</div>
|
||||
</details>
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"status"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={"**Possible values:** [`available`, `pending`, `sold`]"}
|
||||
schema={{"type":"string","description":"pet status in the store","enum":["available","pending","sold"]}}
|
||||
>
|
||||
|
||||
</SchemaItem><li>
|
||||
<div
|
||||
style={{"fontSize":"var(--ifm-code-font-size)","opacity":"0.6","marginLeft":"-.5rem"}}
|
||||
>
|
||||
]
|
||||
</div>
|
||||
</li>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"Example (from schema)"}
|
||||
value={"Example (from schema)"}
|
||||
>
|
||||
<ResponseSamples
|
||||
responseExample={"<0>\n <id>10</id>\n <name>doggie</name>\n <category>\n <id>1</id>\n <name>Dogs</name>\n </category>\n <photoUrls>string</photoUrls>\n <tags>\n <id>0</id>\n <name>string</name>\n </tags>\n <status>available</status>\n</0>"}
|
||||
language={"xml"}
|
||||
>
|
||||
|
||||
</ResponseSamples>
|
||||
</TabItem>
|
||||
</SchemaTabs>
|
||||
</TabItem>
|
||||
</MimeTabs>
|
||||
</div>
|
||||
</TabItem><TabItem
|
||||
label={"400"}
|
||||
value={"400"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
Invalid tag value
|
||||
|
||||
|
||||
</div><div>
|
||||
|
||||
</div>
|
||||
</TabItem>
|
||||
</ApiTabs>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -0,0 +1,125 @@
|
||||
---
|
||||
id: get-inventory
|
||||
title: "Returns pet inventories by status"
|
||||
description: "Returns a map of status codes to quantities"
|
||||
sidebar_label: "Returns pet inventories by status"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJyVVG1rGkEQ/ivLfmrAeCb5JqVUSgjS0EhNacFI2VtHb5O73c3unKkc/vfOrHdqDIFWRO9mnnl23p5tJKpVlMOZXDhdV2AxynlPLiDqYDwaZ+VQfgesg41CiUp54ZYiosI6Cu0IJ9CJ51pZNGggyp50HoLiyPGCYleAY7smXhc25AwQvbORgMNGXg4G/Pf6sFhrDTEu61LsmShQO4vEwnjlfWl0cmSPkYMaGXUBleIn3HggGpc/gkYKVIuFYagqJ4EJU5YHnCHaFQQCLl2oFO5MV5dymz49GUHXweCGesRHm99PwM/zLbWpAixcWyUxeIUFvWQ6gELoGiqZI6whxERRh5IwBaKPwyyjWvqUlY1mZUuVx752FRlNtr6QfEJ3+pTr2yW+z2FfA1m+AnfXqorff51PVIhwPurshhtbgFpQoVyTsUuX4g2WHHBHGUwpAzGajAWdfLoA94WJgr7s7spK/RfUNHESLXIVYSHIiQUkJ9uv+hcietBm2Y6uLx7sg526CkQdgcddGvsUhw/2XMzulgQzqhQ/IY8GYf6ha9jLy8ubhp2lmBuDRZ2LAN4d4KtkTF09jtq/nFGtCKGKd8spDcloaIfzzlFZAmftQiqdFpI2z/BQW9Pn0yBJLaeNJSMwvJ3S6GZyS20ZENdhJ/4h5ex2/OX62/SaWXmrdiO66A+IikzeRayUPTqok68HFKbVIolA5JtWyKfzbg5q+0/ttwuJ8AczXyrau21bXdOqYyZP1EFLXlDK7GkaXp0fodxu2fxcQ0hSozpVMCrnXSXh9bpVZjklJcgR3RmelbZWZb2TxMkd8UquN9f3fDPUnNCxip6SWtoHZu9cdnPE/UZeuxz4d9t7J+Yja4DQn/bwnefdgLbEDs2dnNN99Bf1+fU5
|
||||
sidebar_class_name: "get api-method"
|
||||
info_path: docs/API-docs/opensign-api-v-1
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import ApiTabs from "@theme/ApiTabs";
|
||||
import DiscriminatorTabs from "@theme/DiscriminatorTabs";
|
||||
import MethodEndpoint from "@theme/ApiExplorer/MethodEndpoint";
|
||||
import SecuritySchemes from "@theme/ApiExplorer/SecuritySchemes";
|
||||
import MimeTabs from "@theme/MimeTabs";
|
||||
import ParamsItem from "@theme/ParamsItem";
|
||||
import ResponseSamples from "@theme/ResponseSamples";
|
||||
import SchemaItem from "@theme/SchemaItem";
|
||||
import SchemaTabs from "@theme/SchemaTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
|
||||
<h1
|
||||
className={"openapi__heading"}
|
||||
>
|
||||
Returns pet inventories by status
|
||||
</h1>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/createdocument"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Returns a map of status codes to quantities
|
||||
|
||||
## Request
|
||||
|
||||
<div>
|
||||
<div>
|
||||
<ApiTabs>
|
||||
<TabItem
|
||||
label={"200"}
|
||||
value={"200"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
successful operation
|
||||
|
||||
|
||||
</div><div>
|
||||
<MimeTabs
|
||||
className={"openapi-tabs__mime"}
|
||||
schemaType={"response"}
|
||||
>
|
||||
<TabItem
|
||||
label={"application/json"}
|
||||
value={"application/json"}
|
||||
>
|
||||
<SchemaTabs
|
||||
className={"openapi-tabs__schema"}
|
||||
>
|
||||
<TabItem
|
||||
label={"Schema"}
|
||||
value={"Schema"}
|
||||
>
|
||||
<details
|
||||
style={{}}
|
||||
className={"openapi-markdown__details response"}
|
||||
data-collapsed={false}
|
||||
open={true}
|
||||
>
|
||||
<summary
|
||||
style={{}}
|
||||
className={"openapi-markdown__details-summary-response"}
|
||||
>
|
||||
<strong>
|
||||
Schema
|
||||
</strong>
|
||||
</summary><div
|
||||
style={{"textAlign":"left","marginLeft":"1rem"}}
|
||||
>
|
||||
|
||||
</div><ul
|
||||
style={{"marginLeft":"1rem"}}
|
||||
>
|
||||
<SchemaItem
|
||||
name={"property name*"}
|
||||
required={false}
|
||||
schemaName={"int32"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int32"}}
|
||||
collapsible={false}
|
||||
discriminator={false}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"Example (from schema)"}
|
||||
value={"Example (from schema)"}
|
||||
>
|
||||
<ResponseSamples
|
||||
responseExample={"{}"}
|
||||
language={"json"}
|
||||
>
|
||||
|
||||
</ResponseSamples>
|
||||
</TabItem>
|
||||
</SchemaTabs>
|
||||
</TabItem>
|
||||
</MimeTabs>
|
||||
</div>
|
||||
</TabItem>
|
||||
</ApiTabs>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -0,0 +1,319 @@
|
||||
---
|
||||
id: get-order-by-id
|
||||
title: "Find purchase order by ID"
|
||||
description: "For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions."
|
||||
sidebar_label: "Find purchase order by ID"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJztVm1rIzcQ/itCny7geO1c2rSmLU2bXDA96lBfaSEJh7w769XdWtpIWifG7H/vM9p1snHSNv1SKBQMXo2eZ2Y0b9JWBrX0cnIlA62qUgXy8mYgM/Kp01XQ1siJfGedWKtSZ8KRr6zxJILbCG0CLcmJ6ZkXdzoUjKlJfPOt+EKA8Z0Yj4ZiFgpy7Q6jylIsyZCDIUH3KUUTfigH0lYsxWqaweSSwsxl5H7YYDmQlXJqRYEcu7qVBguAdi5/1IzR7GqlQiH3/Z+eCZvDJegToVBBGKLMi2DFgkROIS2IFTi6rbXD5yS4mgbSQ75ScrKVYVOxve7AgObWrVRoRV8ey6a5YXobG8+Mo9GI/5764es0Je/zuhQPp4Wy1EKvCYxXVVXqNG4knzyTts/dsItPlAaOimM1QbcmEYRXuDqQdK8QNoDGowY6KEz/MfHrr05OjkC+rZUJOmz+lv/2qM8/AdUXujpD7npUH5w2yz4zA+AwaCSbGUGF2r+EfxrlWDdi3qJ7Vjm4zq5jqsnUKy56lE8aBb29jEq9Jq6Dm4aTw+wnfi6sLUkZZH0g71cl73QFGUuMfUVQoslZK2gGTzLbkf5P7H8/sQw9fqnXp6admJg9vubcw2zEHj/HtgczNojc1iaL9jHtCttNwjgAMdcmMtmNvGTbG34NAJ7cejceawffZRFC5SdJgggMUU7G66Up1cIPcXIIdbIeS55bntLaIddzLse24rD78TP1sw/JTxAMdgH5/fBSOU+Hpzt5nL4FqV29a5PbyN8FDB7M4YE4vZwKWN5P7odCe4Efb2c2rVeYiLFbEBMn9thioTxlApu4XeImy98Ox8JXlOq8a7ShuDbXZm5XJGpPPHZLbT77ybU5FFezHDCtSvEbLbwOdPNmF7C7u7tnATuInAvccvUCt2BlH+HLKIxR7bMeFgc4K26ulZ/lcyRJp9Ql509MJRGcdBeDSuPFgEGhOamd6Pt9EtcW5guE1Cvb04vL9wjLCLoea+IVLifvpz+e/zw/Z61cVW2KxsMRVPFosT6slOkZeqdNJqrapQUS0920iw2Kfz/P28fb7t95VnT1G+g+JOgXlGnTBWPbNdXj0wfwSf9NgeYocFSGbLdccr+6smlYfFuTQ3tc4XOtnFYLrnF0XqY9f6Nvc1V6+ovDv/mle20ciFc+T148ya49DfdgDAdW+Izd++SB1PDQ6xqUXW0RpykHq8d99gLhEfEwjC7OP6C7/wB/6nim
|
||||
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 purchase order by ID
|
||||
</h1>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"get"}
|
||||
path={"/template/{template_id}"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
For valid response try integer IDs with value < 5 or > 10. Other values will generate exceptions.
|
||||
|
||||
## 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 order that needs to be fetched","required":true,"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={"petId"}
|
||||
required={false}
|
||||
schemaName={"int64"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int64","example":198772}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"quantity"}
|
||||
required={false}
|
||||
schemaName={"int32"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int32","example":7}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"shipDate"}
|
||||
required={false}
|
||||
schemaName={"date-time"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"date-time"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"status"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={"**Possible values:** [`placed`, `approved`, `delivered`]"}
|
||||
schema={{"type":"string","description":"Order Status","example":"approved","enum":["placed","approved","delivered"]}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"complete"}
|
||||
required={false}
|
||||
schemaName={"boolean"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"boolean"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"Example (from schema)"}
|
||||
value={"Example (from schema)"}
|
||||
>
|
||||
<ResponseSamples
|
||||
responseExample={"{\n \"id\": 10,\n \"petId\": 198772,\n \"quantity\": 7,\n \"shipDate\": \"2023-12-24T21:10:12.539Z\",\n \"status\": \"approved\",\n \"complete\": true\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={"petId"}
|
||||
required={false}
|
||||
schemaName={"int64"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int64","example":198772}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"quantity"}
|
||||
required={false}
|
||||
schemaName={"int32"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int32","example":7}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"shipDate"}
|
||||
required={false}
|
||||
schemaName={"date-time"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"date-time"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"status"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={"**Possible values:** [`placed`, `approved`, `delivered`]"}
|
||||
schema={{"type":"string","description":"Order Status","example":"approved","enum":["placed","approved","delivered"]}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"complete"}
|
||||
required={false}
|
||||
schemaName={"boolean"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"boolean"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"Example (from schema)"}
|
||||
value={"Example (from schema)"}
|
||||
>
|
||||
<ResponseSamples
|
||||
responseExample={"<root>\n <id>10</id>\n <petId>198772</petId>\n <quantity>7</quantity>\n <shipDate>2023-12-24T21:10:12.539Z</shipDate>\n <status>approved</status>\n <complete>true</complete>\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>
|
||||
|
||||
|
||||
Order not found
|
||||
|
||||
|
||||
</div><div>
|
||||
|
||||
</div>
|
||||
</TabItem>
|
||||
</ApiTabs>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -0,0 +1,499 @@
|
||||
---
|
||||
id: get-pet-by-id
|
||||
title: "Find pet by ID"
|
||||
description: "Returns a single pet"
|
||||
sidebar_label: "Find pet by ID"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJztVttu4zYQ/RWCTxvAsZw26INRFE1308DoojHWKXaBxFjQ0sjiRiK5JJXEEPTvnaEkS74VQdvHvNgieWbmcC6cqbgXa8en9zzWyovYO74c8QRcbKXxUis+5Z/Al1Y5JpiTap0DM+D5iGsDVhBkliBoDX4O/rcNLkbcCCsK8GBJc8UVLhDSWvgqCSJJsxE+4/vmZh+YTskG85rZYBsxFr6X0gKa8raEEXdxBoXg04r7jSHtUnlYg0Voqm0hfLP10yWv6yWJO6OVA0cSP0wm9Ldr1pVxDM6lZc62N0NlRBqUJ7wwJpdxOIi+ORKqBjR6gvfNhdENmfb6L5sHn7Y09eobxOQ+Y8mMlw0l9MkrrjLi8CIKkyPoYlKPWsdu5Zy3GKAhiid6vZbAEYvEYa3tZoD/37i8isoHjYlWI/SlyAnZZUXHC0+89AH6frDXO7HXLqwVG77V9GwxNF1qoIj0ULhjZHYtd5qRFNkOdfBvTfwnV55036G3kOXQUXeiATkvfHn0yrtJTlXVYJlUzGeAK20pV0GVBaWueBIyF6s85C+opNHidJ7w5SEdegkGdOa0xPWwUlqBt0J5K5S3QtktFIJdHutFM/UkcpkwbIWupFpChwbs5SEWVTGlPUt1qZLmjhCXVvpN6L3CyK+PQN9L6oPYlTPd9uvQqLEBT3nUtuao6nt0TbcB+9Q18RLjP+WZ98ZNowiDPMb4KSfXCr3gxrEucFNGTxec7HQcFlT2TYi3TPrUMfIPoNxpnfTlfC6sg/Orbj8MCRmIBJOBbiZVqoN868ZbZLBABuxqPmNoeT+Kd5nE+LlwnOi4LLCTh1cJvWXZnjRbCQcJ00246ZD2fxxfMGcglmn7oI3Zg3pQC10AKx3QuJBL9eimD+qc3d+mCJMiZ59h5TD1l+86hz0/Px847CzI3EiflSucdIzu4euwGbw6lNouzvCuOF8V7jZdYJBkDG1wTpiKAjhqBxqMMLkRH2SZ94PZr/tClHP4juMmDFL56mb+Ed0yQV19TryCcvRx9v76z8U1aaWsakJ0MZ6gKnq+tPOFUANDv0uVhDlwtcFK2A9u1Y9mpybUNs08vPjI5AKzqW45V23mb8deRE8H8ylmcIZ8CFBVlBf4+tU1bX8vwYZqwksIK8MDQOWRSEffWFqpyB38A9l3n9oGeMaOj7pHaXclo6gu8HUoaYWfoaKGo3W9RHRbM0SsAVzhcGv8QPRgmN15HW6u7xArSvLRsFwfQ1m2H6T9KK2DOm440G89OiHzMxUbon/ZwpuTkwLtFTs0eQnf3fpvF4pUHA==
|
||||
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,"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,47 +0,0 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Tutorial Intro
|
||||
|
||||
Let's discover **Docusaurus in less than 5 minutes**.
|
||||
|
||||
## Getting Started
|
||||
|
||||
Get started by **creating a new site**.
|
||||
|
||||
Or **try Docusaurus immediately** with **[docusaurus.new](https://docusaurus.new)**.
|
||||
|
||||
### What you'll need
|
||||
|
||||
- [Node.js](https://nodejs.org/en/download/) version 18.0 or above:
|
||||
- When installing Node.js, you are recommended to check all checkboxes related to dependencies.
|
||||
|
||||
## Generate a new site
|
||||
|
||||
Generate a new Docusaurus site using the **classic template**.
|
||||
|
||||
The classic template will automatically be added to your project after you run the command:
|
||||
|
||||
```bash
|
||||
npm init docusaurus@latest my-website classic
|
||||
```
|
||||
|
||||
You can type this command into Command Prompt, Powershell, Terminal, or any other integrated terminal of your code editor.
|
||||
|
||||
The command also installs all necessary dependencies you need to run Docusaurus.
|
||||
|
||||
## Start your site
|
||||
|
||||
Run the development server:
|
||||
|
||||
```bash
|
||||
cd my-website
|
||||
npm run start
|
||||
```
|
||||
|
||||
The `cd` command changes the directory you're working with. In order to work with your newly created Docusaurus site, you'll need to navigate the terminal there.
|
||||
|
||||
The `npm run start` command builds your website locally and serves it through a development server, ready for you to view at http://localhost:3000/.
|
||||
|
||||
Open `docs/intro.md` (this page) and edit some lines: the site **reloads automatically** and displays your changes.
|
||||
@@ -0,0 +1,111 @@
|
||||
---
|
||||
id: opensign-api-v-1
|
||||
title: "OpenSign API v1"
|
||||
description: "This is API documentation for OpenSign API v1 based on the OpenAPI 3.1 specification."
|
||||
sidebar_label: Introduction
|
||||
sidebar_position: 0
|
||||
hide_title: true
|
||||
custom_edit_url: null
|
||||
---
|
||||
|
||||
import ApiLogo from "@theme/ApiLogo";
|
||||
import SchemaTabs from "@theme/SchemaTabs";
|
||||
import TabItem from "@theme/TabItem";
|
||||
import Export from "@theme/ApiExplorer/Export";
|
||||
|
||||
<span
|
||||
className={"theme-doc-version-badge badge badge--secondary"}
|
||||
>
|
||||
Version: 1.0.0
|
||||
</span>
|
||||
|
||||
<h1
|
||||
className={"openapi__heading"}
|
||||
>
|
||||
OpenSign API v1
|
||||
</h1>
|
||||
|
||||
|
||||
|
||||
This is API documentation for OpenSign API v1 based on the OpenAPI 3.1 specification.
|
||||
|
||||
Some useful links:
|
||||
- [Official Website](https://www.opensignlabs.com)
|
||||
- [Github repo](https://github.com/opensignlabs/opensign)
|
||||
|
||||
<div
|
||||
style={{"marginBottom":"2rem"}}
|
||||
>
|
||||
<h2
|
||||
id={"authentication"}
|
||||
style={{"marginBottom":"1rem"}}
|
||||
>
|
||||
Authentication
|
||||
</h2><SchemaTabs
|
||||
className={"openapi-tabs__security-schemes"}
|
||||
>
|
||||
<TabItem
|
||||
label={"API Key: api_key"}
|
||||
value={"api_key"}
|
||||
>
|
||||
|
||||
|
||||
|
||||
|
||||
<div>
|
||||
<table>
|
||||
<tbody>
|
||||
<tr>
|
||||
<th>
|
||||
Security Scheme Type:
|
||||
</th><td>
|
||||
apiKey
|
||||
</td>
|
||||
</tr><tr>
|
||||
<th>
|
||||
Header parameter name:
|
||||
</th><td>
|
||||
X-Parse-ApiKey
|
||||
</td>
|
||||
</tr>
|
||||
</tbody>
|
||||
</table>
|
||||
</div>
|
||||
</TabItem>
|
||||
</SchemaTabs>
|
||||
</div><div
|
||||
style={{"display":"flex","flexDirection":"column","marginBottom":"var(--ifm-paragraph-margin-bottom)"}}
|
||||
>
|
||||
<h3
|
||||
style={{"marginBottom":"0.25rem"}}
|
||||
>
|
||||
Contact
|
||||
</h3><span>
|
||||
[contact@opensignlabs.com](mailto:contact@opensignlabs.com)
|
||||
</span>
|
||||
</div><div
|
||||
style={{"marginBottom":"var(--ifm-paragraph-margin-bottom)"}}
|
||||
>
|
||||
<h3
|
||||
style={{"marginBottom":"0.25rem"}}
|
||||
>
|
||||
Terms of Service
|
||||
</h3><a
|
||||
href={"http://www.opensignlabs.com/terms/"}
|
||||
>
|
||||
http://www.opensignlabs.com/terms/
|
||||
</a>
|
||||
</div><div
|
||||
style={{"marginBottom":"var(--ifm-paragraph-margin-bottom)"}}
|
||||
>
|
||||
<h3
|
||||
style={{"marginBottom":"0.25rem"}}
|
||||
>
|
||||
License
|
||||
</h3><a
|
||||
href={"http://github.com/opensignlabs/opensign/LICENSE"}
|
||||
>
|
||||
AGPL 3.0
|
||||
</a>
|
||||
</div>
|
||||
|
||||
@@ -0,0 +1,609 @@
|
||||
openapi: 3.0.3
|
||||
info:
|
||||
title: OpenSign API v1
|
||||
description: |-
|
||||
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)
|
||||
|
||||
termsOfService: http://www.opensignlabs.com/terms/
|
||||
contact:
|
||||
email: contact@opensignlabs.com
|
||||
license:
|
||||
name: AGPL 3.0
|
||||
url: http://github.com/opensignlabs/opensign/LICENSE
|
||||
version: 1.0.0
|
||||
externalDocs:
|
||||
description: Find out more about OpenSign
|
||||
url: http://docs.opensignlabs.com
|
||||
servers:
|
||||
- url: https://app.opensignlabs.com/api/v1
|
||||
tags:
|
||||
- name: OpenSign
|
||||
description: OpenSource DocuSign alternative
|
||||
externalDocs:
|
||||
description: Find out more
|
||||
url: http://www.opensignlabs.com
|
||||
- name: Github repo
|
||||
description: Access the source code
|
||||
externalDocs:
|
||||
description: Visit github
|
||||
url: http://github.com/opensignlabs/opensign
|
||||
- name: templates
|
||||
description: Operations about templates
|
||||
- name: users
|
||||
description: Operations about users
|
||||
- name: documents
|
||||
description: Operations about documents
|
||||
paths:
|
||||
/getuser:
|
||||
put:
|
||||
tags:
|
||||
- users
|
||||
summary: Update an existing pet
|
||||
description: Update an existing pet by Id
|
||||
operationId: updatePet
|
||||
requestBody:
|
||||
description: Update an existent pet in the store
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Pet'
|
||||
application/xml:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Pet'
|
||||
application/x-www-form-urlencoded:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Pet'
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: Successful operation
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Pet'
|
||||
application/xml:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Pet'
|
||||
'400':
|
||||
description: Invalid ID supplied
|
||||
'404':
|
||||
description: Pet not found
|
||||
'405':
|
||||
description: Validation exception
|
||||
security:
|
||||
- api_key: []
|
||||
post:
|
||||
tags:
|
||||
- users
|
||||
summary: Add a new pet to the store
|
||||
description: Add a new pet to the store
|
||||
operationId: addPet
|
||||
requestBody:
|
||||
description: Create a new pet in the store
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Pet'
|
||||
application/xml:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Pet'
|
||||
application/x-www-form-urlencoded:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Pet'
|
||||
required: true
|
||||
responses:
|
||||
'200':
|
||||
description: Successful operation
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Pet'
|
||||
application/xml:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Pet'
|
||||
'405':
|
||||
description: Invalid input
|
||||
security:
|
||||
- api_key: []
|
||||
/documentlist:
|
||||
get:
|
||||
tags:
|
||||
- documents
|
||||
summary: Finds Pets by status
|
||||
description: Multiple status values can be provided with comma separated strings
|
||||
operationId: findPetsByStatus
|
||||
parameters:
|
||||
- name: status
|
||||
in: query
|
||||
description: Status values that need to be considered for filter
|
||||
required: false
|
||||
explode: true
|
||||
schema:
|
||||
type: string
|
||||
default: available
|
||||
enum:
|
||||
- available
|
||||
- pending
|
||||
- sold
|
||||
responses:
|
||||
'200':
|
||||
description: successful operation
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/Pet'
|
||||
application/xml:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/Pet'
|
||||
'400':
|
||||
description: Invalid status value
|
||||
security:
|
||||
- api_key: []
|
||||
/document/:
|
||||
get:
|
||||
tags:
|
||||
- documents
|
||||
summary: Finds Pets by tags
|
||||
description: Multiple tags can be provided with comma separated strings. Use tag1, tag2, tag3 for testing.
|
||||
operationId: findPetsByTags
|
||||
parameters:
|
||||
- name: tags
|
||||
in: query
|
||||
description: Tags to filter by
|
||||
required: false
|
||||
explode: true
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
type: string
|
||||
responses:
|
||||
'200':
|
||||
description: successful operation
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/Pet'
|
||||
application/xml:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/Pet'
|
||||
'400':
|
||||
description: Invalid tag value
|
||||
security:
|
||||
- api_key: []
|
||||
/contact/{contact_id}:
|
||||
get:
|
||||
tags:
|
||||
- contacts
|
||||
summary: Find pet by ID
|
||||
description: Returns a single pet
|
||||
operationId: getPetById
|
||||
parameters:
|
||||
- name: contact_id
|
||||
in: path
|
||||
description: ID of pet to return
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
format: int64
|
||||
responses:
|
||||
'200':
|
||||
description: successful operation
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Pet'
|
||||
application/xml:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Pet'
|
||||
'400':
|
||||
description: Invalid ID supplied
|
||||
'404':
|
||||
description: Pet not found
|
||||
security:
|
||||
- api_key: []
|
||||
post:
|
||||
tags:
|
||||
- contacts
|
||||
summary: Updates a pet in the store with form data
|
||||
description: ''
|
||||
operationId: updatePetWithForm
|
||||
parameters:
|
||||
- name: contact_id
|
||||
in: path
|
||||
description: ID of pet that needs to be updated
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
format: int64
|
||||
- name: name
|
||||
in: query
|
||||
description: Name of pet that needs to be updated
|
||||
schema:
|
||||
type: string
|
||||
- name: status
|
||||
in: query
|
||||
description: Status of pet that needs to be updated
|
||||
schema:
|
||||
type: string
|
||||
responses:
|
||||
'405':
|
||||
description: Invalid input
|
||||
security:
|
||||
- api_key: []
|
||||
delete:
|
||||
tags:
|
||||
- contacts
|
||||
summary: Deletes a pet
|
||||
description: delete a pet
|
||||
operationId: deletePet
|
||||
parameters:
|
||||
- name: api_key
|
||||
in: header
|
||||
description: ''
|
||||
required: false
|
||||
schema:
|
||||
type: string
|
||||
- name: contact_id
|
||||
in: path
|
||||
description: Pet id to delete
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
format: int64
|
||||
responses:
|
||||
'400':
|
||||
description: Invalid pet value
|
||||
security:
|
||||
- api_key: []
|
||||
/contactlist:
|
||||
post:
|
||||
tags:
|
||||
- contacts
|
||||
summary: uploads an image
|
||||
description: ''
|
||||
operationId: uploadFile
|
||||
requestBody:
|
||||
content:
|
||||
application/octet-stream:
|
||||
schema:
|
||||
type: string
|
||||
format: binary
|
||||
responses:
|
||||
'200':
|
||||
description: successful operation
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/ApiResponse'
|
||||
security:
|
||||
- api_key: []
|
||||
/createdocument:
|
||||
get:
|
||||
tags:
|
||||
- documents
|
||||
summary: Returns pet inventories by status
|
||||
description: Returns a map of status codes to quantities
|
||||
operationId: getInventory
|
||||
responses:
|
||||
'200':
|
||||
description: successful operation
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: object
|
||||
additionalProperties:
|
||||
type: integer
|
||||
format: int32
|
||||
security:
|
||||
- api_key: []
|
||||
/createtemplate:
|
||||
post:
|
||||
tags:
|
||||
- templates
|
||||
summary: Place an order for a pet
|
||||
description: Place a new order in the store
|
||||
operationId: placeOrder
|
||||
requestBody:
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Order'
|
||||
application/xml:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Order'
|
||||
application/x-www-form-urlencoded:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Order'
|
||||
responses:
|
||||
'200':
|
||||
description: successful operation
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Order'
|
||||
'405':
|
||||
description: Invalid input
|
||||
/template/{template_id}:
|
||||
get:
|
||||
tags:
|
||||
- templates
|
||||
summary: Find purchase order by ID
|
||||
description: For valid response try integer IDs with value <= 5 or > 10. Other values will generate exceptions.
|
||||
operationId: getOrderById
|
||||
parameters:
|
||||
- name: template_id
|
||||
in: path
|
||||
description: ID of order that needs to be fetched
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
format: int64
|
||||
responses:
|
||||
'200':
|
||||
description: successful operation
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Order'
|
||||
application/xml:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Order'
|
||||
'400':
|
||||
description: Invalid ID supplied
|
||||
'404':
|
||||
description: Order not found
|
||||
delete:
|
||||
tags:
|
||||
- templates
|
||||
summary: Delete purchase order by ID
|
||||
description: For valid response try integer IDs with value < 1000. Anything above 1000 or nonintegers will generate API errors
|
||||
operationId: deleteOrder
|
||||
parameters:
|
||||
- name: template_id
|
||||
in: path
|
||||
description: ID of the order that needs to be deleted
|
||||
required: true
|
||||
schema:
|
||||
type: integer
|
||||
format: int64
|
||||
responses:
|
||||
'400':
|
||||
description: Invalid ID supplied
|
||||
'404':
|
||||
description: Order not found
|
||||
/templatelist:
|
||||
post:
|
||||
tags:
|
||||
- templates
|
||||
summary: Create user
|
||||
description: This can only be done by the logged in user.
|
||||
operationId: createUser
|
||||
requestBody:
|
||||
description: Created user object
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/User'
|
||||
application/xml:
|
||||
schema:
|
||||
$ref: '#/components/schemas/User'
|
||||
application/x-www-form-urlencoded:
|
||||
schema:
|
||||
$ref: '#/components/schemas/User'
|
||||
responses:
|
||||
default:
|
||||
description: successful operation
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/User'
|
||||
application/xml:
|
||||
schema:
|
||||
$ref: '#/components/schemas/User'
|
||||
components:
|
||||
schemas:
|
||||
Order:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: integer
|
||||
format: int64
|
||||
example: 10
|
||||
petId:
|
||||
type: integer
|
||||
format: int64
|
||||
example: 198772
|
||||
quantity:
|
||||
type: integer
|
||||
format: int32
|
||||
example: 7
|
||||
shipDate:
|
||||
type: string
|
||||
format: date-time
|
||||
status:
|
||||
type: string
|
||||
description: Order Status
|
||||
example: approved
|
||||
enum:
|
||||
- placed
|
||||
- approved
|
||||
- delivered
|
||||
complete:
|
||||
type: boolean
|
||||
xml:
|
||||
name: order
|
||||
Customer:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: integer
|
||||
format: int64
|
||||
example: 100000
|
||||
username:
|
||||
type: string
|
||||
example: fehguy
|
||||
address:
|
||||
type: array
|
||||
xml:
|
||||
name: addresses
|
||||
wrapped: true
|
||||
items:
|
||||
$ref: '#/components/schemas/Address'
|
||||
xml:
|
||||
name: customer
|
||||
Address:
|
||||
type: object
|
||||
properties:
|
||||
street:
|
||||
type: string
|
||||
example: 437 Lytton
|
||||
city:
|
||||
type: string
|
||||
example: Palo Alto
|
||||
state:
|
||||
type: string
|
||||
example: CA
|
||||
zip:
|
||||
type: string
|
||||
example: '94301'
|
||||
xml:
|
||||
name: address
|
||||
Category:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: integer
|
||||
format: int64
|
||||
example: 1
|
||||
name:
|
||||
type: string
|
||||
example: Dogs
|
||||
xml:
|
||||
name: category
|
||||
User:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: integer
|
||||
format: int64
|
||||
example: 10
|
||||
username:
|
||||
type: string
|
||||
example: theUser
|
||||
firstName:
|
||||
type: string
|
||||
example: John
|
||||
lastName:
|
||||
type: string
|
||||
example: James
|
||||
email:
|
||||
type: string
|
||||
example: john@email.com
|
||||
password:
|
||||
type: string
|
||||
example: '12345'
|
||||
phone:
|
||||
type: string
|
||||
example: '12345'
|
||||
userStatus:
|
||||
type: integer
|
||||
description: User Status
|
||||
format: int32
|
||||
example: 1
|
||||
xml:
|
||||
name: user
|
||||
Tag:
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: integer
|
||||
format: int64
|
||||
name:
|
||||
type: string
|
||||
xml:
|
||||
name: tag
|
||||
Pet:
|
||||
required:
|
||||
- name
|
||||
- photoUrls
|
||||
type: object
|
||||
properties:
|
||||
id:
|
||||
type: integer
|
||||
format: int64
|
||||
example: 10
|
||||
name:
|
||||
type: string
|
||||
example: doggie
|
||||
category:
|
||||
$ref: '#/components/schemas/Category'
|
||||
photoUrls:
|
||||
type: array
|
||||
xml:
|
||||
wrapped: true
|
||||
items:
|
||||
type: string
|
||||
xml:
|
||||
name: photoUrl
|
||||
tags:
|
||||
type: array
|
||||
xml:
|
||||
wrapped: true
|
||||
items:
|
||||
$ref: '#/components/schemas/Tag'
|
||||
status:
|
||||
type: string
|
||||
description: pet status in the store
|
||||
enum:
|
||||
- available
|
||||
- pending
|
||||
- sold
|
||||
xml:
|
||||
name: pet
|
||||
ApiResponse:
|
||||
type: object
|
||||
properties:
|
||||
code:
|
||||
type: integer
|
||||
format: int32
|
||||
type:
|
||||
type: string
|
||||
message:
|
||||
type: string
|
||||
xml:
|
||||
name: '##default'
|
||||
requestBodies:
|
||||
Pet:
|
||||
description: Pet object that needs to be added to the store
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Pet'
|
||||
application/xml:
|
||||
schema:
|
||||
$ref: '#/components/schemas/Pet'
|
||||
UserArray:
|
||||
description: List of user object
|
||||
content:
|
||||
application/json:
|
||||
schema:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/components/schemas/User'
|
||||
securitySchemes:
|
||||
api_key:
|
||||
type: apiKey
|
||||
name: X-Parse-ApiKey
|
||||
in: header
|
||||
@@ -0,0 +1,436 @@
|
||||
---
|
||||
id: place-order
|
||||
title: "Place an order for a pet"
|
||||
description: "Place a new order in the store"
|
||||
sidebar_label: "Place an order for a pet"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJztV21v0zAQ/iuWPzGpaZpsMOgnBkyoArGKDoHoJuQm18aQ2MF2uk1V/jt3Trp6BTT4CpMmLblX+57nLtcNd2Jl+XjOHVR1KRxYfjngOdjMyNpJrfiYT0uRARNMwRXTJgfDpGKuAGadNsAHXNdgBBlPcjSvyfyM7FBl4HsD1r3Q+Q0fb3imlQPl6FHUdSkz7xZ/tZRow21WQCXoyd3UgLH04itkDuPUhpI4iedDrcwDG4khVz7ZUptKuE705AgFcC3wVmiUjFqMAW7y147Pnh4fp+j8vRHKSXdzr/9hGvofo6stZP0KSxu4WmekWoWeORpETlbAycMJ19hf2d9FxleZzTrrICsV1+g15CRUTUUAe1hIEOhyKOUaDD5fYtZMk/edcy60LkEo3qL6uipJo0TlkfEAoxiL4lN2iJNhiGzv9ADsPwdsdHV1FdEto8aUoDKdQ/4A9b8BNZkasLVWtgMrHY3o392T2ybLwNplU7LbLwAfPMz4/4MfR6PHP1NiotailDkuCHXjfMQKXKH9WqCtB1m4At/izABWY7t1oMKCwWPSLrLhOFHQpnCutuM4xssMkRnKypUqxcIO8RIolPE64e0leWaNQdhmxKyOPKj98g1CIFHyBgWD7d0+RVNhLEQnW7mk8xcgtsOO+Pp+t72cbuveMTMZ3XKto0/InuOQD9g76WGUpFF6dJ4m6DhO0uHjNPnMdxwI8doh5EwDLR1sqf1FtiBgKWZYCnYynTAswT5hzgtpGf6ROtdZU2Ez+hZkSES2580WwkLOdLfQkZLkh8OE2Royuey7d8gu1IWa6QpYY4E6vpTqmx1fqIjNz5ZoJkXJPsLCSgeXj7bI4SfiJ+QOvM9r6YpmwQzUeme+8kIPb+h1+3KAd3VgKnu2nCFbZAY9S36TKvbGcT+TROZnEg4fSezqRc/3nYjvOLRQCEErnLyevsWyjDDWjpx/cOT47eTl6bvZKUUlencQJcMRhqJxhU1RCRUk6pdt1W/aBJlgyLR9mINd+v4Fve8BB9cuxn5Dqrf9PTZ9Q875XkNiXxXUsajZbIgkH0zZtiTGljBI8jk+roWRYkGsnNNw6buHOtg3H3/ZHTE6p/xkXjb95Lpnj2gH2xAn+I2p3W+c/TeFRsDtlJmezc7ReNH/3qgwGkqDyIPwhY7dtj8ACuxm9g==
|
||||
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"}
|
||||
>
|
||||
Place an order for a pet
|
||||
</h1>
|
||||
|
||||
<MethodEndpoint
|
||||
method={"post"}
|
||||
path={"/createtemplate"}
|
||||
>
|
||||
|
||||
</MethodEndpoint>
|
||||
|
||||
|
||||
|
||||
Place a new order in the store
|
||||
|
||||
## Request
|
||||
|
||||
<MimeTabs
|
||||
className={"openapi-tabs__mime"}
|
||||
schemaType={"request"}
|
||||
>
|
||||
<TabItem
|
||||
label={"application/json"}
|
||||
value={"application/json"}
|
||||
>
|
||||
<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={"id"}
|
||||
required={false}
|
||||
schemaName={"int64"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int64","example":10}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"petId"}
|
||||
required={false}
|
||||
schemaName={"int64"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int64","example":198772}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"quantity"}
|
||||
required={false}
|
||||
schemaName={"int32"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int32","example":7}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"shipDate"}
|
||||
required={false}
|
||||
schemaName={"date-time"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"date-time"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"status"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={"**Possible values:** [`placed`, `approved`, `delivered`]"}
|
||||
schema={{"type":"string","description":"Order Status","example":"approved","enum":["placed","approved","delivered"]}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"complete"}
|
||||
required={false}
|
||||
schemaName={"boolean"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"boolean"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"application/xml"}
|
||||
value={"application/xml"}
|
||||
>
|
||||
<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={"id"}
|
||||
required={false}
|
||||
schemaName={"int64"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int64","example":10}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"petId"}
|
||||
required={false}
|
||||
schemaName={"int64"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int64","example":198772}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"quantity"}
|
||||
required={false}
|
||||
schemaName={"int32"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int32","example":7}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"shipDate"}
|
||||
required={false}
|
||||
schemaName={"date-time"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"date-time"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"status"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={"**Possible values:** [`placed`, `approved`, `delivered`]"}
|
||||
schema={{"type":"string","description":"Order Status","example":"approved","enum":["placed","approved","delivered"]}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"complete"}
|
||||
required={false}
|
||||
schemaName={"boolean"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"boolean"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"application/x-www-form-urlencoded"}
|
||||
value={"application/x-www-form-urlencoded"}
|
||||
>
|
||||
<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={"id"}
|
||||
required={false}
|
||||
schemaName={"int64"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int64","example":10}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"petId"}
|
||||
required={false}
|
||||
schemaName={"int64"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int64","example":198772}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"quantity"}
|
||||
required={false}
|
||||
schemaName={"int32"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int32","example":7}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"shipDate"}
|
||||
required={false}
|
||||
schemaName={"date-time"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"date-time"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"status"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={"**Possible values:** [`placed`, `approved`, `delivered`]"}
|
||||
schema={{"type":"string","description":"Order Status","example":"approved","enum":["placed","approved","delivered"]}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"complete"}
|
||||
required={false}
|
||||
schemaName={"boolean"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"boolean"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</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={"id"}
|
||||
required={false}
|
||||
schemaName={"int64"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int64","example":10}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"petId"}
|
||||
required={false}
|
||||
schemaName={"int64"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int64","example":198772}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"quantity"}
|
||||
required={false}
|
||||
schemaName={"int32"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"integer","format":"int32","example":7}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"shipDate"}
|
||||
required={false}
|
||||
schemaName={"date-time"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"string","format":"date-time"}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"status"}
|
||||
required={false}
|
||||
schemaName={"string"}
|
||||
qualifierMessage={"**Possible values:** [`placed`, `approved`, `delivered`]"}
|
||||
schema={{"type":"string","description":"Order Status","example":"approved","enum":["placed","approved","delivered"]}}
|
||||
>
|
||||
|
||||
</SchemaItem><SchemaItem
|
||||
collapsible={false}
|
||||
name={"complete"}
|
||||
required={false}
|
||||
schemaName={"boolean"}
|
||||
qualifierMessage={undefined}
|
||||
schema={{"type":"boolean"}}
|
||||
>
|
||||
|
||||
</SchemaItem>
|
||||
</ul>
|
||||
</details>
|
||||
</TabItem><TabItem
|
||||
label={"Example (from schema)"}
|
||||
value={"Example (from schema)"}
|
||||
>
|
||||
<ResponseSamples
|
||||
responseExample={"{\n \"id\": 10,\n \"petId\": 198772,\n \"quantity\": 7,\n \"shipDate\": \"2023-12-24T21:10:12.539Z\",\n \"status\": \"approved\",\n \"complete\": true\n}"}
|
||||
language={"json"}
|
||||
>
|
||||
|
||||
</ResponseSamples>
|
||||
</TabItem>
|
||||
</SchemaTabs>
|
||||
</TabItem>
|
||||
</MimeTabs>
|
||||
</div>
|
||||
</TabItem><TabItem
|
||||
label={"405"}
|
||||
value={"405"}
|
||||
>
|
||||
<div>
|
||||
|
||||
|
||||
Invalid input
|
||||
|
||||
|
||||
</div><div>
|
||||
|
||||
</div>
|
||||
</TabItem>
|
||||
</ApiTabs>
|
||||
</div>
|
||||
</div>
|
||||
|
||||
@@ -0,0 +1,112 @@
|
||||
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/place-order",
|
||||
"label": "Place an order for a pet",
|
||||
"className": "api-method post"
|
||||
},
|
||||
{
|
||||
"type": "doc",
|
||||
"id": "API-docs/get-order-by-id",
|
||||
"label": "Find purchase order by ID",
|
||||
"className": "api-method get"
|
||||
},
|
||||
{
|
||||
"type": "doc",
|
||||
"id": "API-docs/delete-order",
|
||||
"label": "Delete purchase order by ID",
|
||||
"className": "api-method delete"
|
||||
},
|
||||
{
|
||||
"type": "doc",
|
||||
"id": "API-docs/create-user",
|
||||
"label": "Create user",
|
||||
"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,8 +0,0 @@
|
||||
{
|
||||
"label": "Tutorial - Basics",
|
||||
"position": 2,
|
||||
"link": {
|
||||
"type": "generated-index",
|
||||
"description": "5 minutes to learn the most important Docusaurus concepts."
|
||||
}
|
||||
}
|
||||
@@ -1,23 +0,0 @@
|
||||
---
|
||||
sidebar_position: 6
|
||||
---
|
||||
|
||||
# Congratulations!
|
||||
|
||||
You have just learned the **basics of Docusaurus** and made some changes to the **initial template**.
|
||||
|
||||
Docusaurus has **much more to offer**!
|
||||
|
||||
Have **5 more minutes**? Take a look at **[versioning](../tutorial-extras/manage-docs-versions.md)** and **[i18n](../tutorial-extras/translate-your-site.md)**.
|
||||
|
||||
Anything **unclear** or **buggy** in this tutorial? [Please report it!](https://github.com/facebook/docusaurus/discussions/4610)
|
||||
|
||||
## What's next?
|
||||
|
||||
- Read the [official documentation](https://docusaurus.io/)
|
||||
- Modify your site configuration with [`docusaurus.config.js`](https://docusaurus.io/docs/api/docusaurus-config)
|
||||
- Add navbar and footer items with [`themeConfig`](https://docusaurus.io/docs/api/themes/configuration)
|
||||
- Add a custom [Design and Layout](https://docusaurus.io/docs/styling-layout)
|
||||
- Add a [search bar](https://docusaurus.io/docs/search)
|
||||
- Find inspirations in the [Docusaurus showcase](https://docusaurus.io/showcase)
|
||||
- Get involved in the [Docusaurus Community](https://docusaurus.io/community/support)
|
||||
@@ -1,34 +0,0 @@
|
||||
---
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# Create a Blog Post
|
||||
|
||||
Docusaurus creates a **page for each blog post**, but also a **blog index page**, a **tag system**, an **RSS** feed...
|
||||
|
||||
## Create your first Post
|
||||
|
||||
Create a file at `blog/2021-02-28-greetings.md`:
|
||||
|
||||
```md title="blog/2021-02-28-greetings.md"
|
||||
---
|
||||
slug: greetings
|
||||
title: Greetings!
|
||||
authors:
|
||||
- name: Joel Marcey
|
||||
title: Co-creator of Docusaurus 1
|
||||
url: https://github.com/JoelMarcey
|
||||
image_url: https://github.com/JoelMarcey.png
|
||||
- name: Sébastien Lorber
|
||||
title: Docusaurus maintainer
|
||||
url: https://sebastienlorber.com
|
||||
image_url: https://github.com/slorber.png
|
||||
tags: [greetings]
|
||||
---
|
||||
|
||||
Congratulations, you have made your first post!
|
||||
|
||||
Feel free to play around and edit this post as much you like.
|
||||
```
|
||||
|
||||
A new blog post is now available at [http://localhost:3000/blog/greetings](http://localhost:3000/blog/greetings).
|
||||
@@ -1,57 +0,0 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Create a Document
|
||||
|
||||
Documents are **groups of pages** connected through:
|
||||
|
||||
- a **sidebar**
|
||||
- **previous/next navigation**
|
||||
- **versioning**
|
||||
|
||||
## Create your first Doc
|
||||
|
||||
Create a Markdown file at `docs/hello.md`:
|
||||
|
||||
```md title="docs/hello.md"
|
||||
# Hello
|
||||
|
||||
This is my **first Docusaurus document**!
|
||||
```
|
||||
|
||||
A new document is now available at [http://localhost:3000/docs/hello](http://localhost:3000/docs/hello).
|
||||
|
||||
## Configure the Sidebar
|
||||
|
||||
Docusaurus automatically **creates a sidebar** from the `docs` folder.
|
||||
|
||||
Add metadata to customize the sidebar label and position:
|
||||
|
||||
```md title="docs/hello.md" {1-4}
|
||||
---
|
||||
sidebar_label: 'Hi!'
|
||||
sidebar_position: 3
|
||||
---
|
||||
|
||||
# Hello
|
||||
|
||||
This is my **first Docusaurus document**!
|
||||
```
|
||||
|
||||
It is also possible to create your sidebar explicitly in `sidebars.js`:
|
||||
|
||||
```js title="sidebars.js"
|
||||
export default {
|
||||
tutorialSidebar: [
|
||||
'intro',
|
||||
// highlight-next-line
|
||||
'hello',
|
||||
{
|
||||
type: 'category',
|
||||
label: 'Tutorial',
|
||||
items: ['tutorial-basics/create-a-document'],
|
||||
},
|
||||
],
|
||||
};
|
||||
```
|
||||
@@ -1,43 +0,0 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Create a Page
|
||||
|
||||
Add **Markdown or React** files to `src/pages` to create a **standalone page**:
|
||||
|
||||
- `src/pages/index.js` → `localhost:3000/`
|
||||
- `src/pages/foo.md` → `localhost:3000/foo`
|
||||
- `src/pages/foo/bar.js` → `localhost:3000/foo/bar`
|
||||
|
||||
## Create your first React Page
|
||||
|
||||
Create a file at `src/pages/my-react-page.js`:
|
||||
|
||||
```jsx title="src/pages/my-react-page.js"
|
||||
import React from 'react';
|
||||
import Layout from '@theme/Layout';
|
||||
|
||||
export default function MyReactPage() {
|
||||
return (
|
||||
<Layout>
|
||||
<h1>My React page</h1>
|
||||
<p>This is a React page</p>
|
||||
</Layout>
|
||||
);
|
||||
}
|
||||
```
|
||||
|
||||
A new page is now available at [http://localhost:3000/my-react-page](http://localhost:3000/my-react-page).
|
||||
|
||||
## Create your first Markdown Page
|
||||
|
||||
Create a file at `src/pages/my-markdown-page.md`:
|
||||
|
||||
```mdx title="src/pages/my-markdown-page.md"
|
||||
# My Markdown page
|
||||
|
||||
This is a Markdown page
|
||||
```
|
||||
|
||||
A new page is now available at [http://localhost:3000/my-markdown-page](http://localhost:3000/my-markdown-page).
|
||||
@@ -1,31 +0,0 @@
|
||||
---
|
||||
sidebar_position: 5
|
||||
---
|
||||
|
||||
# Deploy your site
|
||||
|
||||
Docusaurus is a **static-site-generator** (also called **[Jamstack](https://jamstack.org/)**).
|
||||
|
||||
It builds your site as simple **static HTML, JavaScript and CSS files**.
|
||||
|
||||
## Build your site
|
||||
|
||||
Build your site **for production**:
|
||||
|
||||
```bash
|
||||
npm run build
|
||||
```
|
||||
|
||||
The static files are generated in the `build` folder.
|
||||
|
||||
## Deploy your site
|
||||
|
||||
Test your production build locally:
|
||||
|
||||
```bash
|
||||
npm run serve
|
||||
```
|
||||
|
||||
The `build` folder is now served at [http://localhost:3000/](http://localhost:3000/).
|
||||
|
||||
You can now deploy the `build` folder **almost anywhere** easily, **for free** or very small cost (read the **[Deployment Guide](https://docusaurus.io/docs/deployment)**).
|
||||
@@ -1,150 +0,0 @@
|
||||
---
|
||||
sidebar_position: 4
|
||||
---
|
||||
|
||||
# Markdown Features
|
||||
|
||||
Docusaurus supports **[Markdown](https://daringfireball.net/projects/markdown/syntax)** and a few **additional features**.
|
||||
|
||||
## Front Matter
|
||||
|
||||
Markdown documents have metadata at the top called [Front Matter](https://jekyllrb.com/docs/front-matter/):
|
||||
|
||||
```text title="my-doc.md"
|
||||
// highlight-start
|
||||
---
|
||||
id: my-doc-id
|
||||
title: My document title
|
||||
description: My document description
|
||||
slug: /my-custom-url
|
||||
---
|
||||
// highlight-end
|
||||
|
||||
## Markdown heading
|
||||
|
||||
Markdown text with [links](./hello.md)
|
||||
```
|
||||
|
||||
## Links
|
||||
|
||||
Regular Markdown links are supported, using url paths or relative file paths.
|
||||
|
||||
```md
|
||||
Let's see how to [Create a page](/create-a-page).
|
||||
```
|
||||
|
||||
```md
|
||||
Let's see how to [Create a page](./create-a-page.md).
|
||||
```
|
||||
|
||||
**Result:** Let's see how to [Create a page](./create-a-page.md).
|
||||
|
||||
## Images
|
||||
|
||||
Regular Markdown images are supported.
|
||||
|
||||
You can use absolute paths to reference images in the static directory (`static/img/docusaurus.png`):
|
||||
|
||||
```md
|
||||
|
||||
```
|
||||
|
||||
|
||||
|
||||
You can reference images relative to the current file as well. This is particularly useful to colocate images close to the Markdown files using them:
|
||||
|
||||
```md
|
||||
|
||||
```
|
||||
|
||||
## Code Blocks
|
||||
|
||||
Markdown code blocks are supported with Syntax highlighting.
|
||||
|
||||
```jsx title="src/components/HelloDocusaurus.js"
|
||||
function HelloDocusaurus() {
|
||||
return (
|
||||
<h1>Hello, Docusaurus!</h1>
|
||||
)
|
||||
}
|
||||
```
|
||||
|
||||
```jsx title="src/components/HelloDocusaurus.js"
|
||||
function HelloDocusaurus() {
|
||||
return <h1>Hello, Docusaurus!</h1>;
|
||||
}
|
||||
```
|
||||
|
||||
## Admonitions
|
||||
|
||||
Docusaurus has a special syntax to create admonitions and callouts:
|
||||
|
||||
:::tip My tip
|
||||
|
||||
Use this awesome feature option
|
||||
|
||||
:::
|
||||
|
||||
:::danger Take care
|
||||
|
||||
This action is dangerous
|
||||
|
||||
:::
|
||||
|
||||
:::tip My tip
|
||||
|
||||
Use this awesome feature option
|
||||
|
||||
:::
|
||||
|
||||
:::danger Take care
|
||||
|
||||
This action is dangerous
|
||||
|
||||
:::
|
||||
|
||||
## MDX and React Components
|
||||
|
||||
[MDX](https://mdxjs.com/) can make your documentation more **interactive** and allows using any **React components inside Markdown**:
|
||||
|
||||
```jsx
|
||||
export const Highlight = ({children, color}) => (
|
||||
<span
|
||||
style={{
|
||||
backgroundColor: color,
|
||||
borderRadius: '20px',
|
||||
color: '#fff',
|
||||
padding: '10px',
|
||||
cursor: 'pointer',
|
||||
}}
|
||||
onClick={() => {
|
||||
alert(`You clicked the color ${color} with label ${children}`)
|
||||
}}>
|
||||
{children}
|
||||
</span>
|
||||
);
|
||||
|
||||
This is <Highlight color="#25c2a0">Docusaurus green</Highlight> !
|
||||
|
||||
This is <Highlight color="#1877F2">Facebook blue</Highlight> !
|
||||
```
|
||||
|
||||
export const Highlight = ({children, color}) => (
|
||||
<span
|
||||
style={{
|
||||
backgroundColor: color,
|
||||
borderRadius: '20px',
|
||||
color: '#fff',
|
||||
padding: '10px',
|
||||
cursor: 'pointer',
|
||||
}}
|
||||
onClick={() => {
|
||||
alert(`You clicked the color ${color} with label ${children}`);
|
||||
}}>
|
||||
{children}
|
||||
</span>
|
||||
);
|
||||
|
||||
This is <Highlight color="#25c2a0">Docusaurus green</Highlight> !
|
||||
|
||||
This is <Highlight color="#1877F2">Facebook blue</Highlight> !
|
||||
@@ -1,7 +0,0 @@
|
||||
{
|
||||
"label": "Tutorial - Extras",
|
||||
"position": 3,
|
||||
"link": {
|
||||
"type": "generated-index"
|
||||
}
|
||||
}
|
||||
Binary file not shown.
|
Before Width: | Height: | Size: 25 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 27 KiB |
@@ -1,55 +0,0 @@
|
||||
---
|
||||
sidebar_position: 1
|
||||
---
|
||||
|
||||
# Manage Docs Versions
|
||||
|
||||
Docusaurus can manage multiple versions of your docs.
|
||||
|
||||
## Create a docs version
|
||||
|
||||
Release a version 1.0 of your project:
|
||||
|
||||
```bash
|
||||
npm run docusaurus docs:version 1.0
|
||||
```
|
||||
|
||||
The `docs` folder is copied into `versioned_docs/version-1.0` and `versions.json` is created.
|
||||
|
||||
Your docs now have 2 versions:
|
||||
|
||||
- `1.0` at `http://localhost:3000/docs/` for the version 1.0 docs
|
||||
- `current` at `http://localhost:3000/docs/next/` for the **upcoming, unreleased docs**
|
||||
|
||||
## Add a Version Dropdown
|
||||
|
||||
To navigate seamlessly across versions, add a version dropdown.
|
||||
|
||||
Modify the `docusaurus.config.js` file:
|
||||
|
||||
```js title="docusaurus.config.js"
|
||||
export default {
|
||||
themeConfig: {
|
||||
navbar: {
|
||||
items: [
|
||||
// highlight-start
|
||||
{
|
||||
type: 'docsVersionDropdown',
|
||||
},
|
||||
// highlight-end
|
||||
],
|
||||
},
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
The docs version dropdown appears in your navbar:
|
||||
|
||||
|
||||
|
||||
## Update an existing version
|
||||
|
||||
It is possible to edit versioned docs in their respective folder:
|
||||
|
||||
- `versioned_docs/version-1.0/hello.md` updates `http://localhost:3000/docs/hello`
|
||||
- `docs/hello.md` updates `http://localhost:3000/docs/next/hello`
|
||||
@@ -1,88 +0,0 @@
|
||||
---
|
||||
sidebar_position: 2
|
||||
---
|
||||
|
||||
# Translate your site
|
||||
|
||||
Let's translate `docs/intro.md` to French.
|
||||
|
||||
## Configure i18n
|
||||
|
||||
Modify `docusaurus.config.js` to add support for the `fr` locale:
|
||||
|
||||
```js title="docusaurus.config.js"
|
||||
export default {
|
||||
i18n: {
|
||||
defaultLocale: 'en',
|
||||
locales: ['en', 'fr'],
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
## Translate a doc
|
||||
|
||||
Copy the `docs/intro.md` file to the `i18n/fr` folder:
|
||||
|
||||
```bash
|
||||
mkdir -p i18n/fr/docusaurus-plugin-content-docs/current/
|
||||
|
||||
cp docs/intro.md i18n/fr/docusaurus-plugin-content-docs/current/intro.md
|
||||
```
|
||||
|
||||
Translate `i18n/fr/docusaurus-plugin-content-docs/current/intro.md` in French.
|
||||
|
||||
## Start your localized site
|
||||
|
||||
Start your site on the French locale:
|
||||
|
||||
```bash
|
||||
npm run start -- --locale fr
|
||||
```
|
||||
|
||||
Your localized site is accessible at [http://localhost:3000/fr/](http://localhost:3000/fr/) and the `Getting Started` page is translated.
|
||||
|
||||
:::caution
|
||||
|
||||
In development, you can only use one locale at a time.
|
||||
|
||||
:::
|
||||
|
||||
## Add a Locale Dropdown
|
||||
|
||||
To navigate seamlessly across languages, add a locale dropdown.
|
||||
|
||||
Modify the `docusaurus.config.js` file:
|
||||
|
||||
```js title="docusaurus.config.js"
|
||||
export default {
|
||||
themeConfig: {
|
||||
navbar: {
|
||||
items: [
|
||||
// highlight-start
|
||||
{
|
||||
type: 'localeDropdown',
|
||||
},
|
||||
// highlight-end
|
||||
],
|
||||
},
|
||||
},
|
||||
};
|
||||
```
|
||||
|
||||
The locale dropdown now appears in your navbar:
|
||||
|
||||
|
||||
|
||||
## Build your localized site
|
||||
|
||||
Build your site for a specific locale:
|
||||
|
||||
```bash
|
||||
npm run build -- --locale fr
|
||||
```
|
||||
|
||||
Or build your site to include all the locales at once:
|
||||
|
||||
```bash
|
||||
npm run build
|
||||
```
|
||||
@@ -0,0 +1,117 @@
|
||||
---
|
||||
id: update-pet-with-form
|
||||
title: "Updates a pet in the store with form data"
|
||||
description: ""
|
||||
sidebar_label: "Updates a pet in the store with form data"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJylVWFr2zAQ/StCn1ZI45Z1+2DGWNm6ElaasLR00Jqi2OdY1JZVSW4WjP/77mQ7yZK0ZAxCYp/e3T3du7vU3Im55eE9j0vlROwsjwY8ARsbqZ0sFQ85H/BSgxH0OkrQUOlEOJiAu5Mu+16aAhFaGFGAA0PBaq7wBZFd0EeZIERSMC1cxrczjL6xMmUaHHOZcEwBJJa5ks2AtbnI3cBzJQ0+hs5UMOA2zqAQPKy5W2pKJpWDORiEpshJuNb08Yw3zWDFyP90XJ4rMMsdMteIOIDOTnrrjFTzv5JZJ1xl30439Zj/ShhRcawulQVL52cnH+hnq8bqReQyYVLpyhFLbiGujHRLL5jQ8vEJ6DmieChlVpLWurTOy4uyhTzoBA3qtbINcQPz0ktfmRyRmXPahkEgtB5i9ygr5yoXMzuMywKNMng55ZSoJzGl27X0V1RWN0XLD6DSdXX9dTwRxsLxeW/39c1AJCg/XU2qtPT+0uXkMEYGU2TAzicjhpm3RbjJpGX4oeOkjKsC8HZ0xrCV2JY3mwkLCcNDl4E/JPv74SmzGmKZyti7DtmDelDTErupspBWOculerLhgzpm9+MUYVLk7A5mVjqI3vUFWywWOwU78j6XOG3VjBnQ5Ro+90Zf1U2v1csR3hWnsrDjdIoiyRg6cV5JFXhwgF6dwlRG7DuZr8f5y7YTx5LnGBobkOCdSueXkyssywnGWvfEAZSDq9HXi+vpBUWlrmolOh2eYCg0UUcWQm0kuvUzYpnwIyRbXawrDbAF5iINC4YQsa177W+EWrdbrus2B79doHOBTdV01OtuAFZrEtHhxnLDRs5oUBBQ19QetyZvGjK3Q09zkUgrZjntr1TkFt6gcuAG2kvXD06/5XDiK4Jw2kmH5z94Jb3BYLX61hwiejGSSPxjQd797Hb/ETvor2Ivr36XqOUmq57vhphN1GwswMl4eoMoUZH+mxvpyW+e7oHuszfBzqpq09E3ibLX5xPtE0R/XsHbk1cdus3Xo+m+UdM0fwBW06xT
|
||||
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,"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","schema":{"type":"string"}}}
|
||||
>
|
||||
|
||||
</ParamsItem><ParamsItem
|
||||
className={"paramsItem"}
|
||||
param={{"name":"status","in":"query","description":"Status of pet that needs to be updated","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
@@ -0,0 +1,183 @@
|
||||
---
|
||||
id: upload-file
|
||||
title: "uploads an image"
|
||||
description: ""
|
||||
sidebar_label: "uploads an image"
|
||||
hide_title: true
|
||||
hide_table_of_contents: true
|
||||
api: eJyNVG1P2zAQ/iuW+TKktinwrZqmdYghNLRWK9MmQTU5zqUxJLZnO0BV9b/vzklKKFRaVbXJvT5399xteBArzye3XBodhAyeLwc8Ay+dskEZzSecD7ix4AS9XmUoqG1pRPZVlYAqB39r8OGLydZ8solhQAd6FNaWSka3xMgAYeiDA1GRzssCKkFPYW0BY6JK6RXGy42rBPrzVGnh1nyLH8rirdEePLmcjsf09xqlr6UE7/O6ZDu0GO4AnntPTu/gMOk9yICO1lGYoJqU0mTQs1IYdAWuDxdFZ6ccoTYm+4WhokJ4YvWeDpXPVUkKLSpSHB1lkIu6DDGgCiUJp1b9aNsQu4IqD7J2KmDnb6k+9ecB6Hm5XVK6UBgalzU+FiRCgW9JO+hSRakH9wjOxwC1Qwy8CMH6SZJgu0bYAu3VSpci9SNpKhSq5PGEU/wu94Ja2HRph2BXIUq+oWDQFfZ7OBfOw3DayRXNrgCRYTepIqVzE/3bomeIYIEI2HR+xTDzPjlvCuUZfkmdGVlXOOw4YoaTYXveLBUeMobKUEBUkvxsdMK8Banylh0jdqfv9MJUwGoPxKhS6Qc/udNDdjvL0UyJkv2C1KsAyw9dw56ent407Dj6XKpQ1ClzYM2L+SoKY1f7XruXY6w1gKv8LF/gkJSEdjgHUiXROGk5jxOmNiK5FQ21FX3edyJ+4VIAceqFftPL+TW2ZYyxXjjxH5CT66vzi++LC4pKrGpGdDIaYygUEREroXuJmkvimdBMVbQbe+Pt3RM6Qy2pAjyHxJYCubNtEW5aeu/uWKQ3srQg8qN4s6HZ/3TldktivFkubgoCFU6JlMiGezPouEj7EKnMzxsEwxtKTuZl3TD7wHXbDjrPKV4kGw74xAv0ak/ns8UNGqftJa3iyeE5nVnEJWqqr79YD3GB2gfC26n0upfzzcY12OiXkL7r85HWAq0/7cwbzUGHtmmdNQ1miQfqH+T/LPc=
|
||||
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>
|
||||
|
||||
@@ -6,6 +6,7 @@
|
||||
|
||||
import {themes as prismThemes} from 'prism-react-renderer';
|
||||
|
||||
|
||||
/** @type {import('@docusaurus/types').Config} */
|
||||
const config = {
|
||||
title: 'OpenSign™',
|
||||
@@ -45,6 +46,7 @@ const config = {
|
||||
// Remove this to remove the "edit this page" links.
|
||||
editUrl:
|
||||
'https://github.com/opensignlabs/opensign/tree/feat-docs/docs/',
|
||||
docItemComponent: "@theme/ApiItem" // derived from docusaurus-theme-openapi-docs
|
||||
},
|
||||
blog: {
|
||||
showReadingTime: true,
|
||||
@@ -60,11 +62,38 @@ const config = {
|
||||
],
|
||||
],
|
||||
|
||||
plugins: [
|
||||
[
|
||||
"docusaurus-plugin-openapi-docs",
|
||||
{
|
||||
id: "openapi",
|
||||
docsPluginId: "default", // e.g. "classic" or the plugin-content-docs id
|
||||
config: {
|
||||
opensign: { // "petstore" is considered the <id> that you will reference in the CLI
|
||||
specPath: "docs/API-docs/opensign.yaml", // path or URL to the OpenAPI spec
|
||||
outputDir: "docs/API-docs", // output directory for generated *.mdx and sidebar.js files
|
||||
sidebarOptions: {
|
||||
groupPathsBy: "tag", // generate a sidebar.js slice that groups operations by tag
|
||||
},
|
||||
}
|
||||
}
|
||||
},
|
||||
]
|
||||
],
|
||||
themes: ["docusaurus-theme-openapi-docs"], // exports ApiItem and ApiDemoPanel
|
||||
themeConfig:
|
||||
/** @type {import('@docusaurus/preset-classic').ThemeConfig} */
|
||||
({
|
||||
announcementBar: {
|
||||
id: 'support_us',
|
||||
content:
|
||||
'Help use spread the word - ⭐ OpenSign on <a target="_blank" rel="noopener" href="https://github.com/opensignlabs/opensign">GitHub</a>',
|
||||
backgroundColor: '#cae4fa',
|
||||
textColor: '#091E42',
|
||||
isCloseable: false,
|
||||
},
|
||||
// Replace with your project's social card
|
||||
image: 'img/docusaurus-social-card.jpg',
|
||||
image: 'img/docusaurus-social-card.png',
|
||||
navbar: {
|
||||
title: 'OpenSign™',
|
||||
logo: {
|
||||
|
||||
Generated
+4017
-575
File diff suppressed because it is too large
Load Diff
+6
-2
@@ -14,10 +14,14 @@
|
||||
"write-heading-ids": "docusaurus write-heading-ids"
|
||||
},
|
||||
"dependencies": {
|
||||
"@docusaurus/core": "3.0.0",
|
||||
"@docusaurus/preset-classic": "3.0.0",
|
||||
"@docusaurus/core": "3.0.1",
|
||||
"@docusaurus/plugin-content-docs": "^3.0.1",
|
||||
"@docusaurus/preset-classic": "3.0.1",
|
||||
"@mdx-js/react": "^3.0.0",
|
||||
"add": "^2.0.6",
|
||||
"clsx": "^1.2.1",
|
||||
"docusaurus-plugin-openapi-docs": "^3.0.0-beta.3",
|
||||
"docusaurus-theme-openapi-docs": "^3.0.0-beta.3",
|
||||
"prism-react-renderer": "^2.1.0",
|
||||
"react": "^18.0.0",
|
||||
"react-dom": "^18.0.0"
|
||||
|
||||
+2
-1
@@ -10,6 +10,7 @@
|
||||
*/
|
||||
|
||||
// @ts-check
|
||||
import apiSidebar from './docs/API-docs/sidebar.ts';
|
||||
|
||||
/** @type {import('@docusaurus/plugin-content-docs').SidebarsConfig} */
|
||||
const sidebars = {
|
||||
@@ -17,7 +18,7 @@ const sidebars = {
|
||||
tutorialSidebar: [{type: 'autogenerated', dirName: 'help'}],
|
||||
selfhostSidebar: [{type: 'autogenerated', dirName: 'self-host'}],
|
||||
contributeSidebar: [{type: 'autogenerated', dirName: 'contribute'}],
|
||||
apiSidebar: [{type: 'autogenerated', dirName: 'API-docs'}],
|
||||
apiSidebar: apiSidebar,
|
||||
|
||||
|
||||
// But you can create a sidebar manually
|
||||
|
||||
BIN
Binary file not shown.
|
After Width: | Height: | Size: 490 KiB |
Reference in New Issue
Block a user