CrudAPI/openapi3.yaml at master · Powfu2/CrudAPI · 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
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
openapi: 3.0.1
info:
  title: CRUD API
  description: basic template for map colonies service
  version: 1.0.0
  license:
    name: MIT
    url: https://opensource.org/licenses/MIT

paths:
  /anotherResource:
    get:
      operationId: getAnotherResource
      tags:
        - anotherResource
      summary: gets the resource
      responses:
        200:
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/anotherResource'
        400:
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
  /products:
    get:
      operationId: getProducts
      tags:
        - products
      parameters:
        - name: name
          in: query
          schema:
            type: string
        - name: type
          in: query
          schema:
            type: string
            enum:
              - raster
              - rasterized_vector
              - tiles3d
              - QMesh
      summary: gets the resource
      responses:
        200:
          description: A JSON array of products
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Products'
        400:
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
    post:
      operationId: createProduct
      tags:
        - products
      summary: creates a new record of type product
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Product'
      responses:
        201:
          description: created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Product'
        400:
          description: Bad Request
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/error'
security:
  - {}
components:
  schemas:
    GeoJsonPolygon:
      type: object
      required:
        - type
        - coordinates
      properties:
        type:
          type: string
          enum:
            - Polygon
        coordinates:
          type: array
          items:
            type: array
            items:
              type: array
              minItems: 2
              maxItems: 2
              items:
                type: number
    error:
      type: object
      required:
        - message
      properties:
        message:
          type: string
    Product:
      type: object
      properties:
        id:
          type: string
          format: uuid
        name:
          type: string
          maxLength: 48

        description:
          type: string

        bounding_polygon:
          $ref: '#/components/schemas/GeoJsonPolygon'

        consumption_link:
          type: string
          nullable: true

        resolution_best:
          type: number
          format: double

        min_zoom:
          type: integer
          minimum: 0

        max_zoom:
          type: integer
          minimum: 0

        type:
          type: string
          enum:
            - raster
            - rasterized_vector
            - tiles3d
            - QMesh

        consumption_protocol:
          type: string
          enum:
            - WMS
            - WMTS
            - XYZ
            - 3D Tiles
    Products:
      type: array
      items:
        $ref: '#/components/schemas/Product'
    anotherResource:
      type: object
      required:
        - kind
        - isAlive
      properties:
        kind:
          type: string
        isAlive:
          type: boolean