summaryrefslogtreecommitdiff
path: root/doc/swagger/restapi-swagger.yaml
blob: b0a275202e7ca2c4ed92c822aecec638a9425c85 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
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"