Merge pull request #6 from iMvBremen/feature/information-standard-met…

…adata

Add InformationStandard relationship endpoints

CHANGELOG.md

@@ -9,6 +9,18 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 
 ## [Unreleased]
 
+### Changed
+
+- Change `/information-standard-versions` endpoints to support `communicationStandardVersions` and
+  `trustFrameworkVersions` properties
+
+### Added
+
+- Add `/information-standard-versions/{informationStandardVersionId}/communication-standard-versions/{communicationStandardVersionId}`
+  endpoints to support setting and deleting `communicationStandardVersions` for an `InformationStandardVersion`
+- Add `/information-standard-versions/{informationStandardVersionId}/trust-framework-versions/{trustFrameworkVersionId}`
+  endpoints to support setting and deleting `trustFrameworkVersions` for an `InformationStandardVersion`
+
 ## [0.5.0] - 2024-12-05
 
 This release adds support for information standards.

src/v1beta1/information-standard-versions/_schemas/InformationStandardVersion.yaml

@@ -80,4 +80,12 @@ properties:
       $ref: '../../_schemas/CareType.yaml'
     examples:
       -
-        - GENERAL_PRACTITIONERS
+        - GENERAL_PRACTITIONERS
+  communicationStandardVersions:
+    type: array
+    items:
+      $ref: '../../communication-standard-versions/_schemas/BasicCommunicationStandardVersion.yaml'
+  trustFrameworkVersions:
+    type: array
+    items:
+      $ref: '../../trust-framework-versions/_schemas/BasicTrustFrameworkVersion.yaml'

src/v1beta1/information-standard-versions/_schemas/InformationStandardVersion_Update.yaml

@@ -5,4 +5,8 @@ allOf:
   - type: object
     properties:
       informationStandardId:
+        readOnly: true
+      communicationStandardVersions:
+        readOnly: true
+      trustFrameworkVersions:
         readOnly: true

src/v1beta1/information-standard-versions/communication-standard-versions/_paths/communication-standard-versions_{communicationStandardVersionId}.yaml

@@ -0,0 +1,64 @@
+put:
+  summary: Set a communication standard version for an information standard version
+  description: |
+    Sets a single communication standard version for an information standard version.
+  operationId: setInformationStandardVersionCommunicationStandardVersion
+  security:
+    - oauth2:
+        - information-standards:write
+  tags:
+    - information-standard-versions.communication-standard-versions
+  parameters:
+    - $ref: '../../_parameters/path/informationStandardVersionId.yaml'
+    - $ref: '../../../communication-standard-versions/_parameters/path/communicationStandardVersionId.yaml'
+  responses:
+    '204':
+      $ref: '../../../_responses/EmptyResponse.yaml'
+    '400':
+      $ref: '../../../_responses/BadRequestError.yaml'
+    '401':
+      $ref: '../../../_responses/UnauthenticatedError.yaml'
+    '403':
+      $ref: '../../../_responses/PermissionDeniedError.yaml'
+    '404':
+      $ref: '../../../_responses/NotFoundError.yaml'
+    '422':
+      $ref: '../../../_responses/InvalidArgumentError.yaml'
+    '429':
+      $ref: '../../../_responses/ResourceExhaustedError.yaml'
+    '503':
+      $ref: '../../../_responses/UnavailableError.yaml'
+    5XX:
+      $ref: '../../../_responses/InternalError.yaml'
+delete:
+  summary: Delete a communication standard version from an information standard version
+  description: |
+    Deletes a single communication standard version from an information standard version.
+  operationId: deleteInformationStandardVersionCommunicationStandardVersion
+  security:
+    - oauth2:
+        - information-standards:write
+  tags:
+    - information-standard-versions.communication-standard-versions
+  parameters:
+    - $ref: '../../_parameters/path/informationStandardVersionId.yaml'
+    - $ref: '../../../communication-standard-versions/_parameters/path/communicationStandardVersionId.yaml'
+  responses:
+    '204':
+      $ref: '../../../_responses/EmptyResponse.yaml'
+    '400':
+      $ref: '../../../_responses/BadRequestError.yaml'
+    '401':
+      $ref: '../../../_responses/UnauthenticatedError.yaml'
+    '403':
+      $ref: '../../../_responses/PermissionDeniedError.yaml'
+    '404':
+      $ref: '../../../_responses/NotFoundError.yaml'
+    '422':
+      $ref: '../../../_responses/InvalidArgumentError.yaml'
+    '429':
+      $ref: '../../../_responses/ResourceExhaustedError.yaml'
+    '503':
+      $ref: '../../../_responses/UnavailableError.yaml'
+    5XX:
+      $ref: '../../../_responses/InternalError.yaml'

src/v1beta1/information-standard-versions/trust-framework-versions/_paths/trust-framework-versions_{trustFrameworkVersionId}.yaml

@@ -0,0 +1,64 @@
+put:
+  summary: Set a trust framework version for an information standard version
+  description: |
+    Sets a single trust framework version for an information standard version.
+  operationId: setInformationStandardVersionTrustFrameworkVersion
+  security:
+    - oauth2:
+        - information-standards:write
+  tags:
+    - information-standard-versions.trust-framework-versions
+  parameters:
+    - $ref: '../../_parameters/path/informationStandardVersionId.yaml'
+    - $ref: '../../../trust-framework-versions/_parameters/path/trustFrameworkVersionId.yaml'
+  responses:
+    '204':
+      $ref: '../../../_responses/EmptyResponse.yaml'
+    '400':
+      $ref: '../../../_responses/BadRequestError.yaml'
+    '401':
+      $ref: '../../../_responses/UnauthenticatedError.yaml'
+    '403':
+      $ref: '../../../_responses/PermissionDeniedError.yaml'
+    '404':
+      $ref: '../../../_responses/NotFoundError.yaml'
+    '422':
+      $ref: '../../../_responses/InvalidArgumentError.yaml'
+    '429':
+      $ref: '../../../_responses/ResourceExhaustedError.yaml'
+    '503':
+      $ref: '../../../_responses/UnavailableError.yaml'
+    5XX:
+      $ref: '../../../_responses/InternalError.yaml'
+delete:
+  summary: Delete a trust framework version from an information standard version
+  description: |
+    Deletes a single trust framework version from an information standard version.
+  operationId: deleteInformationStandardVersionTrustFrameworkVersion
+  security:
+    - oauth2:
+        - information-standards:write
+  tags:
+    - information-standard-versions.trust-framework-versions
+  parameters:
+    - $ref: '../../_parameters/path/informationStandardVersionId.yaml'
+    - $ref: '../../../trust-framework-versions/_parameters/path/trustFrameworkVersionId.yaml'
+  responses:
+    '204':
+      $ref: '../../../_responses/EmptyResponse.yaml'
+    '400':
+      $ref: '../../../_responses/BadRequestError.yaml'
+    '401':
+      $ref: '../../../_responses/UnauthenticatedError.yaml'
+    '403':
+      $ref: '../../../_responses/PermissionDeniedError.yaml'
+    '404':
+      $ref: '../../../_responses/NotFoundError.yaml'
+    '422':
+      $ref: '../../../_responses/InvalidArgumentError.yaml'
+    '429':
+      $ref: '../../../_responses/ResourceExhaustedError.yaml'
+    '503':
+      $ref: '../../../_responses/UnavailableError.yaml'
+    5XX:
+      $ref: '../../../_responses/InternalError.yaml'