mahdahar
fcaf9b74ea
- Add OpenApiDocs controller for serving bundled API docs - Split monolithic api-docs.yaml into modular components/ - Add organized paths/ directory with endpoint definitions - Create bundling scripts (JS, PHP, Python) for merging docs - Add API_DOCS_README.md with documentation guidelines - Update Routes.php for new API documentation endpoints - Update swagger.php view and TestDefSiteModel
290 lines
6.0 KiB
YAML
290 lines
6.0 KiB
YAML
/api/specimen:
|
|
get:
|
|
tags: [Specimen]
|
|
summary: List specimens
|
|
security:
|
|
- bearerAuth: []
|
|
responses:
|
|
'200':
|
|
description: List of specimens
|
|
|
|
post:
|
|
tags: [Specimen]
|
|
summary: Create specimen
|
|
security:
|
|
- bearerAuth: []
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../components/schemas/specimen.yaml#/Specimen'
|
|
responses:
|
|
'201':
|
|
description: Specimen created
|
|
|
|
patch:
|
|
tags: [Specimen]
|
|
summary: Update specimen
|
|
security:
|
|
- bearerAuth: []
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../components/schemas/specimen.yaml#/Specimen'
|
|
responses:
|
|
'200':
|
|
description: Specimen updated
|
|
|
|
/api/specimen/{id}:
|
|
get:
|
|
tags: [Specimen]
|
|
summary: Get specimen by ID
|
|
security:
|
|
- bearerAuth: []
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
responses:
|
|
'200':
|
|
description: Specimen details
|
|
|
|
/api/specimen/container:
|
|
get:
|
|
tags: [Specimen]
|
|
summary: List container definitions
|
|
security:
|
|
- bearerAuth: []
|
|
responses:
|
|
'200':
|
|
description: List of container definitions
|
|
|
|
post:
|
|
tags: [Specimen]
|
|
summary: Create container definition
|
|
security:
|
|
- bearerAuth: []
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../components/schemas/specimen.yaml#/ContainerDef'
|
|
responses:
|
|
'201':
|
|
description: Container definition created
|
|
|
|
patch:
|
|
tags: [Specimen]
|
|
summary: Update container definition
|
|
security:
|
|
- bearerAuth: []
|
|
responses:
|
|
'200':
|
|
description: Container definition updated
|
|
|
|
/api/specimen/container/{id}:
|
|
get:
|
|
tags: [Specimen]
|
|
summary: Get container definition by ID
|
|
security:
|
|
- bearerAuth: []
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
responses:
|
|
'200':
|
|
description: Container definition details
|
|
|
|
/api/specimen/containerdef:
|
|
get:
|
|
tags: [Specimen]
|
|
summary: List container definitions (alias)
|
|
security:
|
|
- bearerAuth: []
|
|
responses:
|
|
'200':
|
|
description: List of container definitions
|
|
|
|
post:
|
|
tags: [Specimen]
|
|
summary: Create container definition (alias)
|
|
security:
|
|
- bearerAuth: []
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../components/schemas/specimen.yaml#/ContainerDef'
|
|
responses:
|
|
'201':
|
|
description: Container definition created
|
|
|
|
patch:
|
|
tags: [Specimen]
|
|
summary: Update container definition (alias)
|
|
security:
|
|
- bearerAuth: []
|
|
responses:
|
|
'200':
|
|
description: Container definition updated
|
|
|
|
/api/specimen/prep:
|
|
get:
|
|
tags: [Specimen]
|
|
summary: List specimen preparations
|
|
security:
|
|
- bearerAuth: []
|
|
responses:
|
|
'200':
|
|
description: List of specimen preparations
|
|
|
|
post:
|
|
tags: [Specimen]
|
|
summary: Create specimen preparation
|
|
security:
|
|
- bearerAuth: []
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../components/schemas/specimen.yaml#/SpecimenPrep'
|
|
responses:
|
|
'201':
|
|
description: Specimen preparation created
|
|
|
|
patch:
|
|
tags: [Specimen]
|
|
summary: Update specimen preparation
|
|
security:
|
|
- bearerAuth: []
|
|
responses:
|
|
'200':
|
|
description: Specimen preparation updated
|
|
|
|
/api/specimen/prep/{id}:
|
|
get:
|
|
tags: [Specimen]
|
|
summary: Get specimen preparation by ID
|
|
security:
|
|
- bearerAuth: []
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
responses:
|
|
'200':
|
|
description: Specimen preparation details
|
|
|
|
/api/specimen/status:
|
|
get:
|
|
tags: [Specimen]
|
|
summary: List specimen statuses
|
|
security:
|
|
- bearerAuth: []
|
|
responses:
|
|
'200':
|
|
description: List of specimen statuses
|
|
|
|
post:
|
|
tags: [Specimen]
|
|
summary: Create specimen status
|
|
security:
|
|
- bearerAuth: []
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../components/schemas/specimen.yaml#/SpecimenStatus'
|
|
responses:
|
|
'201':
|
|
description: Specimen status created
|
|
|
|
patch:
|
|
tags: [Specimen]
|
|
summary: Update specimen status
|
|
security:
|
|
- bearerAuth: []
|
|
responses:
|
|
'200':
|
|
description: Specimen status updated
|
|
|
|
/api/specimen/status/{id}:
|
|
get:
|
|
tags: [Specimen]
|
|
summary: Get specimen status by ID
|
|
security:
|
|
- bearerAuth: []
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
responses:
|
|
'200':
|
|
description: Specimen status details
|
|
|
|
/api/specimen/collection:
|
|
get:
|
|
tags: [Specimen]
|
|
summary: List specimen collection methods
|
|
security:
|
|
- bearerAuth: []
|
|
responses:
|
|
'200':
|
|
description: List of collection methods
|
|
|
|
post:
|
|
tags: [Specimen]
|
|
summary: Create specimen collection method
|
|
security:
|
|
- bearerAuth: []
|
|
requestBody:
|
|
required: true
|
|
content:
|
|
application/json:
|
|
schema:
|
|
$ref: '../components/schemas/specimen.yaml#/SpecimenCollection'
|
|
responses:
|
|
'201':
|
|
description: Collection method created
|
|
|
|
patch:
|
|
tags: [Specimen]
|
|
summary: Update specimen collection method
|
|
security:
|
|
- bearerAuth: []
|
|
responses:
|
|
'200':
|
|
description: Collection method updated
|
|
|
|
/api/specimen/collection/{id}:
|
|
get:
|
|
tags: [Specimen]
|
|
summary: Get specimen collection method by ID
|
|
security:
|
|
- bearerAuth: []
|
|
parameters:
|
|
- name: id
|
|
in: path
|
|
required: true
|
|
schema:
|
|
type: integer
|
|
responses:
|
|
'200':
|
|
description: Collection method details
|