1 changed files with 91 additions and 5 deletions
+ 91
- 5
openapi.json
View File
| "name": "Create", | "name": "Create", | ||||
| "description": "Create new documents/pages" | "description": "Create new documents/pages" | ||||
| }, | }, | ||||
| { | |||||
| "name": "Upload", | |||||
| "description": "Upload new documents" | |||||
| }, | |||||
| { | { | ||||
| "name": "Images", | "name": "Images", | ||||
| "description": "Get documents/pages images/thumbnails" | "description": "Get documents/pages images/thumbnails" | ||||
| }, | }, | ||||
| { | |||||
| "name": "Objects", | |||||
| "description": "Retrieve a document/page meta data" | |||||
| }, | |||||
| { | { | ||||
| "name": "Tags", | "name": "Tags", | ||||
| "description": "Manipulate tags" | "description": "Manipulate tags" | ||||
| "fr" | "fr" | ||||
| ] | ] | ||||
| } | } | ||||
| }, | |||||
| "tags": { | |||||
| "readOnly": true, | |||||
| "description": "List of all tags", | |||||
| "type": "array", | |||||
| "items": { | |||||
| "type": "string" | |||||
| } | |||||
| } | } | ||||
| } | } | ||||
| }, | }, | ||||
| "/documents": { | "/documents": { | ||||
| "post": { | "post": { | ||||
| "summary": "Create a new document", | "summary": "Create a new document", | ||||
| "tags": [ | |||||
| "Create" | |||||
| ], | |||||
| "responses": { | "responses": { | ||||
| "200": { | "200": { | ||||
| "description": "OK", | "description": "OK", | ||||
| }, | }, | ||||
| "get": { | "get": { | ||||
| "summary": "Returns a list of documents", | "summary": "Returns a list of documents", | ||||
| "tags": [ | |||||
| "Objects" | |||||
| ], | |||||
| "parameters": [ | "parameters": [ | ||||
| { | { | ||||
| "in": "query", | "in": "query", | ||||
| } | } | ||||
| }, | }, | ||||
| "/documents/{documentId}": { | "/documents/{documentId}": { | ||||
| "patch": { | |||||
| "summary": "Manipulate document tags", | |||||
| "tags": [ | |||||
| "Tags" | |||||
| ], | |||||
| "parameters": [ | |||||
| { | |||||
| "in": "path", | |||||
| "name": "documentId", | |||||
| "required": true, | |||||
| "schema": { | |||||
| "type": "integer", | |||||
| "minimum": 0, | |||||
| "maximum": 18446744073709551615 | |||||
| } | |||||
| }, | |||||
| { | |||||
| "in": "query", | |||||
| "name": "addTags", | |||||
| "required": false, | |||||
| "schema": { | |||||
| "type": "array", | |||||
| "maxItems": 64, | |||||
| "items": { | |||||
| "type": "string", | |||||
| "minLength": 1, | |||||
| "maxLength": 64 | |||||
| } | |||||
| } | |||||
| }, | |||||
| { | |||||
| "in": "query", | |||||
| "name": "deleteTags", | |||||
| "required": false, | |||||
| "schema": { | |||||
| "type": "array", | |||||
| "maxItems": 64, | |||||
| "items": { | |||||
| "type": "string", | |||||
| "minLength": 1, | |||||
| "maxLength": 64 | |||||
| } | |||||
| } | |||||
| } | |||||
| ], | |||||
| "responses": { | |||||
| "200": { | |||||
| "description": "OK" | |||||
| } | |||||
| } | |||||
| }, | |||||
| "get": { | "get": { | ||||
| "summary": "retrieve a document meta data", | "summary": "retrieve a document meta data", | ||||
| "tags": [ | |||||
| "Objects" | |||||
| ], | |||||
| "parameters": [ | "parameters": [ | ||||
| { | { | ||||
| "in": "path", | "in": "path", | ||||
| "/documents/{documentId}/image": { | "/documents/{documentId}/image": { | ||||
| "get": { | "get": { | ||||
| "summary": "Get an image or thumbnail of the document", | "summary": "Get an image or thumbnail of the document", | ||||
| "tags": [ | |||||
| "Images" | |||||
| ], | |||||
| "parameters": [ | "parameters": [ | ||||
| { | { | ||||
| "in": "query", | "in": "query", | ||||
| "/documents/{documentId}/data": { | "/documents/{documentId}/data": { | ||||
| "post": { | "post": { | ||||
| "summary": "Add one (or multiple if PDF) page to the document", | "summary": "Add one (or multiple if PDF) page to the document", | ||||
| "tags": [ | |||||
| "Create" | |||||
| ], | |||||
| "requestBody": { | "requestBody": { | ||||
| "content": { | "content": { | ||||
| "image/*": { | |||||
| "image/png": { | |||||
| "schema": { | |||||
| "type": "string", | |||||
| "format": "binary" | |||||
| } | |||||
| }, | |||||
| "image/jpeg": { | |||||
| "schema": { | "schema": { | ||||
| "type": "string", | "type": "string", | ||||
| "format": "binary" | "format": "binary" | ||||
| "/pages/{pageId}": { | "/pages/{pageId}": { | ||||
| "get": { | "get": { | ||||
| "summary": "Get page properties", | "summary": "Get page properties", | ||||
| "tags": [ | |||||
| "Objects" | |||||
| ], | |||||
| "parameters": [ | "parameters": [ | ||||
| { | { | ||||
| "in": "path", | "in": "path", | ||||
| "/pages/{pageId}/image": { | "/pages/{pageId}/image": { | ||||
| "get": { | "get": { | ||||
| "summary": "get an image or thumbnail of the page", | "summary": "get an image or thumbnail of the page", | ||||
| "tags": [ | |||||
| "Images" | |||||
| ], | |||||
| "parameters": [ | "parameters": [ | ||||
| { | { | ||||
| "in": "query", | "in": "query", |
Loading…