From 2ba07d77370c68a70c34a8dee68e87d25ca51d03 Mon Sep 17 00:00:00 2001 From: hsmith-adl Date: Wed, 3 Jul 2024 11:03:33 -0400 Subject: [PATCH] Adding swagger doc to docs folder --- docs/api/swagger.yaml | 72 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 72 insertions(+) create mode 100644 docs/api/swagger.yaml diff --git a/docs/api/swagger.yaml b/docs/api/swagger.yaml new file mode 100644 index 0000000..7989941 --- /dev/null +++ b/docs/api/swagger.yaml @@ -0,0 +1,72 @@ +openapi: 3.0.1 +info: + title: ELRR Datasync OpenAPI definition + version: v0 +servers: + - url: http://127.0.0.1:8080 + description: Generated server url +paths: + /api/getImports: + get: + tags: + - imports-controller + operationId: getImports + parameters: + - name: name + in: query + required: true + schema: + type: string + responses: + '200': + description: default response + content: + '*/*': + schema: + $ref: '#/components/schemas/ImportDTO' + /api/getAllImports: + get: + tags: + - imports-controller + operationId: getAllImports + responses: + '200': + description: default response + content: + '*/*': + schema: + type: array + items: + $ref: '#/components/schemas/ImportDTO' +components: + schemas: + ImportDTO: + type: object + properties: + importsName: + type: string + detailsList: + type: array + items: + $ref: '#/components/schemas/ImportDetailDTO' + ImportDetailDTO: + type: object + properties: + importsName: + type: string + importsEndPoint: + type: string + importsDate: + type: string + format: date-time + totalRecords: + type: integer + format: int32 + failedRecords: + type: integer + format: int32 + successRecords: + type: integer + format: int32 + status: + type: string \ No newline at end of file