Skip to content

Commit 2596610

Browse files
committed
Fix new path structure
1 parent e667370 commit 2596610

File tree

1 file changed

+30
-24
lines changed

1 file changed

+30
-24
lines changed

infrastructure/swagger/05_paths.yaml

Lines changed: 30 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -12,12 +12,14 @@ x-definitions:
1212
contentHandling: CONVERT_TO_TEXT
1313

1414
tags:
15-
- name: Core Creation Endpoints
16-
description: Core API creation endpoints
17-
- name: Core Read Endpoints
18-
description: Core API read endpoints
19-
- name: Core Deletion Endpoints
20-
description: Core API deletion endpoints
15+
- name: Core Product ID Endpoints
16+
description: Create, Read and Delete Product IDs
17+
- name: Core EPR Creation Endpoints
18+
description: Core EPR API creation endpoints
19+
- name: Core EPR Read Endpoints
20+
description: Core EPR API read endpoints
21+
- name: Core EPR Deletion Endpoints
22+
description: Core EPR API deletion endpoints
2123
- name: EPR
2224
description: EPR API endpoints
2325
- name: SDS
@@ -55,7 +57,7 @@ paths:
5557
description: >
5658
Create a Product Team. This is needed in order to create a Product.
5759
tags:
58-
- Core Creation Endpoints
60+
- Core Product ID Endpoints
5961
requestBody:
6062
$ref: "#/components/requestBodies/ProductTeamCreateRequestBody"
6163
responses:
@@ -83,7 +85,7 @@ paths:
8385
description: |
8486
- Retrieve a Product Team using a product team ID.
8587
tags:
86-
- Core Read Endpoints
88+
- Core Product ID Endpoints
8789
parameters:
8890
- $ref: "#/components/parameters/ProductTeamId"
8991
- $ref: "#/components/parameters/HeaderVersion"
@@ -105,6 +107,8 @@ paths:
105107
post:
106108
operationId: createproductteamepr
107109
summary: Create a Product Team (Epr) resource (POST)
110+
tags:
111+
- Core EPR Creation Endpoints
108112
requestBody:
109113
$ref: "#/components/requestBodies/ProductTeamCreateRequestBody"
110114
responses:
@@ -129,6 +133,8 @@ paths:
129133
get:
130134
operationId: readproductteamepr
131135
summary: Read a Product Team (Epr) resource (GET)
136+
tags:
137+
- Core EPR Read Endpoints
132138
parameters:
133139
- $ref: "#/components/parameters/ProductTeamId"
134140
- $ref: "#/components/parameters/HeaderVersion"
@@ -151,7 +157,7 @@ paths:
151157
operationId: createproductendpoint
152158
summary: Create a Product resource (POST)
153159
tags:
154-
- Core Creation Endpoints
160+
- Core EPR Creation Endpoints
155161
description: |
156162
This endpoint creates a new Product resource for the specified Product Team.
157163
**Requirements:**
@@ -182,7 +188,7 @@ paths:
182188
description: |
183189
- Retrieve all products for a Product Team using a product team ID.
184190
tags:
185-
- Core Read Endpoints
191+
- Core EPR Read Endpoints
186192
parameters:
187193
- $ref: "#/components/parameters/ProductTeamId"
188194
- $ref: "#/components/parameters/HeaderVersion"
@@ -207,7 +213,7 @@ paths:
207213
description: |
208214
- Retrieve a product using a product team ID and product ID.
209215
tags:
210-
- Core Read Endpoints
216+
- Core EPR Read Endpoints
211217
parameters:
212218
- $ref: "#/components/parameters/ProductTeamId"
213219
- $ref: "#/components/parameters/ProductId"
@@ -231,7 +237,7 @@ paths:
231237
description: |
232238
- Delete a product using a product team ID and product ID.
233239
tags:
234-
- Core Deletion Endpoints
240+
- Core EPR Deletion Endpoints
235241
parameters:
236242
- $ref: "#/components/parameters/ProductTeamId"
237243
- $ref: "#/components/parameters/ProductId"
@@ -250,12 +256,12 @@ paths:
250256
- ${authoriser_name}: []
251257
- app-level0: []
252258

253-
/ProductTeam/{product_team_id}/Product/Epr:
259+
/ProductTeamEpr/{product_team_id}/Product/Epr:
254260
post:
255261
operationId: createproductforeprendpoint
256262
summary: Create an EPR Product resource (POST)
257263
tags:
258-
- EPR
264+
- Core EPR Creation Endpoints
259265
description: |
260266
This endpoint creates a new EPR Product resource for the specified Product Team.
261267
**Requirements:**
@@ -288,7 +294,7 @@ paths:
288294
description: |
289295
- Retrieve all Device Reference Data objects using a product team ID and product ID.
290296
tags:
291-
- Core Read Endpoints
297+
- Core EPR Read Endpoints
292298
parameters:
293299
- $ref: "#/components/parameters/ProductTeamId"
294300
- $ref: "#/components/parameters/ProductId"
@@ -311,7 +317,7 @@ paths:
311317
operationId: createDeviceReferenceData
312318
summary: Create a Device Reference Data resource (POST)
313319
tags:
314-
- Core Creation Endpoints
320+
- Core EPR Creation Endpoints
315321
description: |
316322
**This endpoint has not yet been configured. Do not use.**
317323
parameters:
@@ -342,7 +348,7 @@ paths:
342348
operationId: createDeviceReferenceDataMessageSet
343349
summary: Create a Device Reference Data Message Set resource (POST)
344350
tags:
345-
- EPR
351+
- Core EPR Creation Endpoints
346352
description: |
347353
This endpoint creates a Device Reference Data Message Set resource for the specified Product.
348354
**Requirements:**
@@ -379,7 +385,7 @@ paths:
379385
operationId: createDeviceReferenceDataAdditionalInteractions
380386
summary: Create a Device Reference Data Additional Interactions resource (POST)
381387
tags:
382-
- EPR
388+
- Core EPR Creation Endpoints
383389
description: |
384390
This endpoint creates a Device Reference Data Additional Interactions resource for the specified Product.
385391
**Requirements:**
@@ -418,7 +424,7 @@ paths:
418424
description: >
419425
Retrieve a Device Reference Data entity using a product team ID, product ID and Device Reference Data ID.
420426
tags:
421-
- Core Read Endpoints
427+
- Core EPR Read Endpoints
422428
parameters:
423429
- $ref: "#/components/parameters/ProductTeamId"
424430
- $ref: "#/components/parameters/ProductId"
@@ -444,7 +450,7 @@ paths:
444450
operationId: createDevice
445451
summary: Create a Device resource (POST)
446452
tags:
447-
- Core Creation Endpoints
453+
- Core EPR Creation Endpoints
448454
description: |
449455
**This endpoint has not yet been configured. Do not use.**
450456
parameters:
@@ -477,7 +483,7 @@ paths:
477483
description: >
478484
Retrieve a device using a product team ID, product ID and device ID.
479485
tags:
480-
- Core Read Endpoints
486+
- Core EPR Read Endpoints
481487
parameters:
482488
- $ref: "#/components/parameters/ProductTeamId"
483489
- $ref: "#/components/parameters/ProductId"
@@ -503,7 +509,7 @@ paths:
503509
operationId: createDeviceMessageHandlingSystem
504510
summary: Create a Message Handling System Device resource (POST)
505511
tags:
506-
- EPR
512+
- Core EPR Creation Endpoints
507513
description: |
508514
This endpoint creates a new Message Handling System Device resource for the specified Product.
509515
**Requirements:**
@@ -541,7 +547,7 @@ paths:
541547
operationId: createDeviceAccreditedSystem
542548
summary: Create a Accredited System Device resource (POST)
543549
tags:
544-
- EPR
550+
- Core EPR Creation Endpoints
545551
description: |
546552
This endpoint creates a new Accredited System Device resource for the specified Product.
547553
**Requirements:**
@@ -641,7 +647,7 @@ paths:
641647
- spine_mhs_message_sets
642648
- spine_as_additional_interactions
643649
tags:
644-
- Core Read Endpoints
650+
- Core EPR Read Endpoints
645651
parameters:
646652
- $ref: "#/components/parameters/QuestionnaireId"
647653
- $ref: "#/components/parameters/HeaderVersion"

0 commit comments

Comments
 (0)