openapi-configurations/docs/openapi.yaml at main · Eminbegin/openapi-configurations · 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
openapi: 3.0.3
info:
  title: Configuration Service API
  version: 1.0.0
paths:
  /api/configurations:
    post:
      summary: Set configurations
      operationId: SetConfigurations
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/SetConfigurationsRequest'
            example:
              entries:
                - key: "FeatureX.Enabled"
                  value: "true"
                - key: "MaxItems"
                  value: "1000"
      responses:
        '200':
          description: OK
        '400':
          description: Validation error
    get:
      summary: Get configurations
      operationId: GetConfigurations
      parameters:
        - name: pageToken
          in: query
          required: false
          schema:
            type: string
            nullable: true
          description: Paging token (opaque string, may be JSON-serialized internally)
          example: null
        - name: pageSize
          in: query
          required: true
          schema:
            type: integer
            minimum: 1
            maximum: 1000
          example: 100
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetConfigurationsResponse'
              example:
                entries:
                  - key: "FeatureX.Enabled"
                    value: "true"
                  - key: "MaxItems"
                    value: "1000"
                pageToken: "{\"lastKey\":\"MaxItems\"}"
        '400':
          description: Validation error

components:
  schemas:
    SetConfigurationsRequest:
      type: object
      required: [entries]
      properties:
        entries:
          type: array
          minItems: 1
          items:
            $ref: '#/components/schemas/SetConfigurationEntry'
    SetConfigurationEntry:
      type: object
      required: [key, value]
      properties:
        key:
          type: string
          example: FeatureX.Enabled
        value:
          type: string
          example: "true"

    GetConfigurationsResponse:
      type: object
      required: [entries, pageToken]
      properties:
        entries:
          type: array
          items:
            $ref: '#/components/schemas/GetConfigurationEntry'
        pageToken:
          type: string
          nullable: true
    GetConfigurationEntry:
      type: object
      required: [key, value]
      properties:
        key:
          type: string
        value:
          type: string