Skip to content

Commit 8a533a4

Browse files
committed
Add some swagger fixes
1 parent 386ddf3 commit 8a533a4

File tree

3 files changed

+61
-10
lines changed

3 files changed

+61
-10
lines changed

infrastructure/swagger/05_paths.yaml

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ paths:
4040
$ref: "#/components/requestBodies/ProductTeamCreateRequestBody"
4141
responses:
4242
"201":
43-
$ref: "#/components/responses/ProductTeamCreate"
43+
$ref: "#/components/responses/CPMProductTeamCreate"
4444
"400":
4545
$ref: "#/components/responses/BadRequest"
4646
"422":
@@ -67,7 +67,7 @@ paths:
6767
- $ref: "#/components/parameters/HeaderCorrelationId"
6868
responses:
6969
"200":
70-
$ref: "#/components/responses/ProductTeamRead"
70+
$ref: "#/components/responses/CPMProductTeamRead"
7171
"404":
7272
$ref: "#/components/responses/NotFound"
7373
x-amazon-apigateway-integration:
@@ -85,7 +85,7 @@ paths:
8585
$ref: "#/components/requestBodies/ProductTeamCreateRequestBody"
8686
responses:
8787
"201":
88-
$ref: "#/components/responses/ProductTeamCreate"
88+
$ref: "#/components/responses/EPRProductTeamCreate"
8989
"400":
9090
$ref: "#/components/responses/BadRequest"
9191
"422":
@@ -112,7 +112,7 @@ paths:
112112
- $ref: "#/components/parameters/HeaderCorrelationId"
113113
responses:
114114
"200":
115-
$ref: "#/components/responses/ProductTeamRead"
115+
$ref: "#/components/responses/EPRProductTeamRead"
116116
"404":
117117
$ref: "#/components/responses/NotFound"
118118
x-amazon-apigateway-integration:

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

Lines changed: 41 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ components:
2323
example:
2424
code: "OK"
2525
message: "Transaction successful"
26-
ProductTeamResponse:
26+
CPMProductTeamResponse:
2727
type: object
2828
properties:
2929
id:
@@ -52,7 +52,46 @@ components:
5252
key_value:
5353
type: string
5454
example:
55-
id: "F5H1R"
55+
id: "a9a9694d-001b-45ce-9f2a-6c9bf80ae0d0"
56+
name: "Sample Product Team"
57+
ods_code: "F5H1R"
58+
status: "active"
59+
created_on: "2024-10-15T10:00:00Z"
60+
updated_on: "2024-10-15T10:00:00Z"
61+
deleted_on: "null"
62+
keys:
63+
- key_type: "product_team_id_alias"
64+
key_value: "FOOBAR"
65+
EPRProductTeamResponse:
66+
type: object
67+
properties:
68+
id:
69+
type: string
70+
name:
71+
type: string
72+
ods_code:
73+
type: string
74+
status:
75+
type: string
76+
created_on:
77+
type: string
78+
updated_on:
79+
type: string
80+
nullable: true
81+
deleted_on:
82+
type: string
83+
nullable: true
84+
keys:
85+
type: array
86+
items:
87+
type: object
88+
properties:
89+
key_type:
90+
type: string
91+
key_value:
92+
type: string
93+
example:
94+
id: "F5H1R.a9a9694d-001b-45ce-9f2a-6c9bf80ae0d0"
5695
name: "Sample Product Team"
5796
ods_code: "F5H1R"
5897
status: "active"

infrastructure/swagger/12_components--responses.yaml

Lines changed: 16 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -103,18 +103,30 @@ components:
103103
errors:
104104
- code: "UNPROCESSABLE_ENTITY"
105105
message: "Invalid ODS Code: could not resolve 'https://directory.spineservices.nhs.uk/ORD/2-0-0/organisations/invalid_ods_code'"
106-
ProductTeamCreate:
106+
CPMProductTeamCreate:
107107
description: Create ProductTeam operation successful
108108
content:
109109
application/json:
110110
schema:
111-
$ref: "#/components/schemas/ProductTeamResponse"
112-
ProductTeamRead:
111+
$ref: "#/components/schemas/CPMProductTeamResponse"
112+
EPRProductTeamCreate:
113+
description: Create EPR ProductTeam operation successful
114+
content:
115+
application/json:
116+
schema:
117+
$ref: "#/components/schemas/EPRProductTeamResponse"
118+
CPMProductTeamRead:
113119
description: Read ProductTeam operation successful
114120
content:
115121
application/json:
116122
schema:
117-
$ref: "#/components/schemas/ProductTeamResponse"
123+
$ref: "#/components/schemas/CPMProductTeamResponse"
124+
EPRProductTeamRead:
125+
description: Read EPR ProductTeam operation successful
126+
content:
127+
application/json:
128+
schema:
129+
$ref: "#/components/schemas/EPRProductTeamResponse"
118130
ProductSearch:
119131
description: Search Product operation successful
120132
content:

0 commit comments

Comments
 (0)