WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-29 04:54:56 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
1beb63cac7a5e7a2d2d3409164b7eb2a6faade0e
OpenSign/assets/js/2c586be5.d853e169.js
T

1 line
8.9 KiB
JavaScript
Raw Blame History

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[9697],{45212:(e,a,s)=>{s.r(a),s.d(a,{assets:()=>g,contentTitle:()=>u,default:()=>f,frontMatter:()=>x,metadata:()=>j,toc:()=>y});var t=s(85893),l=s(11151),i=s(58219),r=(s(62316),s(51039)),n=s.n(r),o=(s(82723),s(9487)),c=s(41429),d=s(5397),m=s(4667),p=s(9472),h=s(85162);const x={id:"createdocument",title:"Create document",description:"Create document",sidebar_label:"Create document",hide_title:!0,hide_table_of_contents:!0,api:"eJytVttu4zYQ/RV2njaAbDnZ9kUoiqbZxSLYRRLUKfrgGAEtjexJJJJLUo5VQ/9eDCXL8mXbLdAXX+ZCzpw5Z6QteLl0kMzgg06rEpV3MI9AG7TSk1a3GSSQWpQesy4AIjDSyhI9Ws7cgpIlQgKbkTQ08voVFURAChJYoczQQgQWv1ZkMYPE2wojcL4uOMdRaQqECHBjCp0hJLksHAekKywlJFvwtQmR3pJaQsOhMiQlXKZytFTjzWazgWbe3oPO/6azmnNTrTyXnGyhrApPRlof59qWo0z6cPrJPXrxgmlo0jIKntCxNye+8biaCPgw6SGBBSlpa67vLsBxpvAP6FJLhnE967/T/nzilJYqgN37pLWyZpQ9lu5MTtNE4MkHlA7H97xgbELA4VCCwRmtXNvx1WTCX9mw6J4lojtUuCpN0bm8Kor6B4iGiEtjCkoDjeIX1/b8vXC3ZmbfP0DeW/aMWL3Q1V+bdH31wLhVtvjPB3hvXBLHnWWc6hKGYJIqSOHzDqnnq8nk+ZLhbCL4cfLTKWK3ai0LysT1w614ZG38jyihtdqe63Dfz/B6317PpW7KgEynXGqDWukeNDu0t006TCtLvg7KH0o+mc1ZgYfd3wSaiMHuKNGvNG8Vo127S/wKEohPloxDu95tmDDIfjbOyyWp5UgaM96tgEIuHA8rlobi9WVYBrtSpwxni9hBwXs1GfqMLKd/3WSMAKlch+QOpXuDihUaMF5fwjEGjytyglxw7/oL8xa5tuIoWyykw0xoJfwKg5Pt78eXwhlMKe+oMhZP6klNdYmicphXhShIvbrkSY3E7D7PKSVZiD9x4cjj/N0Oube3txPELkLOJ/KraiEsGr0PXwZjgHWY1f+5gAg82tLd51O0a0p3CvrGVXEIjjsByDQIAEtJPN3O9OtxEhOyoBSVwwFlrz89fBHvxxOIBuT4jpLjL7c3H++mH/lUplc7osvxZDxhE5OylGpw0SmDs7Nr3OPGx6aQpAabpyX37PgJOo9gxexPZrDd8sD/sEXTsPlrhZalNY9gLS3JBTNsNm+iHQFZDRk5dmT9w/Koon67wLvfuxV/IXhU5yp9xfqE8WtZVBwJTbTtAm7aM0ePfMY+4txTdZ90naZo/CD8ZNmxTPuN8HA/fYQIFt3DuwzvA2Fbh3Oj/c8WElkxukMVvwYVdz8Yqp1L1YMqDpttS+VPLvxsws+swc9Y/9KHt55vJvTvPW00Iz1vmuZvSAo88Q==",sidebar_class_name:"post api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=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:"eJytVttu4zYQ/RV2njaAbDnZ9kUoiqbZxSLYRRLUKfrgGAEtjexJJJJLUo5VQ/9eDCXL8mXbLdAXX+ZCzpw5Z6QteLl0kMzgg06rEpV3MI9AG7TSk1a3GSSQWpQesy4AIjDSyhI9Ws7cgpIlQgKbkTQ08voVFURAChJYoczQQgQWv1ZkMYPE2wojcL4uOMdRaQqECHBjCp0hJLksHAekKywlJFvwtQmR3pJaQsOhMiQlXKZytFTjzWazgWbe3oPO/6azmnNTrTyXnGyhrApPRlof59qWo0z6cPrJPXrxgmlo0jIKntCxNye+8biaCPgw6SGBBSlpa67vLsBxpvAP6FJLhnE967/T/nzilJYqgN37pLWyZpQ9lu5MTtNE4MkHlA7H97xgbELA4VCCwRmtXNvx1WTCX9mw6J4lojtUuCpN0bm8Kor6B4iGiEtjCkoDjeIX1/b8vXC3ZmbfP0DeW/aMWL3Q1V+bdH31wLhVtvjPB3hvXBLHnWWc6hKGYJIqSOHzDqnnq8nk+ZLhbCL4cfLTKWK3ai0LysT1w614ZG38jyihtdqe63Dfz/B6317PpW7KgEynXGqDWukeNDu0t006TCtLvg7KH0o+mc1ZgYfd3wSaiMHuKNGvNG8Vo127S/wKEohPloxDu95tmDDIfjbOyyWp5UgaM96tgEIuHA8rlobi9WVYBrtSpwxni9hBwXs1GfqMLKd/3WSMAKlch+QOpXuDihUaMF5fwjEGjytyglxw7/oL8xa5tuIoWyykw0xoJfwKg5Pt78eXwhlMKe+oMhZP6klNdYmicphXhShIvbrkSY3E7D7PKSVZiD9x4cjj/N0Oube3txPELkLOJ/KraiEsGr0PXwZjgHWY1f+5gAg82tLd51O0a0p3CvrGVXEIjjsByDQIAEtJPN3O9OtxEhOyoBSVwwFlrz89fBHvxxOIBuT4jpLjL7c3H++mH/lUplc7osvxZDxhE5OylGpw0SmDs7Nr3OPGx6aQpAabpyX37PgJOo9gxexPZrDd8sD/sEXTsPlrhZalNY9gLS3JBTNsNm+iHQFZDRk5dmT9w/Koon67wLvfuxV/IXhU5yp9xfqE8WtZVBwJTbTtAm7aM0ePfMY+4txTdZ90naZo/CD8ZNmxTPuN8HA/fYQIFt3DuwzvA2Fbh3Oj/c8WElkxukMVvwYVdz8Yqp1L1YMqDpttS+VPLvxsws+swc9Y/9KHt55vJvTvPW00Iz1vmuZvSAo88Q==",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"}},g={},y=[{value:"Request",id:"request",level:2}];function v(e){const a={h2:"h2",p:"p",...(0,l.a)(),...e.components},{Details:s}=a;return s||function(e,a){throw new Error("Expected "+(a?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,t.jsxs)(t.Fragment,{children:[(0,t.jsx)("h1",{className:"openapi__heading",children:(0,t.jsx)(a.p,{children:"Create document"})}),"\n",(0,t.jsx)(n(),{method:"post",path:"/createdocument"}),"\n",(0,t.jsx)(a.p,{children:"Create document"}),"\n",(0,t.jsx)(a.h2,{id:"request",children:"Request"}),"\n",(0,t.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},children:(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,t.jsx)(a.p,{children:"Header Parameters"})})}),(0,t.jsx)("div",{children:(0,t.jsx)("ul",{children:(0,t.jsx)(c.Z,{className:"paramsItem",param:{name:"x-api-token",in:"header",required:!0,style:"simple",explode:!1,schema:{type:"string"},example:"opensign.xxxx"}})})})]}),"\n",(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",children:(0,t.jsx)(h.default,{label:"multipart/form-data",value:"multipart/form-data-schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details mime","data-collapsed":!1,open:!0,children:[(0,t.jsxs)("summary",{style:{},className:"openapi-markdown__details-summary-mime",children:[(0,t.jsx)("h3",{className:"openapi-markdown__details-summary-header-body",children:(0,t.jsx)(a.p,{children:"Body"})}),(0,t.jsx)("strong",{className:"openapi-schema__required",children:(0,t.jsx)(a.p,{children:"required"})})]}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(m.Z,{collapsible:!1,name:"file",required:!1,schemaName:"binary",qualifierMessage:void 0,schema:{type:"string",format:"binary"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"Name",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"Description",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"Note",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"Signers",required:!1,schemaName:"string[]",qualifierMessage:void 0,schema:{type:"array",items:{type:"string"}}})]})]})})}),"\n",(0,t.jsx)("div",{children:(0,t.jsx)("div",{children:(0,t.jsxs)(i.Z,{children:[(0,t.jsxs)(h.default,{label:"200",value:"200",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Document created successfully!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,t.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"hji2zxcv2P"}}),(0,t.jsx)(m.Z,{collapsible:!1,name:"url",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"https://example.com"}})]})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "objectId": "hji2zxcv2P",\n "url": "https://example.com"\n}',language:"json"})})]})})})})]}),(0,t.jsxs)(h.default,{label:"405",value:"405",children:[(0,t.jsx)("div",{children:(0,t.jsx)(a.p,{children:"Invalid API Token!"})}),(0,t.jsx)("div",{children:(0,t.jsx)(o.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,t.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,t.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,t.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,t.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,t.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,t.jsx)("strong",{children:(0,t.jsx)(a.p,{children:"Schema"})})}),(0,t.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,t.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,t.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,t.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,t.jsx)(d.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function f(e={}){const{wrapper:a}={...(0,l.a)(),...e.components};return a?(0,t.jsx)(a,{...e,children:(0,t.jsx)(v,{...e})}):v(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink