| @@ -16,14 +16,14 @@ | |||
| "name": "Create", | |||
| "description": "Create new documents/pages" | |||
| }, | |||
| { | |||
| "name": "Upload", | |||
| "description": "Upload new documents" | |||
| }, | |||
| { | |||
| "name": "Images", | |||
| "description": "Get documents/pages images/thumbnails" | |||
| }, | |||
| { | |||
| "name": "Objects", | |||
| "description": "Retrieve a document/page meta data" | |||
| }, | |||
| { | |||
| "name": "Tags", | |||
| "description": "Manipulate tags" | |||
| @@ -88,6 +88,14 @@ | |||
| "fr" | |||
| ] | |||
| } | |||
| }, | |||
| "tags": { | |||
| "readOnly": true, | |||
| "description": "List of all tags", | |||
| "type": "array", | |||
| "items": { | |||
| "type": "string" | |||
| } | |||
| } | |||
| } | |||
| }, | |||
| @@ -172,6 +180,9 @@ | |||
| "/documents": { | |||
| "post": { | |||
| "summary": "Create a new document", | |||
| "tags": [ | |||
| "Create" | |||
| ], | |||
| "responses": { | |||
| "200": { | |||
| "description": "OK", | |||
| @@ -187,6 +198,9 @@ | |||
| }, | |||
| "get": { | |||
| "summary": "Returns a list of documents", | |||
| "tags": [ | |||
| "Objects" | |||
| ], | |||
| "parameters": [ | |||
| { | |||
| "in": "query", | |||
| @@ -263,8 +277,62 @@ | |||
| } | |||
| }, | |||
| "/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": { | |||
| "summary": "retrieve a document meta data", | |||
| "tags": [ | |||
| "Objects" | |||
| ], | |||
| "parameters": [ | |||
| { | |||
| "in": "path", | |||
| @@ -297,6 +365,9 @@ | |||
| "/documents/{documentId}/image": { | |||
| "get": { | |||
| "summary": "Get an image or thumbnail of the document", | |||
| "tags": [ | |||
| "Images" | |||
| ], | |||
| "parameters": [ | |||
| { | |||
| "in": "query", | |||
| @@ -335,9 +406,18 @@ | |||
| "/documents/{documentId}/data": { | |||
| "post": { | |||
| "summary": "Add one (or multiple if PDF) page to the document", | |||
| "tags": [ | |||
| "Create" | |||
| ], | |||
| "requestBody": { | |||
| "content": { | |||
| "image/*": { | |||
| "image/png": { | |||
| "schema": { | |||
| "type": "string", | |||
| "format": "binary" | |||
| } | |||
| }, | |||
| "image/jpeg": { | |||
| "schema": { | |||
| "type": "string", | |||
| "format": "binary" | |||
| @@ -361,6 +441,9 @@ | |||
| "/pages/{pageId}": { | |||
| "get": { | |||
| "summary": "Get page properties", | |||
| "tags": [ | |||
| "Objects" | |||
| ], | |||
| "parameters": [ | |||
| { | |||
| "in": "path", | |||
| @@ -390,6 +473,9 @@ | |||
| "/pages/{pageId}/image": { | |||
| "get": { | |||
| "summary": "get an image or thumbnail of the page", | |||
| "tags": [ | |||
| "Images" | |||
| ], | |||
| "parameters": [ | |||
| { | |||
| "in": "query", | |||