WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-09-28 04:24:57 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
cd358d2f22caeb790b4eb525910c9803d6de0684
OpenSign/assets/js/78b2b753.f380f604.js
T

1 line
12 KiB
JavaScript
Raw Blame History

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2207],{97201:(e,l,s)=>{s.r(l),s.d(l,{assets:()=>f,contentTitle:()=>x,default:()=>b,frontMatter:()=>u,metadata:()=>j,toc:()=>y});var a=s(85893),i=s(11151),t=s(58219),r=(s(62316),s(51039)),n=s.n(r),d=(s(82723),s(9487)),o=s(41429),c=s(5397),p=s(4667),m=s(9472),h=s(85162);const u={id:"deletefolder",title:"Delete Folder",description:"The delete Folder API allows you to delete folder.",sidebar_label:"Delete Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vutu2zYUfpVT/lkLyLbspt0mDMOCNeuyFEuxdCiwxAiOpSOLNUWyJOULDP3bk+zR9iTDkSxfYqdYt2F/Eovn+p3LR65FwKkXya34waiMnBhHIiOfOmmDNFok4l1BkJGiQNCqwPnbS0ClzMLDylQQTCfPG3lfRMJYcsgOLjORiFbcSkUkLDosKZDjuGuhsSSRiFZ8LzMRCcmBLYZCPMzGTD5QGi4zMDlsHTr6WElHmUiCqygSPqwUu/SytIpEJGhplclIJDkqzwppQSWKZC3CyjaawUk9FZHIjSsx7J/QEhsviZhcDdM8GxV2Iup6zGG9NdqTZ0ejOOZ/h9n6Kk3J+7xSsK2IiERqdCAdWB+tVTJtBIMPno3Wx9m1oLlyjt0E2YbsavG5OH6c+dFPlhaXVtTRpjnZeTjlZmc0ikfPe8O4F3/5bvgyOfs6efGyH8fxbyISy1Kx7aaPGQZiv0EGtfveO5BaSU33XfXuR3F8PxyJumals1Nl7G1aDdKDNgGotGEVAZcRpfaQmbQqSQcwrpvBO92DG1NSKKSewoKFC2f0NAKrCD1BcCvAKUoNCgO5J3f/qjFG03XO01xHax6Nx7CexfH98y3Us2OoG6CMMjeVzvr/3biQc8Z97qwc5/OpVp7FZ/dfbeG9OIZ3qeeoZNZQSDAz0k/+B3w7NCfCc6qHAyxbpUYuDsDun7cgPaWVk2HVENmyh1b2WnlyO+Y54AE0OwpsyC8UIhGDtrCD9Zb2asHu3LyjxcopkYgiBOuTwcCjziZm2TeWtJdTrXDi+6kpB2jlYD4UdfTQAq39DG0fcCr1tPdJq/EO8A03pa37Aext9dHKK1qJqKvqvtaG4AtC5m+uo9S5aYw3tb62pG/kVDedmg+ProH3pFJTEt89oSDo1P/8/Y/GoiOEZpCewHXlwJoFOSZi1BnkipZyoujEVeYJS0XeqxVIHWjqMBBkcioDKuCqMJ+kaHEileTRYzXD1g72ptf34X1BoSDHoi8cAUJGc1I8saCMmbGfYACrYMomRkdiC+NmOacUAcKk8lKT9+CJOhPSBeqUoOtFxLyHGkgHctZJT4CyZOXcOKA8l6lkx7xnDtMAJWqcEgeLgPPmKlhn5jIjD85MKh/AG1U1QDhiSRRaiJoo8314JefUAufDjAJKRRlMK3bBzJwRbNaOYegMJuQDWA4vU2qc+oAugKI5uWb2mk7mlVJgDfOBRMW3/H5v2VFwqD1TVptQ15pt+awzfOc2MTJc9eFO32m+CqDyxAOgpJ75hC+I2+2YvaeJl4HGT7t9WCwWR3vw7NDmtQxFNQFH1uzsps1hszX75tuPZyISgVzpr/MbcnOZ0mYJH4k5aJQHG5bEtGFJKlGqdse+e2jAjKVkStrTHqedv377BubwvB+LaG/z/0bCgzeX31/8fHPBfpmb2v0b9uN+zEfW+FCi3gv1av+t+HBx1zuy/2cPyw27BFqGgVUoG4ZuAK031Hortu/CZPemHEeiMD6weL2eoKdfnaprPv5YkWP+Hkdijk7ihAnodi0y6fl3tn00Pgrk6S+b9+czOPk8PZlzR5OaOXKOquIvEYkZrQ4ew/W4jjqm5LRa+Xmakg17lkcX58Ht8+rizcW7CxEJrLhE+yQ9a0h684MDnEzskL3bHPgvXyQnDb7hXl7R6tuteit51GADsdPmIo3ruv4L549hyA==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},x=void 0,j={id:"API-docs/deletefolder",title:"Delete Folder",description:"The delete Folder API allows you to delete folder.",source:"@site/docs/API-docs/deletefolder.api.mdx",sourceDirName:"API-docs",slug:"/API-docs/deletefolder",permalink:"/docs/API-docs/deletefolder",draft:!1,unlisted:!1,editUrl:null,tags:[],version:"current",frontMatter:{id:"deletefolder",title:"Delete Folder",description:"The delete Folder API allows you to delete folder.",sidebar_label:"Delete Folder",hide_title:!0,hide_table_of_contents:!0,api:"eJy9Vutu2zYUfpVT/lkLyLbspt0mDMOCNeuyFEuxdCiwxAiOpSOLNUWyJOULDP3bk+zR9iTDkSxfYqdYt2F/Eovn+p3LR65FwKkXya34waiMnBhHIiOfOmmDNFok4l1BkJGiQNCqwPnbS0ClzMLDylQQTCfPG3lfRMJYcsgOLjORiFbcSkUkLDosKZDjuGuhsSSRiFZ8LzMRCcmBLYZCPMzGTD5QGi4zMDlsHTr6WElHmUiCqygSPqwUu/SytIpEJGhplclIJDkqzwppQSWKZC3CyjaawUk9FZHIjSsx7J/QEhsviZhcDdM8GxV2Iup6zGG9NdqTZ0ejOOZ/h9n6Kk3J+7xSsK2IiERqdCAdWB+tVTJtBIMPno3Wx9m1oLlyjt0E2YbsavG5OH6c+dFPlhaXVtTRpjnZeTjlZmc0ikfPe8O4F3/5bvgyOfs6efGyH8fxbyISy1Kx7aaPGQZiv0EGtfveO5BaSU33XfXuR3F8PxyJumals1Nl7G1aDdKDNgGotGEVAZcRpfaQmbQqSQcwrpvBO92DG1NSKKSewoKFC2f0NAKrCD1BcCvAKUoNCgO5J3f/qjFG03XO01xHax6Nx7CexfH98y3Us2OoG6CMMjeVzvr/3biQc8Z97qwc5/OpVp7FZ/dfbeG9OIZ3qeeoZNZQSDAz0k/+B3w7NCfCc6qHAyxbpUYuDsDun7cgPaWVk2HVENmyh1b2WnlyO+Y54AE0OwpsyC8UIhGDtrCD9Zb2asHu3LyjxcopkYgiBOuTwcCjziZm2TeWtJdTrXDi+6kpB2jlYD4UdfTQAq39DG0fcCr1tPdJq/EO8A03pa37Aext9dHKK1qJqKvqvtaG4AtC5m+uo9S5aYw3tb62pG/kVDedmg+ProH3pFJTEt89oSDo1P/8/Y/GoiOEZpCewHXlwJoFOSZi1BnkipZyoujEVeYJS0XeqxVIHWjqMBBkcioDKuCqMJ+kaHEileTRYzXD1g72ptf34X1BoSDHoi8cAUJGc1I8saCMmbGfYACrYMomRkdiC+NmOacUAcKk8lKT9+CJOhPSBeqUoOtFxLyHGkgHctZJT4CyZOXcOKA8l6lkx7xnDtMAJWqcEgeLgPPmKlhn5jIjD85MKh/AG1U1QDhiSRRaiJoo8314JefUAufDjAJKRRlMK3bBzJwRbNaOYegMJuQDWA4vU2qc+oAugKI5uWb2mk7mlVJgDfOBRMW3/H5v2VFwqD1TVptQ15pt+awzfOc2MTJc9eFO32m+CqDyxAOgpJ75hC+I2+2YvaeJl4HGT7t9WCwWR3vw7NDmtQxFNQFH1uzsps1hszX75tuPZyISgVzpr/MbcnOZ0mYJH4k5aJQHG5bEtGFJKlGqdse+e2jAjKVkStrTHqedv377BubwvB+LaG/z/0bCgzeX31/8fHPBfpmb2v0b9uN+zEfW+FCi3gv1av+t+HBx1zuy/2cPyw27BFqGgVUoG4ZuAK031Hortu/CZPemHEeiMD6weL2eoKdfnaprPv5YkWP+Hkdijk7ihAnodi0y6fl3tn00Pgrk6S+b9+czOPk8PZlzR5OaOXKOquIvEYkZrQ4ew/W4jjqm5LRa+Xmakg17lkcX58Ht8+rizcW7CxEJrLhE+yQ9a0h684MDnEzskL3bHPgvXyQnDb7hXl7R6tuteit51GADsdPmIo3ruv4L549hyA==",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},sidebar:"apiSidebar",previous:{title:"Update Folder",permalink:"/docs/API-docs/updatefolder"},next:{title:"Get folder list",permalink:"/docs/API-docs/folderlist"}},f={},y=[{value:"Request",id:"request",level:2}];function g(e){const l={h2:"h2",li:"li",p:"p",ul:"ul",...(0,i.a)(),...e.components},{Details:s}=l;return s||function(e,l){throw new Error("Expected "+(l?"component":"object")+" `"+e+"` to be defined: you likely forgot to import, pass, or provide it.")}("Details",!0),(0,a.jsxs)(a.Fragment,{children:[(0,a.jsx)("h1",{className:"openapi__heading",children:(0,a.jsx)(l.p,{children:"Delete Folder"})}),"\n",(0,a.jsx)(n(),{method:"delete",path:"/folder/{folder_id}"}),"\n",(0,a.jsx)(l.p,{children:"The delete Folder API allows you to delete folder."}),"\n",(0,a.jsx)(l.h2,{id:"request",children:"Request"}),"\n",(0,a.jsxs)(s,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},children:(0,a.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,a.jsx)(l.p,{children:"Path Parameters"})})}),(0,a.jsx)("div",{children:(0,a.jsx)("ul",{children:(0,a.jsx)(o.Z,{className:"paramsItem",param:{name:"folder_id",in:"path",description:"objectId of folder",required:!0,style:"simple",explode:!1,schema:{type:"string",format:"string",example:"bK1cfd2hpb"}}})})})]}),"\n",(0,a.jsx)("div",{children:(0,a.jsx)("div",{children:(0,a.jsxs)(t.Z,{children:[(0,a.jsxs)(h.default,{label:"200",value:"200",children:[(0,a.jsx)("div",{children:(0,a.jsx)(l.p,{children:"successful operation"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(l.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,a.jsx)(p.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Hks2JpewIp"}}),(0,a.jsx)(p.Z,{collapsible:!1,name:"deletedAt",required:!1,schemaName:"date",qualifierMessage:void 0,schema:{type:"string",example:"2023-10-07T16:49:56.000Z",xml:{name:"date"},title:"date"}})]})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(c.Z,{responseExample:'{\n "objectId": "Hks2JpewIp",\n "deletedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"400",value:"400",children:[(0,a.jsx)("div",{children:(0,a.jsxs)(l.ul,{children:["\n",(0,a.jsxs)(l.li,{children:["\n",(0,a.jsx)(l.p,{children:"folder is not empty, contains document or folder."}),"\n"]}),"\n",(0,a.jsxs)(l.li,{children:["\n",(0,a.jsx)(l.p,{children:"Something went wrong, please try again later!"}),"\n"]}),"\n"]})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsx)(m.default,{className:"openapi-tabs__schema",children:(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(l.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsxs)("div",{children:[(0,a.jsx)("span",{className:"badge badge--info",children:(0,a.jsx)(l.p,{children:"oneOf"})}),(0,a.jsxs)(m.default,{children:[(0,a.jsx)(h.default,{label:"MOD1",value:"0-item-properties",children:(0,a.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"folder is not empty, contains document or folder."}})}),(0,a.jsx)(h.default,{label:"MOD2",value:"1-item-properties",children:(0,a.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})]})})]})})})})})})]}),(0,a.jsxs)(h.default,{label:"404",value:"404",children:[(0,a.jsx)("div",{children:(0,a.jsx)(l.p,{children:"folder not found."})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(l.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder not found."}})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(c.Z,{responseExample:'{\n "error": "folder not found."\n}',language:"json"})})]})})})})]}),(0,a.jsxs)(h.default,{label:"405",value:"405",children:[(0,a.jsx)("div",{children:(0,a.jsx)(l.p,{children:"Invalid API token!"})}),(0,a.jsx)("div",{children:(0,a.jsx)(d.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,a.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,a.jsxs)(m.default,{className:"openapi-tabs__schema",children:[(0,a.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,a.jsxs)(s,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,a.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,a.jsx)("strong",{children:(0,a.jsx)(l.p,{children:"Schema"})})}),(0,a.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,a.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,a.jsx)(p.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,a.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,a.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function b(e={}){const{wrapper:l}={...(0,i.a)(),...e.components};return l?(0,a.jsx)(l,{...e,children:(0,a.jsx)(g,{...e})}):g(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink