mirror of
https://github.com/OpenSignLabs/OpenSign.git
synced 2026-08-30 19:59:49 +02:00
1 line
8.4 KiB
JavaScript
1 line
8.4 KiB
JavaScript
"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9697],{45212:(e,s,a)=>{a.r(s),a.d(s,{assets:()=>f,contentTitle:()=>x,default:()=>v,frontMatter:()=>h,metadata:()=>j,toc:()=>b});var l=a(85893),n=a(11151),t=a(58219),i=(a(62316),a(51039)),c=a.n(i),r=(a(82723),a(9487)),d=a(41429),o=a(5397),m=a(4667),p=a(9472),u=a(85162);const h={id:"createdocument",title:"Create document",description:"Create document",sidebar_label:"Create document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vk1v2zgQ/SvsnBpAsRS3uQiLxQZtUQQtmqDOYg+OEdDUyGJCUSxJOfIa+u+LoWStbKVI97IXx5kP8c2b9yjvwfONg3QJHytRl6i9g1UElUHLvaz0dQYpCIvcY9YXQASGW16iR0ude9C8REihOedGnvvqCTVEIDWkUCDP0EIEFn/U0mIGqbc1RuD8TlGPk6VRCBFgY1SVIaQ5V44KRIElh3QPfmdCpbdSb6ClUh6aUoKpndzoWdM0DbQrOseZSjt01DlPEvqToRNWGhoH0mFO1k/FXC0EOpfXSu3eQASi0p7GTPfAjVFSBCLiR0ft+ymwav2IIrBiiTYvu8NFmGao0nW5DkwM6OdJ0kZQonN8g9NBx3O+grkNc9fKv46qC9NWp+fllS25fxlB8SjnfzdiO7+l02qr/vMDvDcujeM+MhNVCW0bgZc+5KVWUuPDYX8P8yR5uHzox3q1ENqWat4nl9OFX+stVzJjV7fX7I7E+X8u+X1y+atLHuP0HU6aqSkD173HZFfUmeyIlXG8Y8OhqK30u+DRsTnT5Yq8ckzThyAtNnJ5ib6oyP+mcp3rfQEpxJPrwKHdHu6CII1h29yY2cGkiq8drT3mRsbbi2DXA8QF8d1RegR04Isb+QV3EL1+19DkUudVaO7ZuTGoF3KjA7fbCzid/a6QjkkX0oe5giBYXll20s3W3GHGKs18gSFJ8XezC+YMCpn3Wpqxe32vF1WJrHaY14opqZ9ceq/P2fImz6WQXLG/cO2kx9XbA2PPz88Txs5Cz2fpi3rNLJrq3/JNCAZax13DP2cQgUdbupt8gXYrxcGLPzkqDsVx7xAugkOw5JK22of+OG0iISopUDscSfXq8+1X9m6WQDQSxS9Ajr9ef/j0bfGJnkqy6lZ0MUtmCYVIjCXXo4Omyj3a7qAhj42PjeJSj+6wTtTL03fcKoKCVJ8uYb+nhf9pVdtS+EeNliy1imDLreRrUthy1UYHAZILMukokQ2vsxNEw/UDb7/3b8YzRqt6CekT7iaK33JVUyW00b4vuBICjR/lJhcbOW4w9e3N4g4i4DXNP/bZU/BZ/4WGOaT0bvTwYzgdAvokPC82/EYu+YK734fyLvPThuG3Q1dNXKzatv0Hr176Dw==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/createdocument",title:"Create document",description:"Create document",source:"@site/docs/API-docs/createdocument.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/createdocument",permalink:"/docs/API-docs/createdocument",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"createdocument",title:"Create document",description:"Create document",sidebar_label:"Create document",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vk1v2zgQ/SvsnBpAsRS3uQiLxQZtUQQtmqDOYg+OEdDUyGJCUSxJOfIa+u+LoWStbKVI97IXx5kP8c2b9yjvwfONg3QJHytRl6i9g1UElUHLvaz0dQYpCIvcY9YXQASGW16iR0ude9C8REihOedGnvvqCTVEIDWkUCDP0EIEFn/U0mIGqbc1RuD8TlGPk6VRCBFgY1SVIaQ5V44KRIElh3QPfmdCpbdSb6ClUh6aUoKpndzoWdM0DbQrOseZSjt01DlPEvqToRNWGhoH0mFO1k/FXC0EOpfXSu3eQASi0p7GTPfAjVFSBCLiR0ft+ymwav2IIrBiiTYvu8NFmGao0nW5DkwM6OdJ0kZQonN8g9NBx3O+grkNc9fKv46qC9NWp+fllS25fxlB8SjnfzdiO7+l02qr/vMDvDcujeM+MhNVCW0bgZc+5KVWUuPDYX8P8yR5uHzox3q1ENqWat4nl9OFX+stVzJjV7fX7I7E+X8u+X1y+atLHuP0HU6aqSkD173HZFfUmeyIlXG8Y8OhqK30u+DRsTnT5Yq8ckzThyAtNnJ5ib6oyP+mcp3rfQEpxJPrwKHdHu6CII1h29yY2cGkiq8drT3mRsbbi2DXA8QF8d1RegR04Isb+QV3EL1+19DkUudVaO7ZuTGoF3KjA7fbCzid/a6QjkkX0oe5giBYXll20s3W3GHGKs18gSFJ8XezC+YMCpn3Wpqxe32vF1WJrHaY14opqZ9ceq/P2fImz6WQXLG/cO2kx9XbA2PPz88Txs5Cz2fpi3rNLJrq3/JNCAZax13DP2cQgUdbupt8gXYrxcGLPzkqDsVx7xAugkOw5JK22of+OG0iISopUDscSfXq8+1X9m6WQDQSxS9Ajr9ef/j0bfGJnkqy6lZ0MUtmCYVIjCXXo4Omyj3a7qAhj42PjeJSj+6wTtTL03fcKoKCVJ8uYb+nhf9pVdtS+EeNliy1imDLreRrUthy1UYHAZILMukokQ2vsxNEw/UDb7/3b8YzRqt6CekT7iaK33JVUyW00b4vuBICjR/lJhcbOW4w9e3N4g4i4DXNP/bZU/BZ/4WGOaT0bvTwYzgdAvokPC82/EYu+YK734fyLvPThuG3Q1dNXKzatv0Hr176Dw==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Get contact list",permalink:"/docs/API-docs/contactlist"},next:{title:"Get document by ID",permalink:"/docs/API-docs/getdocument"}},f={},b=[{value:"Request",id:"request",level:2}];function g(e){const s={h2:"h2",p:"p",...(0,n.a)(),...e.components},{Details:a}=s;return a||function(e,s){throw new Error("Expected "+(s?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,l.jsxs)(l.Fragment,{children:[(0,l.jsx)("h1",{className:"openapi__heading",children:(0,l.jsx)(s.p,{children:"Create document"})}),"\n",(0,l.jsx)(c(),{method:"post",path:"/createdocument"}),"\n",(0,l.jsx)(s.p,{children:"Create document"}),"\n",(0,l.jsx)(s.h2,{id:"request",children:"Request"}),"\n",(0,l.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,l.jsx)(s.p,{children:"Header Parameters"})})}),(0,l.jsx)("div",{children:(0,l.jsx)("ul",{children:(0,l.jsx)(d.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,l.jsx)("div",{children:(0,l.jsx)("div",{children:(0,l.jsxs)(t.Z,{children:[(0,l.jsxs)(u.default,{label:"200",value:"200",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Document created successfully!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:200}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Document created successfully!"}}),(0,l.jsx)(m.Z,{collapsible:!0,className:"schemaItem",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details",children:[(0,l.jsx)("summary",{style:{},children:(0,l.jsxs)("span",{className:"openapi-schema__container",children:[(0,l.jsx)("strong",{className:"openapi-schema__property",children:(0,l.jsx)(s.p,{children:"result"})}),(0,l.jsx)("span",{className:"openapi-schema__name",children:(0,l.jsx)(s.p,{children:"object"})})]})}),(0,l.jsxs)("div",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://example.com"}})]})]})})]})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "code": 200,\n "message": "Document created successfully!",\n "result": {\n "objectId": "hji2zxcv2P",\n "url": "https://example.com"\n }\n}',language:"json"})})]})})})})]}),(0,l.jsxs)(u.default,{label:"405",value:"405",children:[(0,l.jsx)("div",{children:(0,l.jsx)(s.p,{children:"Invalid API Token!"})}),(0,l.jsx)("div",{children:(0,l.jsx)(r.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,l.jsx)(u.default,{label:"application/json",value:"application/json",children:(0,l.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,l.jsx)(u.default,{label:"Schema",value:"Schema",children:(0,l.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,l.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,l.jsx)("strong",{children:(0,l.jsx)(s.p,{children:"Schema"})})}),(0,l.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,l.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,l.jsx)(m.Z,{collapsible:!1,name:"code",required:!1,schemaName:"number",qualifierMessage:void 0,schema:{type:"number",example:405}}),(0,l.jsx)(m.Z,{collapsible:!1,name:"message",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})]})]})}),(0,l.jsx)(u.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,l.jsx)(o.Z,{responseExample:'{\n "code": 405,\n "message": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function v(e={}){const{wrapper:s}={...(0,n.a)(),...e.components};return s?(0,l.jsx)(s,{...e,children:(0,l.jsx)(g,{...e})}):g(e)}}}]); |