Skip to content

Commit 6250842

Browse files
committed
Some swagger updates
1 parent 9ac642c commit 6250842

File tree

4 files changed

+14
-4
lines changed

4 files changed

+14
-4
lines changed

infrastructure/swagger/05_paths.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -356,7 +356,7 @@ paths:
356356
"200":
357357
$ref: "#/components/responses/ProductRead"
358358
"404":
359-
$ref: "#/components/responses/NotFound"
359+
$ref: "#/components/responses/ProductNotFound"
360360
x-amazon-apigateway-integration:
361361
<<: *ApiGatewayIntegration
362362
uri: ${method_readCpmProduct}

infrastructure/swagger/07_components--schemas--domain.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -183,7 +183,7 @@ components:
183183
- org_code: "xyzzy"
184184
product_teams:
185185
- product_team_id: "55e86121-3826-468c-a6f0-dd0f1fbc0259"
186-
- cpm_product_team_id: "a9a9694d-001b-45ce-9f2a-6c9bf80ae0d0"
186+
cpm_product_team_id: "a9a9694d-001b-45ce-9f2a-6c9bf80ae0d0"
187187
products:
188188
- id: "P.123"
189189
product_team_id: "1234"
@@ -195,7 +195,7 @@ components:
195195
deleted_on: "null"
196196
keys: []
197197
- product_team_id: "24ac1857-f718-4905-813f-52da930c3ea1"
198-
- cpm_product_team_id: "152705aa-0342-487f-a654-64bba814a847"
198+
cpm_product_team_id: "152705aa-0342-487f-a654-64bba814a847"
199199
products:
200200
- id: "P.xyz"
201201
product_team_id: "5678"

infrastructure/swagger/12_components--responses.yaml

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -40,6 +40,16 @@ components:
4040
errors:
4141
- code: "RESOURCE_NOT_FOUND"
4242
message: "Could not find ProductTeam for key ('f9518c12-6c83-4544-97db-d9dd1d64da97')"
43+
ProductNotFound:
44+
description: Product has not been found
45+
content:
46+
application/json:
47+
schema:
48+
$ref: "#/components/schemas/ErrorResponse"
49+
example:
50+
errors:
51+
- code: "RESOURCE_NOT_FOUND"
52+
message: "Could not find CpmProduct for key ('P.XXX-YYY')"
4353
Conflict:
4454
description: Conflict
4555
content:

infrastructure/swagger/13_components--parameters--query.yaml

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ components:
55
name: product_team_id
66
in: query
77
required: false
8-
description: The ID of the product team to filter results by.
8+
description: Product Team identifier to filter results by. Either the "internally" generated id (cpm_product_team_id) or the provided team id (product_team_id)
99
schema:
1010
type: string
1111
OrganisationCodeQuery:

0 commit comments

Comments
 (0)