remix-api/swagger-api.yaml at develop · deangilmoreremix/remix-api · 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
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
openapi: '3.0.0'
info:
  title: Videoremix API Docs
  description: API documentation for integrations
  contact:
    name: Support
    email: support@videoremix.io
  version: v1
paths:
  '/api/v1/users/me/makes/':
    get:
      security:
        - BearerAuth: [ ]
      tags:
        - Make
      parameters:
        - name: perPage
          in: query
          description: Number of makes per page
          required: false
          schema:
            type: number
        - name: page
          in: query
          description: Page number
          required: false
          schema:
            type: number
        - name: q
          in: query
          description: Search by title
          required: false
          schema:
            type: string
      summary: Get your makes
      description: Get makes
      operationId: GetMakes
      responses:
        '200':
          description: Return makes
          content:
            application/json:
              example: [ { "_id": "5f96759de3b1ed91d4ead24d", "description": "", "title": "asdad", "contenturl": "http://vremix.s3.amazonaws.com/v/11966x00qz22wrrq1g7t" },{ "_id": "5f9196656367662cb49bd026", "description": "", "title": "Some title", "contenturl": "http://vremix.s3.amazonaws.com/v/118wkuvop722wrrpsbzf" }, ]
        '401':
          $ref: '#/components/responses/UnauthorisedResponse'
        '403':
          $ref: '#/components/responses/ForbiddenErrorResponse'
        '500':
          $ref: '#/components/responses/InternalServerErrorResponse'
    post:
      tags:
        - Make
      summary: Try to create make
      description: Trying to create make/project
      operationId: Try to create make
      responses:
        '401':
          $ref: '#/components/responses/UnauthorisedResponse'


  '/api/v1/users/me/makes/{makeId}':
    get:
      security:
        - BearerAuth: [ ]
      tags:
        - Make
      parameters:
        - name: makeId
          in: path
          description: ID of make to return
          required: true
          schema:
            type: string
          example: '5aaa8669b0c3de001056f8d5'
      summary: Get make by id
      responses:
        '200':
          description: Return make by id
          content:
            application/json:
              example: { "_id": "5f96759de3b1ed91d4ead24d", "description": "", "title": "asdad", "contenturl": "http://vremix.s3.amazonaws.com/v/11966x00qz22wrrq1g7t"}
        '401':
          $ref: '#/components/responses/UnauthorisedResponse'
        '403':
          $ref: '#/components/responses/ForbiddenErrorResponse'
        '404':
          $ref: '#/components/responses/ResourceNotFoundResponse'
        '500':
          $ref: '#/components/responses/InternalServerErrorResponse'


components:
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer
      description: 'Put Your External API key here'

  schemas:
    UnauthorisedError:
      description: Unauthorised error
      required:
        - message
      properties:
        status:
          type: integer
          format: int32
          example: 401
        message:
          type: string
          example: "User is not logged in"

    ForbiddenError:
      description: Forbidden
      required:
        - type
        - message
        - status
      properties:
        status:
          type: integer
          format: int32
          example: 403
        message:
          type: string
          example: 'Forbidden'
        type:
          type: string
          example: 'restifizer'
    InternalServerError:
      description: InternalServerError
      required:
        - type
        - message
        - status
      properties:
        status:
          type: integer
          format: int32
          example: 500
        message:
          type: string
          example: 'Regular expression is invalid: nothing to repeat'
        type:
          type: string
          example: 'restifizer'

    ResourceNotFound:
      description: ResourceNotFound
      required:
        - type
        - message
        - status
        - error
      properties:
        status:
          type: integer
          format: int32
          example: 404
        message:
          type: string
          example: 'Cannot locate resource'
        type:
          type: string
          example: 'restifizer'
        error:
          type: string
          example: 'ResourceNotFound'

  responses:
    UnauthorisedResponse:
      description: 'Error: Unauthorized'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/UnauthorisedError'
    ForbiddenErrorResponse:
      description: 'Error: Forbidden'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ForbiddenError'
    ResourceNotFoundResponse:
      description: 'Error: ResourceNotFound'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/ResourceNotFound'
    InternalServerErrorResponse:
      description: 'Error: Internal Server Error'
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/InternalServerError'