File tree Expand file tree Collapse file tree
Expand file tree Collapse file tree Original file line number Diff line number Diff line change 1111 "name" : " MIT" ,
1212 "url" : " https://raw.githubusercontent.com/docbox-nz/docbox/refs/heads/main/LICENSE.md"
1313 },
14- "version" : " 0.7 .0"
14+ "version" : " 0.8 .0"
1515 },
1616 "paths" : {
1717 "/admin/boxes" : {
27592759 }
27602760 }
27612761 },
2762+ "/box/{scope}/folder/{folder_id}/zip" : {
2763+ "post" : {
2764+ "tags" : [
2765+ " Folder"
2766+ ],
2767+ "summary" : " Create a folder ZIP" ,
2768+ "description" : " Create a ZIP file from the contents of a folder" ,
2769+ "operationId" : " folder_create_zip" ,
2770+ "parameters" : [
2771+ {
2772+ "name" : " scope" ,
2773+ "in" : " path" ,
2774+ "description" : " Scope the folder resides within" ,
2775+ "required" : true ,
2776+ "schema" : {
2777+ "$ref" : " #/components/schemas/DocumentBoxScope"
2778+ }
2779+ },
2780+ {
2781+ "name" : " folder_id" ,
2782+ "in" : " path" ,
2783+ "description" : " ID of the folder to delete" ,
2784+ "required" : true ,
2785+ "schema" : {
2786+ "type" : " string" ,
2787+ "format" : " uuid"
2788+ }
2789+ },
2790+ {
2791+ "name" : " x-tenant-id" ,
2792+ "in" : " header" ,
2793+ "description" : " ID of the tenant you are targeting" ,
2794+ "required" : true ,
2795+ "schema" : {
2796+ "type" : " string"
2797+ }
2798+ },
2799+ {
2800+ "name" : " x-tenant-env" ,
2801+ "in" : " header" ,
2802+ "description" : " Environment of the tenant you are targeting" ,
2803+ "required" : true ,
2804+ "schema" : {
2805+ "type" : " string"
2806+ }
2807+ }
2808+ ],
2809+ "requestBody" : {
2810+ "content" : {
2811+ "application/json" : {
2812+ "schema" : {
2813+ "$ref" : " #/components/schemas/ZipFolderRequest"
2814+ }
2815+ }
2816+ },
2817+ "required" : true
2818+ },
2819+ "responses" : {
2820+ "204" : {
2821+ "description" : " Deleted folder successfully"
2822+ },
2823+ "404" : {
2824+ "description" : " Folder not found" ,
2825+ "content" : {
2826+ "application/json" : {
2827+ "schema" : {
2828+ "$ref" : " #/components/schemas/HttpErrorResponse"
2829+ }
2830+ }
2831+ }
2832+ },
2833+ "500" : {
2834+ "description" : " Internal server error" ,
2835+ "content" : {
2836+ "application/json" : {
2837+ "schema" : {
2838+ "$ref" : " #/components/schemas/HttpErrorResponse"
2839+ }
2840+ }
2841+ }
2842+ }
2843+ }
2844+ }
2845+ },
27622846 "/box/{scope}/link" : {
27632847 "post" : {
27642848 "tags" : [
56755759 }
56765760 }
56775761 ]
5762+ },
5763+ "ZipFolderRequest" : {
5764+ "type" : " object" ,
5765+ "description" : " Request to create a zip file of folder contents" ,
5766+ "properties" : {
5767+ "exclude_files" : {
5768+ "type" : [
5769+ " array" ,
5770+ " null"
5771+ ],
5772+ "items" : {
5773+ "type" : " string" ,
5774+ "format" : " uuid"
5775+ },
5776+ "description" : " Optionally exclude the specified files including\n all other files"
5777+ },
5778+ "include_files" : {
5779+ "type" : [
5780+ " array" ,
5781+ " null"
5782+ ],
5783+ "items" : {
5784+ "type" : " string" ,
5785+ "format" : " uuid"
5786+ },
5787+ "description" : " Optionally only include the specified files"
5788+ }
5789+ }
56785790 }
56795791 }
56805792 },
You can’t perform that action at this time.
0 commit comments