Skip to content

Commit 0440751

Browse files
committed
Fix parameter syntax
1 parent 9ed1cb8 commit 0440751

File tree

2 files changed

+92
-87
lines changed

2 files changed

+92
-87
lines changed

oas/2.0/complaints.yaml

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -21,13 +21,13 @@ tags:
2121
description: "Complaints API"
2222
paths:
2323
/complaints/{complaint_uid}:
24-
parameters:
25-
- name: complaint_uid
26-
in: path
27-
required: true
28-
schema:
29-
type: string
3024
get:
25+
parameters:
26+
- name: complaint_uid
27+
in: path
28+
required: true
29+
schema:
30+
type: string
3131
tags:
3232
- "Complaints"
3333
summary: "Get Complaint"
@@ -45,7 +45,13 @@ paths:
4545
$ref: '../common/error.yaml#/components/responses/notFoundError'
4646
'401':
4747
$ref: '../common/error.yaml#/components/responses/unauthorizedError'
48-
patch:
48+
patch:
49+
parameters:
50+
- name: complaint_uid
51+
in: path
52+
required: true
53+
schema:
54+
type: string
4955
tags:
5056
- "Complaints"
5157
summary: "Update Complaint"
@@ -73,8 +79,7 @@ paths:
7379
'404':
7480
$ref: '../common/error.yaml#/components/responses/notFoundError'
7581
'401':
76-
$ref: '../common/error.yaml#/components/responses/unauthorizedError'
77-
82+
$ref: '../common/error.yaml#/components/responses/unauthorizedError'
7883
/complaints:
7984
post:
8085
tags:

oas/2.0/officers.yaml

Lines changed: 78 additions & 78 deletions
Original file line numberDiff line numberDiff line change
@@ -36,12 +36,12 @@ paths:
3636
- $ref: '../common/pagination.yaml#/components/parameters/per_page'
3737
- $ref: '#/components/parameters/active_after'
3838
- $ref: '#/components/parameters/active_before'
39-
- $ref: '#components/parameters/agency'
40-
- $ref: '#components/parameters/rank'
41-
- $ref: '#components/parameters/unit'
42-
- $ref: '#components/parameters/name'
43-
- $ref: '#components/parameters/ethnicity'
44-
- $ref: '#components/parameters/badge_number'
39+
- $ref: '#/components/parameters/agency'
40+
- $ref: '#/components/parameters/rank'
41+
- $ref: '#/components/parameters/unit'
42+
- $ref: '#/components/parameters/name'
43+
- $ref: '#/components/parameters/ethnicity'
44+
- $ref: '#/components/parameters/badge_number'
4545
responses:
4646
"200":
4747
description: "Successful operation"
@@ -106,12 +106,12 @@ paths:
106106
- $ref: '../common/pagination.yaml#/components/parameters/per_page'
107107
- $ref: '#/components/parameters/active_after'
108108
- $ref: '#/components/parameters/active_before'
109-
- $ref: '#components/parameters/agency'
110-
- $ref: '#components/parameters/rank'
111-
- $ref: '#components/parameters/unit'
112-
- $ref: '#components/parameters/name'
113-
- $ref: '#components/parameters/ethnicity'
114-
- $ref: '#components/parameters/badge_number'
109+
- $ref: '#/components/parameters/agency'
110+
- $ref: '#/components/parameters/rank'
111+
- $ref: '#/components/parameters/unit'
112+
- $ref: '#/components/parameters/name'
113+
- $ref: '#/components/parameters/ethnicity'
114+
- $ref: '#/components/parameters/badge_number'
115115
requestBody:
116116
description: >
117117
A JSON object containing the filters to apply to the search.
@@ -250,72 +250,72 @@ paths:
250250
$ref: '../common/error.yaml#/components/responses/unauthorizedError'
251251
components:
252252
parameters:
253-
- active_after:
254-
name: active_after
255-
in: query
256-
description: >
257-
Filter officers who were active after this date. The date should be in the format YYYY-MM-DD.
258-
required: false
259-
schema:
260-
type: string
261-
format: date
262-
- active_before:
263-
name: active_before
264-
in: query
265-
description: >
266-
Filter officers who were active before this date. The date should be in the format YYYY-MM-DD.
267-
required: false
268-
schema:
269-
type: string
270-
format: date
271-
- agency:
272-
name: agency
273-
in: query
274-
description: >
275-
Filter officers by the agency they are employed by. The value should be a comma-separated list of agency uids.
276-
required: false
277-
schema:
278-
type: string
279-
- rank:
280-
name: rank
281-
in: query
282-
description: >
283-
Filter officers by their rank. The value should be a comma-separated list of ranks.
284-
required: false
285-
schema:
286-
type: string
287-
- unit:
288-
name: unit
289-
in: query
290-
description: >
291-
Filter officers by their unit. The value should be a comma-separated list of unit uids.
292-
required: false
293-
schema:
294-
type: string
295-
- name:
296-
name: name
297-
in: query
298-
description: >
299-
Filter officers by their name. The value should be a string in the format "first middle last suffix".
300-
required: false
301-
schema:
302-
type: string
303-
- ethnicity:
304-
name: ethnicity
305-
in: query
306-
description: >
307-
Filter officers by their ethnicity. The value should be a comma-separated list of ethnicities.
308-
required: false
309-
schema:
310-
type: string
311-
- badge_number:
312-
name: badge_number
313-
in: query
314-
description: >
315-
Filter officers by their badge number. The value should be a comma-separated list of badge numbers.
316-
required: false
317-
schema:
318-
type: string
253+
active_after:
254+
name: active_after
255+
in: query
256+
description: >
257+
Filter officers who were active after this date. The date should be in the format YYYY-MM-DD.
258+
required: false
259+
schema:
260+
type: string
261+
format: date
262+
active_before:
263+
name: active_before
264+
in: query
265+
description: >
266+
Filter officers who were active before this date. The date should be in the format YYYY-MM-DD.
267+
required: false
268+
schema:
269+
type: string
270+
format: date
271+
agency:
272+
name: agency
273+
in: query
274+
description: >
275+
Filter officers by the agency they are employed by. The value should be a comma-separated list of agency uids.
276+
required: false
277+
schema:
278+
type: string
279+
rank:
280+
name: rank
281+
in: query
282+
description: >
283+
Filter officers by their rank. The value should be a comma-separated list of ranks.
284+
required: false
285+
schema:
286+
type: string
287+
unit:
288+
name: unit
289+
in: query
290+
description: >
291+
Filter officers by their unit. The value should be a comma-separated list of unit uids.
292+
required: false
293+
schema:
294+
type: string
295+
name:
296+
name: name
297+
in: query
298+
description: >
299+
Filter officers by their name. The value should be a string in the format "first middle last suffix".
300+
required: false
301+
schema:
302+
type: string
303+
ethnicity:
304+
name: ethnicity
305+
in: query
306+
description: >
307+
Filter officers by their ethnicity. The value should be a comma-separated list of ethnicities.
308+
required: false
309+
schema:
310+
type: string
311+
badge_number:
312+
name: badge_number
313+
in: query
314+
description: >
315+
Filter officers by their badge number. The value should be a comma-separated list of badge numbers.
316+
required: false
317+
schema:
318+
type: string
319319
securitySchemes:
320320
bearerAuth:
321321
type: http

0 commit comments

Comments
 (0)