WEBDIENSTE/OpenSign
1
0
Fork 0
mirror of https://github.com/OpenSignLabs/OpenSign.git synced 2026-10-01 14:04:59 +02:00
Code Issues Packages Projects Releases Wiki Activity
Files
a899018e4d4c87cd5e5590dbbdf3c5d60e72b0ae
OpenSign/assets/js/78b2b753.12b39d5b.js
T

1 line
11 KiB
JavaScript
Raw Blame History

"use strict";(self.webpackChunkOpenSign_Docs=self.webpackChunkOpenSign_Docs||[]).push([[2207],{97201:(e,l,a)=>{a.r(l),a.d(l,{assets:()=>j,contentTitle:()=>u,default:()=>g,frontMatter:()=>x,metadata:()=>f,toc:()=>y});var s=a(85893),r=a(11151),i=a(58219),n=(a(62316),a(51039)),d=a.n(n),t=(a(82723),a(9487)),o=a(41429),c=a(5397),m=a(4667),p=a(9472),h=a(85162);const x={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:"eJy9Vm1v2zYQ/ivsfWoA2ZIdt9uEYViwZp2bYCmWDAOWGAYtnSw2FMmSlB3D0H8fTi+2HDvFug37kli8F97z3HMHbsHzpYP4Hn7WMkULswBSdIkVxgutIIa7HFmKEj2yxoVdfJwyLqVeO7bRJfO6s2e1fQgBaIOWU4JpCjE05sYKARhueYEeLd27BcULhBga81ykEICgiw33OTyvRi8+YeKnKdMZ2yW0+LkUFlOIvS0xAOc3klI6URiJEAA+GalThDjj0pFDkmPBId6C35ja01uhlhBApm3Bff8En3idJYbF1SjJ0nFuFlBVM7rWGa0cOko0jiL6d1itK5MEnctKyXaMQACJVh6VJ39ujBRJbQg/OQraHlfXgCbmLKXxormy4+Jrcfzy6MYfDK6nBqqgbU564U+l2QeNo/H5YBQNom/uRm/jyXfxm7fDKIr+hACeCkmxbR9T7pHyeuHl/rt3IJQUCucde/NxFM1HY6gqcpqconHQtpoJx5T2DAvjNwEjGrlQjqU6KQtUnmnbafBBDditLtDnQi3Zmoxrq9UyYEYid8i83TC+5EIxyT3aVw//qjFa4U1Gaq6CLUnjJayTKJqf76BOjqG2QAllpkuVDv87uaC12n6tVo7r+VIrJ9Fk/u0O3ptjeFO14lKk9Qrx+hHVq/8B3x7Nieup1EMBi8aptsMB2P55A9JhUlrhN/UiexpwIwaNPb6fkQ5IgHq/Auvl53OIIWyIDbe7tVcBpbOrbi2WVkIMuffGxWHIjRlqg8qJpZJ84YaJLkJuRLgaQRU893aeL4VaDr4YNduXf0sUNywegNhxyY24wg0EHUd9r3Zd58hpGxMrQmW6Dm6ZuzGobsVS1byvRkdL/S4XjmabzN0s1xpgmbbsWTRbcIcp04r5HGsjnZ8PR8wZTETWymfIHtSDohXASoe0gaVQjy6mxXB/k2UiEVyyP3DhhMfZ64659Xp9xNhZHfNe+LxcMItG792X9WFNaz9q93EGAXi0hbvJbtGuRIJtl164Kqydw3YoeFIPBRZcUHfbox+fB5FIpUhQOezJ+OL9x2u2YufDCIKePP5G0eH19KfLX28vKS/JsWnSaBgNIzoy2vmCq95V7/rPg+fd3e7n+5+9JVoJenzyoZFc1ENZA9q203QPu6dAvH9GzALItfNk3m5JNL9bWVV0/LlESyM7C2DFreALUun9FlLh6He6eye8COT1b+2T44ydfJGcrLmbJUWDtOKypC8I4BE3B++falYF3ThRWY39IknQ+F7k0a48WDjvLq8v7y4hAF4SRf1Jfqwnuf1BF5ws7HDEmxroL22bkwHfUy+vcPPDzr2xvBjQQuy8iaRZVVV/AenPm1U=",sidebar_class_name:"delete api-method",info_path:"docs/API-docs/opensign-api-v-1",custom_edit_url:null},u=void 0,f={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:"eJy9Vm1v2zYQ/ivsfWoA2ZIdt9uEYViwZp2bYCmWDAOWGAYtnSw2FMmSlB3D0H8fTi+2HDvFug37kli8F97z3HMHbsHzpYP4Hn7WMkULswBSdIkVxgutIIa7HFmKEj2yxoVdfJwyLqVeO7bRJfO6s2e1fQgBaIOWU4JpCjE05sYKARhueYEeLd27BcULhBga81ykEICgiw33OTyvRi8+YeKnKdMZ2yW0+LkUFlOIvS0xAOc3klI6URiJEAA+GalThDjj0pFDkmPBId6C35ja01uhlhBApm3Bff8En3idJYbF1SjJ0nFuFlBVM7rWGa0cOko0jiL6d1itK5MEnctKyXaMQACJVh6VJ39ujBRJbQg/OQraHlfXgCbmLKXxormy4+Jrcfzy6MYfDK6nBqqgbU564U+l2QeNo/H5YBQNom/uRm/jyXfxm7fDKIr+hACeCkmxbR9T7pHyeuHl/rt3IJQUCucde/NxFM1HY6gqcpqconHQtpoJx5T2DAvjNwEjGrlQjqU6KQtUnmnbafBBDditLtDnQi3Zmoxrq9UyYEYid8i83TC+5EIxyT3aVw//qjFa4U1Gaq6CLUnjJayTKJqf76BOjqG2QAllpkuVDv87uaC12n6tVo7r+VIrJ9Fk/u0O3ptjeFO14lKk9Qrx+hHVq/8B3x7Nieup1EMBi8aptsMB2P55A9JhUlrhN/UiexpwIwaNPb6fkQ5IgHq/Auvl53OIIWyIDbe7tVcBpbOrbi2WVkIMuffGxWHIjRlqg8qJpZJ84YaJLkJuRLgaQRU893aeL4VaDr4YNduXf0sUNywegNhxyY24wg0EHUd9r3Zd58hpGxMrQmW6Dm6ZuzGobsVS1byvRkdL/S4XjmabzN0s1xpgmbbsWTRbcIcp04r5HGsjnZ8PR8wZTETWymfIHtSDohXASoe0gaVQjy6mxXB/k2UiEVyyP3DhhMfZ64659Xp9xNhZHfNe+LxcMItG792X9WFNaz9q93EGAXi0hbvJbtGuRIJtl164Kqydw3YoeFIPBRZcUHfbox+fB5FIpUhQOezJ+OL9x2u2YufDCIKePP5G0eH19KfLX28vKS/JsWnSaBgNIzoy2vmCq95V7/rPg+fd3e7n+5+9JVoJenzyoZFc1ENZA9q203QPu6dAvH9GzALItfNk3m5JNL9bWVV0/LlESyM7C2DFreALUun9FlLh6He6eye8COT1b+2T44ydfJGcrLmbJUWDtOKypC8I4BE3B++falYF3ThRWY39IknQ+F7k0a48WDjvLq8v7y4hAF4SRf1Jfqwnuf1BF5ws7HDEmxroL22bkwHfUy+vcPPDzr2xvBjQQuy8iaRZVVV/AenPm1U=",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"}},j={},y=[{value:"Request",id:"request",level:2}];function b(e){const l={h2:"h2",li:"li",p:"p",ul:"ul",...(0,r.a)(),...e.components},{Details:a}=l;return a||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,s.jsxs)(s.Fragment,{children:[(0,s.jsx)("h1",{className:"openapi__heading",children:(0,s.jsx)(l.p,{children:"Delete Folder"})}),"\n",(0,s.jsx)(d(),{method:"delete",path:"/folder/{folder_id}"}),"\n",(0,s.jsx)(l.p,{children:"The delete Folder API allows you to delete folder."}),"\n",(0,s.jsx)(l.h2,{id:"request",children:"Request"}),"\n",(0,s.jsxs)(a,{style:{marginBottom:"1rem"},className:"openapi-markdown__details","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},children:(0,s.jsx)("h3",{className:"openapi-markdown__details-summary-header-params",children:(0,s.jsx)(l.p,{children:"Path Parameters"})})}),(0,s.jsx)("div",{children:(0,s.jsx)("ul",{children:(0,s.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,s.jsx)("div",{children:(0,s.jsx)("div",{children:(0,s.jsxs)(i.Z,{children:[(0,s.jsxs)(h.default,{label:"200",value:"200",children:[(0,s.jsx)("div",{children:(0,s.jsx)(l.p,{children:"successful operation"})}),(0,s.jsx)("div",{children:(0,s.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,s.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,s.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,s.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,s.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,s.jsx)("strong",{children:(0,s.jsx)(l.p,{children:"Schema"})})}),(0,s.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,s.jsxs)("ul",{style:{marginLeft:"1rem"},children:[(0,s.jsx)(m.Z,{collapsible:!1,name:"objectId",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"Hks2JpewIp"}}),(0,s.jsx)(m.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,s.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,s.jsx)(c.Z,{responseExample:'{\n "objectId": "Hks2JpewIp",\n "deletedAt": "2023-10-07T16:49:56.000Z"\n}',language:"json"})})]})})})})]}),(0,s.jsxs)(h.default,{label:"400",value:"400",children:[(0,s.jsx)("div",{children:(0,s.jsxs)(l.ul,{children:["\n",(0,s.jsxs)(l.li,{children:["\n",(0,s.jsx)(l.p,{children:"folder is not empty, contains document or folder."}),"\n"]}),"\n",(0,s.jsxs)(l.li,{children:["\n",(0,s.jsx)(l.p,{children:"Something went wrong, please try again later!"}),"\n"]}),"\n"]})}),(0,s.jsx)("div",{children:(0,s.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,s.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,s.jsx)(p.default,{className:"openapi-tabs__schema",children:(0,s.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,s.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,s.jsx)("strong",{children:(0,s.jsx)(l.p,{children:"Schema"})})}),(0,s.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,s.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,s.jsxs)("div",{children:[(0,s.jsx)("span",{className:"badge badge--info",children:(0,s.jsx)(l.p,{children:"oneOf"})}),(0,s.jsxs)(p.default,{children:[(0,s.jsx)(h.default,{label:"MOD1",value:"0-item-properties",children:(0,s.jsx)(m.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,s.jsx)(h.default,{label:"MOD2",value:"1-item-properties",children:(0,s.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Something went wrong, please try again later!"}})})]})]})})]})})})})})})]}),(0,s.jsxs)(h.default,{label:"404",value:"404",children:[(0,s.jsx)("div",{children:(0,s.jsx)(l.p,{children:"folder not found."})}),(0,s.jsx)("div",{children:(0,s.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,s.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,s.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,s.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,s.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,s.jsx)("strong",{children:(0,s.jsx)(l.p,{children:"Schema"})})}),(0,s.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,s.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,s.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",format:"string",example:"folder not found."}})})]})}),(0,s.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,s.jsx)(c.Z,{responseExample:'{\n "error": "folder not found."\n}',language:"json"})})]})})})})]}),(0,s.jsxs)(h.default,{label:"405",value:"405",children:[(0,s.jsx)("div",{children:(0,s.jsx)(l.p,{children:"Invalid API token!"})}),(0,s.jsx)("div",{children:(0,s.jsx)(t.Z,{className:"openapi-tabs__mime",schemaType:"response",children:(0,s.jsx)(h.default,{label:"application/json",value:"application/json",children:(0,s.jsxs)(p.default,{className:"openapi-tabs__schema",children:[(0,s.jsx)(h.default,{label:"Schema",value:"Schema",children:(0,s.jsxs)(a,{style:{},className:"openapi-markdown__details response","data-collapsed":!1,open:!0,children:[(0,s.jsx)("summary",{style:{},className:"openapi-markdown__details-summary-response",children:(0,s.jsx)("strong",{children:(0,s.jsx)(l.p,{children:"Schema"})})}),(0,s.jsx)("div",{style:{textAlign:"left",marginLeft:"1rem"}}),(0,s.jsx)("ul",{style:{marginLeft:"1rem"},children:(0,s.jsx)(m.Z,{collapsible:!1,name:"error",required:!1,schemaName:"string",qualifierMessage:void 0,schema:{type:"string",example:"Invalid API token!"}})})]})}),(0,s.jsx)(h.default,{label:"Example (from schema)",value:"Example (from schema)",children:(0,s.jsx)(c.Z,{responseExample:'{\n "error": "Invalid API token!"\n}',language:"json"})})]})})})})]})]})})})]})}function g(e={}){const{wrapper:l}={...(0,r.a)(),...e.components};return l?(0,s.jsx)(l,{...e,children:(0,s.jsx)(b,{...e})}):b(e)}}}]);
Reference in New Issue View Git Blame Copy Permalink