commit 9b36bed2cd94f2b5ba9f25747e57859b5a432447 Author: Nicolas Massé Date: Thu Apr 4 20:24:49 2019 +0200 initial release diff --git a/openapi-spec.yaml b/openapi-spec.yaml new file mode 100644 index 0000000..c2d0a60 --- /dev/null +++ b/openapi-spec.yaml @@ -0,0 +1,41 @@ +swagger: '2.0' +info: + title: 'TODO List API' + description: Manage TODO's + version: '1.0.0' +paths: + /todo: + get: + summary: 'Get TODO' + description: 'Get all TODOs' + operationId: GetTODO + consumes: + - application/json + produces: + - application/json + responses: + '200': + description: OK + schema: + $ref: '#/definitions/TODO' +definitions: + TODO: + title: Root Type for TODO + description: a TODO + type: object + properties: + id: + format: int32 + type: integer + message: + type: string + example: >- + { "id": 1, "message": "a TODO" } +securityDefinitions: + apikey: + type: apiKey + description: Use a 3scale API Key + name: user_key + in: query +security: +- apikey: []