From 58a3d042bab4eb089dd9b9f605c12981a5a94e33 Mon Sep 17 00:00:00 2001 From: dHENRY Date: Sat, 4 Jun 2022 20:30:25 +0200 Subject: [PATCH] typo --- server/openapi.yaml | 166 +++++++++++++++++++++++++++----------------- 1 file changed, 102 insertions(+), 64 deletions(-) diff --git a/server/openapi.yaml b/server/openapi.yaml index a91bd6a..8a16338 100644 --- a/server/openapi.yaml +++ b/server/openapi.yaml @@ -4,17 +4,17 @@ info: description: "Nodejs API server for https://mydraft.cc - UI" title: "Mydraft Nodejs server" contact: - website: www.mytinydc.com + url: www.mytinydc.com license: name: "MIT Licence" url: "https://mit-license.org/" tags: -- name: "manage" - description: "Load/Save draft" + - name: "manage" + description: "Load/Save draft" servers: - - url: 'http://localhost:4000' + - url: "http://localhost:4000" components: schemas: @@ -31,8 +31,8 @@ components: properties: error: type: string - - diagrammestructure: + + diagramstructure: type: array items: type: object @@ -48,120 +48,158 @@ paths: content: application/json: schema: - $ref: '#/components/schemas/diagrammestructure' + $ref: "#/components/schemas/diagramstructure" examples: JsonOK: - value: [{"type":"diagram/add","payload":{"diagramId":"f9e48fc9-da3d-aa39-1ab5-0641b0a0f59a","timestamp":1654256184083}},{"type":"items/addVisual","payload":{"diagramId":"f9e48fc9-da3d-aa39-1ab5-0641b0a0f59a","timestamp":1654256186400,"shapeId":"82170ec5-2cc5-c0f2-1414-38e8e477dd01","renderer":"Button","position":{"x":199.5,"y":119.30000305175781}}}] - badFormat: - value: 'This is not JSON format' + value: + [ + { + "type": "diagram/add", + "payload": + { + "diagramId": "f9e48fc9-da3d-aa39-1ab5-0641b0a0f59a", + "timestamp": 1654256184083, + }, + }, + { + "type": "items/addVisual", + "payload": + { + "diagramId": "f9e48fc9-da3d-aa39-1ab5-0641b0a0f59a", + "timestamp": 1654256186400, + "shapeId": "82170ec5-2cc5-c0f2-1414-38e8e477dd01", + "renderer": "Button", + "position": { "x": 199.5, "y": 119.30000305175781 }, + }, + }, + ] + badFormat: + value: "This is not JSON format" responses: "200": description: "successful operation" content: application/json: schema: - $ref: '#/components/schemas/serverresponsestore' + $ref: "#/components/schemas/serverresponsestore" "500": description: "Server Internal ERROR" content: application/json: schema: - $ref: '#/components/schemas/internalerror' - security: [] # no authentication + $ref: "#/components/schemas/internalerror" + security: [] # no authentication /{tokenToRead}/{tokenToWrite}: put: tags: - - "manage" + - "manage" summary: "Update draft document" parameters: - - name: "tokenToRead" - in: "path" - required: true - schema: - type: "string" - examples: - GoodId: - value: 'f9e48fc9-da3d-aa39-1ab5-0641b0a0f59a' - WronId: - value: 'not the good id' - - name: "tokenToWrite" - in: "path" - required: true - schema: - type: "string" - examples: - GoodId: - value: 'f9e48fc9-da3d-aa39-1ab5-0641b0a0f59a' - WronId: - value: 'not the good id' + - name: "tokenToRead" + in: "path" + required: true + schema: + type: "string" + examples: + GoodId: + value: "f9e48fc9-da3d-aa39-1ab5-0641b0a0f59a" + WronId: + value: "not the good id" + - name: "tokenToWrite" + in: "path" + required: true + schema: + type: "string" + examples: + GoodId: + value: "f9e48fc9-da3d-aa39-1ab5-0641b0a0f59a" + WronId: + value: "not the good id" requestBody: required: true content: application/json: schema: - $ref: '#/components/schemas/diagrammestructure' + $ref: "#/components/schemas/diagramstructure" examples: JsonOK: - value: [{"type":"diagram/add","payload":{"diagramId":"f9e48fc9-da3d-aa39-1ab5-0641b0a0f59a","timestamp":1654256184083}},{"type":"items/addVisual","payload":{"diagramId":"f9e48fc9-da3d-aa39-1ab5-0641b0a0f59a","timestamp":1654256186400,"shapeId":"82170ec5-2cc5-c0f2-1414-38e8e477dd01","renderer":"Button","position":{"x":199.5,"y":119.30000305175781}}}] - badFormat: - value: 'This is not JSON format' + value: + [ + { + "type": "diagram/add", + "payload": + { + "diagramId": "f9e48fc9-da3d-aa39-1ab5-0641b0a0f59a", + "timestamp": 1654256184083, + }, + }, + { + "type": "items/addVisual", + "payload": + { + "diagramId": "f9e48fc9-da3d-aa39-1ab5-0641b0a0f59a", + "timestamp": 1654256186400, + "shapeId": "82170ec5-2cc5-c0f2-1414-38e8e477dd01", + "renderer": "Button", + "position": { "x": 199.5, "y": 119.30000305175781 }, + }, + }, + ] + badFormat: + value: "This is not JSON format" responses: "200": description: "successful operation" content: application/json: schema: - $ref: '#/components/schemas/serverresponsestore' + $ref: "#/components/schemas/serverresponsestore" "400": description: "probleme with body content JSON structure" content: application/json: schema: - $ref: '#/components/schemas/internalerror' + $ref: "#/components/schemas/internalerror" "500": description: "Server Internal ERROR" content: application/json: schema: - $ref: '#/components/schemas/internalerror' - security: [] # no authentication + $ref: "#/components/schemas/internalerror" + security: [] # no authentication /get/{diagramID}: get: tags: - - "manage" - summary: "return JSON Object" + - "manage" + summary: "to get a draft document (json object)" parameters: - - name: "diagramID" - in: "path" - description: "diagramme ID" - required: true - schema: - type: "string" - examples: - GoodId: - value: 'f9e48fc9-da3d-aa39-1ab5-0641b0a0f59a' - WronId: - value: 'not the good id' - RunDir: - value: '../f9e48fc9-da3d-aa39-1ab5-0641b0a0f59a' + - name: "diagramID" + in: "path" + description: "diagram ID" + required: true + schema: + type: "string" + examples: + GoodId: + value: "f9e48fc9-da3d-aa39-1ab5-0641b0a0f59a" + WronId: + value: "not the good id" + RunDir: + value: "../f9e48fc9-da3d-aa39-1ab5-0641b0a0f59a" responses: "200": description: "successful operation" content: application/json: schema: - $ref: '#/components/schemas/diagrammestructure' + $ref: "#/components/schemas/diagramstructure" "500": description: "Server Internal ERROR" content: application/json: schema: - $ref: '#/components/schemas/internalerror' - security: [] # no authentication - - - - + $ref: "#/components/schemas/internalerror" + security: [] # no authentication