diff options
| author | ckonstanski <kostcarl@isu.edu> | 2026-07-30 18:17:14 -0600 |
|---|---|---|
| committer | ckonstanski <kostcarl@isu.edu> | 2026-07-30 18:17:14 -0600 |
| commit | 640ff61422bc0ee3966941b93d9889ddbbd38d77 (patch) | |
| tree | abf1c08f5d38ee53ec8b29dc4f425722517505e6 /doc/swagger/restapi-swagger.yaml | |
| parent | 22dae02a86c1fce71091bfa5289cf99abba1b217 (diff) | |
Diffstat (limited to 'doc/swagger/restapi-swagger.yaml')
| -rw-r--r-- | doc/swagger/restapi-swagger.yaml | 93 |
1 files changed, 93 insertions, 0 deletions
diff --git a/doc/swagger/restapi-swagger.yaml b/doc/swagger/restapi-swagger.yaml new file mode 100644 index 0000000..b0a2752 --- /dev/null +++ b/doc/swagger/restapi-swagger.yaml @@ -0,0 +1,93 @@ +swagger: '2.0' +info: + description: FarEdge REST API + version: 0.0.1 + title: FarEdge REST API + contact: + email: subin.ren@verizonwireless.com +host: faredge.restapi.io +basePath: /v1 +tags: +- name: "CAAS" + description: "cluster status API" +schemes: + - https +paths: + /caas-status: + post: + tags: + - CAAS + summary: Send cluster status to VMB + description: Send cluster status to VMB + operationId: clusterStatus + consumes: + - application/json + produces: + - application/json + parameters: + - name: api_key + in: header + required: true + type: string + - in: body + name: body + description: caas readyness status + required: true + schema: + $ref: '#/definitions/CaaSStatusMap' + responses: + '200': + description: "successful operation" + '403': + description: Forbidden + '405': + description: Invalid input +securityDefinitions: + api_key: + type: apiKey + name: api_key + in: header +definitions: + CaaSStatusMap: + type: object + properties: + cluster_status: + type: array + items: + $ref: "#/definitions/Status" + Status: + type: object + required: + - name + - location + - software_version + - availability + - deploy_status + - created_at + properties: + name: + type: string + example: wsbomagj-d654321-001 + description: + type: string + example: NE CONCORD 8_N + location: + type: string + example: 654321 + software_version: + type: string + example: 20.06 + availability: + type: string + enum: + - ONLINE + deploy_status: + type: string + enum: + - COMPLETE + created_at: + type: string + example: "2020-01-07 04:16:15.743617" + updated_at: + type: string + example: "2020-01-07 06:03:10.854598" |