go-mms/openapi3.yaml at main · shamlymajeed/go-mms · GitHub

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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
openapi: "3.0.2"
info:
  title: "MMSd api"
  description: "MMSd REST endpoints."
  version: "0.1"
paths:
  /api/v1/about:
    get:
      summary: "Metadata about this service."
      operationId: about
      tags:
        - meta
      responses:
        '200':
          description: Metadata about this service.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/aboutOK'
  /api/v1/healthz:
    get:
      summary: "Health status of this service."
      operationId: healthz
      tags:
        - meta
      responses:
        '200':
          description: The service is ok.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/healthz'
        '503':
          description: The service is up, but something is seriously wrong and healthz will give you the status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/healthz'
        '500':
          description: The whole service is failing, and healthz is not able to give you a meaningful status.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/serviceFailing'

  /api/v1/events:
    get:
      summary: "List all events"
      operationId: events
      tags:
        - events
      responses:
        '200':
          description: Events went ok.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/eventsOK'
        '503':
          description: The service can not properly handle the request at this time.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/serviceFailing'
components:
  schemas:
    healthz:
      title: Service health report.
      type: object
      required:
      - status
      properties:
        status:
          type: string
          example: "healthy"
          enum:
          - healthy
          - unhealthy
          - critical
        description:
          type: string
          example: "we are good."
        errors:
          type: array
          items:
            type: string
    serviceFailing:
      title: Error message.
      type: object
      properties:
        error:
          type: string
          example: "Critial service error. Please try again later."
    eventsOK:
      title: EventsList
      type: array
      items:
        type: object
        required:
          - name
          - created_at
          - production_hub
        properties:
          name:
            type: string
            example: "Arome Arctic"
          created_at:
            type: string
            format: date-time
            example: "2020-09-04T03:00:00Z"
          production_hub:
            type: string
            example: "ecflow.modellprod"
    aboutOK:
      type: object
      properties:
        name:
          type: string
        description:
          type: string
        termsOfService:
          type: string
        provider:
          type: object
          properties:
            "@type":
              type: string
            name:
              type: string