diff --git a/CHANGELOG.md b/CHANGELOG.md index 3c60565..e3744cf 100644 --- a/CHANGELOG.md +++ b/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. diff --git a/src/dist/v1beta1.yaml b/src/dist/v1beta1.yaml index 36f75e3..2ff9583 100644 --- a/src/dist/v1beta1.yaml +++ b/src/dist/v1beta1.yaml @@ -86,6 +86,12 @@ tags: - name: information-standard-versions description: Information standard versions API x-displayName: Information standard versions + - name: information-standard-versions.communication-standard-versions + description: Information standard version communication standard versions API + x-displayName: Information standard version communication standard versions + - name: information-standard-versions.trust-framework-versions + description: Information standard version trust framework versions API + x-displayName: Information standard version trust framework versions - name: trust-frameworks description: Trust frameworks API x-displayName: Trust frameworks @@ -3870,40 +3876,48 @@ paths: The following table lists the field names and operators you can use in a filter expression. - | Field | Type | Operator | Example | - |------------------------------|-------------------------|----------|-----------------------------------------------------------------------| - | `id` | `uuid` | `eq` | `?filter=eq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | - | | | `neq` | `?filter=neq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | - | `name` | `string` | `eq` | `?filter=eq(name,"MedMij Huisartsgegevens")` | - | | | `neq` | `?filter=neq(name,"MedMij Huisartsgegevens")` | - | | | `has` | `?filter=has(name,"MedMij")` | - | | | `stw` | `?filter=stw(name,"MedMij")` | - | | | `enw` | `?filter=enw(name,"Huisartsgegevens")` | - | | | `reg` | `?filter=reg(name,"^[a-zA-Z0-9 ]+$")` | - | `description` | `string` | `eq` | `?filter=eq(description,"MedMij Huisartsgegevens")` | - | | | `neq` | `?filter=neq(description,"MedMij Huisartsgegevens")` | - | | | `has` | `?filter=has(description,"MedMij")` | - | | | `stw` | `?filter=stw(description,"MedMij")` | - | | | `enw` | `?filter=enw(description,"Huisartsgegevens")` | - | | | `reg` | `?filter=reg(description,"^[a-zA-Z0-9 ]+$")` | - | `organizationId` | `uuid` | `eq` | `?filter=eq(organizationId,"533d3fe3-bccc-405a-9904-4f516e892856")` | - | | | `neq` | `?filter=neq(organizationId,"533d3fe3-bccc-405a-9904-4f516e892856")` | - | `mainVersion.lifecycleState` | `ProductLifecycleState` | `eq` | `?filter=eq(mainVersion.lifecycleState,"PUBLISHED")` | - | | | `neq` | `?filter=neq(mainVersion.lifecycleState,"PUBLISHED")` | - | `mainVersion.careTypes.$it` | `CareType` | `eq` | `?filter=any(mainVersion.careTypes,eq($it,"GENERAL_PRACTITIONERS"))` | - | | | `neq` | `?filter=all(mainVersion.careTypes,neq($it,"GENERAL_PRACTITIONERS"))` | - | `createTime` | `date-time` | `eq` | `?filter=eq(createTime,"2024-03-16T14:15:30.500Z")` | - | | | `neq` | `?filter=neq(createTime,"2024-03-16T14:15:30.500Z")` | - | | | `gt` | `?filter=gt(createTime,"2024-03-16T14:15:30.500Z")` | - | | | `gte` | `?filter=gte(createTime,"2024-03-16T14:15:30.500Z")` | - | | | `lt` | `?filter=lt(createTime,"2024-03-16T14:15:30.500Z")` | - | | | `lte` | `?filter=lte(createTime,"2024-03-16T14:15:30.500Z")` | - | `updateTime` | `date-time` | `eq` | `?filter=eq(updateTime,"2024-03-16T14:15:30.500Z")` | - | | | `neq` | `?filter=neq(updateTime,"2024-03-16T14:15:30.500Z")` | - | | | `gt` | `?filter=gt(updateTime,"2024-03-16T14:15:30.500Z")` | - | | | `gte` | `?filter=gte(updateTime,"2024-03-16T14:15:30.500Z")` | - | | | `lt` | `?filter=lt(updateTime,"2024-03-16T14:15:30.500Z")` | - | | | `lte` | `?filter=lte(updateTime,"2024-03-16T14:15:30.500Z")` | + | Field | Type | Operator | Example | + |-------------------------------------------------------------------------|-------------------------|----------|----------------------------------------------------------------------------------------------------------------------------------| + | `id` | `uuid` | `eq` | `?filter=eq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | + | | | `neq` | `?filter=neq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | + | `name` | `string` | `eq` | `?filter=eq(name,"MedMij Huisartsgegevens")` | + | | | `neq` | `?filter=neq(name,"MedMij Huisartsgegevens")` | + | | | `has` | `?filter=has(name,"MedMij")` | + | | | `stw` | `?filter=stw(name,"MedMij")` | + | | | `enw` | `?filter=enw(name,"Huisartsgegevens")` | + | | | `reg` | `?filter=reg(name,"^[a-zA-Z0-9 ]+$")` | + | `description` | `string` | `eq` | `?filter=eq(description,"MedMij Huisartsgegevens")` | + | | | `neq` | `?filter=neq(description,"MedMij Huisartsgegevens")` | + | | | `has` | `?filter=has(description,"MedMij")` | + | | | `stw` | `?filter=stw(description,"MedMij")` | + | | | `enw` | `?filter=enw(description,"Huisartsgegevens")` | + | | | `reg` | `?filter=reg(description,"^[a-zA-Z0-9 ]+$")` | + | `organizationId` | `uuid` | `eq` | `?filter=eq(organizationId,"533d3fe3-bccc-405a-9904-4f516e892856")` | + | | | `neq` | `?filter=neq(organizationId,"533d3fe3-bccc-405a-9904-4f516e892856")` | + | `mainVersion.lifecycleState` | `ProductLifecycleState` | `eq` | `?filter=eq(mainVersion.lifecycleState,"PUBLISHED")` | + | | | `neq` | `?filter=neq(mainVersion.lifecycleState,"PUBLISHED")` | + | `mainVersion.careTypes.$it` | `CareType` | `eq` | `?filter=any(mainVersion.careTypes,eq($it,"GENERAL_PRACTITIONERS"))` | + | | | `neq` | `?filter=all(mainVersion.careTypes,neq($it,"GENERAL_PRACTITIONERS"))` | + | `mainVersion.communicationStandardVersions.$it.id` | `uuid` | `eq` | `?filter=any(mainVersion.communicationStandardVersions,eq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | + | | | `neq` | `?filter=all(mainVersion.communicationStandardVersions,neq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | + | `mainVersion.communicationStandardVersions.$it.communicationStandardId` | `uuid` | `eq` | `?filter=any(mainVersion.communicationStandardVersions,eq($it.communicationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | + | | | `neq` | `?filter=all(mainVersion.communicationStandardVersions,neq($it.communicationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | + | `mainVersion.trustFrameworkVersions.$it.id` | `uuid` | `eq` | `?filter=any(mainVersion.trustFrameworkVersions,eq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | + | | | `neq` | `?filter=all(mainVersion.trustFrameworkVersions,neq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | + | `mainVersion.trustFrameworkVersions.$it.trustFrameworkId` | `uuid` | `eq` | `?filter=any(mainVersion.trustFrameworkVersions,eq($it.trustFrameworkId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | + | | | `neq` | `?filter=all(mainVersion.trustFrameworkVersions,neq($it.trustFrameworkId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | + | `createTime` | `date-time` | `eq` | `?filter=eq(createTime,"2024-03-16T14:15:30.500Z")` | + | | | `neq` | `?filter=neq(createTime,"2024-03-16T14:15:30.500Z")` | + | | | `gt` | `?filter=gt(createTime,"2024-03-16T14:15:30.500Z")` | + | | | `gte` | `?filter=gte(createTime,"2024-03-16T14:15:30.500Z")` | + | | | `lt` | `?filter=lt(createTime,"2024-03-16T14:15:30.500Z")` | + | | | `lte` | `?filter=lte(createTime,"2024-03-16T14:15:30.500Z")` | + | `updateTime` | `date-time` | `eq` | `?filter=eq(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `neq` | `?filter=neq(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `gt` | `?filter=gt(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `gte` | `?filter=gte(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `lt` | `?filter=lt(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `lte` | `?filter=lte(updateTime,"2024-03-16T14:15:30.500Z")` | operationId: listInformationStandards @@ -4108,76 +4122,84 @@ paths: The following table lists the field names and operators you can use in a filter expression. - | Field | Type | Operator | Example | - |-------------------------|-------------------------|----------|-----------------------------------------------------------------------------| - | `id` | `uuid` | `eq` | `?filter=eq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | - | | | `neq` | `?filter=neq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | - | `name` | `string` | `eq` | `?filter=eq(name,"1.2.0")` | - | | | `neq` | `?filter=neq(name,"1.2.0")` | - | | | `has` | `?filter=has(name,"1.2")` | - | | | `stw` | `?filter=stw(name,"1.2")` | - | | | `enw` | `?filter=enw(name,"2.0")` | - | | | `reg` | `?filter=reg(name,"^[a-zA-Z0-9 ]+$")` | - | `description` | `string` | `eq` | `?filter=eq(description,"1.2.0")` | - | | | `neq` | `?filter=neq(description,"1.2.0")` | - | | | `has` | `?filter=has(description,"1.2")` | - | | | `stw` | `?filter=stw(description,"1.2")` | - | | | `enw` | `?filter=enw(description,"2.0")` | - | | | `reg` | `?filter=reg(description,"^[a-zA-Z0-9 ]+$")` | - | `informationStandardId` | `uuid` | `eq` | `?filter=eq(informationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856")` | - | | | `neq` | `?filter=neq(informationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856")` | - | `publishTime` | `date-time` | `eq` | `?filter=eq(publishTime,"2024-03-16T14:15:30.500Z")` | - | | | `neq` | `?filter=neq(publishTime,"2024-03-16T14:15:30.500Z")` | - | | | `gt` | `?filter=gt(publishTime,"2024-03-16T14:15:30.500Z")` | - | | | `gte` | `?filter=gte(publishTime,"2024-03-16T14:15:30.500Z")` | - | | | `lt` | `?filter=lt(publishTime,"2024-03-16T14:15:30.500Z")` | - | | | `lte` | `?filter=lte(publishTime,"2024-03-16T14:15:30.500Z")` | - | `semVer.major` | `integer` | `eq` | `?filter=eq(semVer.major,1)` | - | | | `neq` | `?filter=neq(semVer.major,1)` | - | | | `gt` | `?filter=gt(semVer.major,1)` | - | | | `gte` | `?filter=gte(semVer.major,1)` | - | | | `lt` | `?filter=lt(semVer.major,1)` | - | | | `lte` | `?filter=lte(semVer.major,1)` | - | `semVer.minor` | `integer` | `eq` | `?filter=eq(semVer.minor,2)` | - | | | `neq` | `?filter=neq(semVer.minor,2)` | - | | | `gt` | `?filter=gt(semVer.minor,2)` | - | | | `gte` | `?filter=gte(semVer.minor,2)` | - | | | `lt` | `?filter=lt(semVer.minor,2)` | - | | | `lte` | `?filter=lte(semVer.minor,2)` | - | `semVer.patch` | `integer` | `eq` | `?filter=eq(semVer.patch,0)` | - | | | `neq` | `?filter=neq(semVer.patch,0)` | - | | | `gt` | `?filter=gt(semVer.patch,0)` | - | | | `gte` | `?filter=gte(semVer.patch,0)` | - | | | `lt` | `?filter=lt(semVer.patch,0)` | - | | | `lte` | `?filter=lte(semVer.patch,0)` | - | `semVer.preRelease` | `string` | `eq` | `?filter=eq(semVer.preRelease,"beta")` | - | | | `neq` | `?filter=neq(semVer.preRelease,"beta")` | - | | | `has` | `?filter=has(semVer.preRelease,"be")` | - | | | `stw` | `?filter=stw(semVer.preRelease,"be")` | - | | | `enw` | `?filter=enw(semVer.preRelease,"ta")` | - | | | `reg` | `?filter=reg(semVer.preRelease,"^[a-zA-Z0-9 ]+$")` | - | `semVer.build` | `string` | `eq` | `?filter=eq(semVer.build,"exp.sha.5114f85")` | - | | | `neq` | `?filter=neq(semVer.build,"exp.sha.5114f85")` | - | | | `has` | `?filter=has(semVer.build,"exp.sha")` | - | | | `stw` | `?filter=stw(semVer.build,"exp.sha")` | - | | | `enw` | `?filter=enw(semVer.build,"5114f85")` | - | | | `reg` | `?filter=reg(semVer.build,"^[a-zA-Z0-9 ]+$")` | - | `lifecycleState` | `ProductLifecycleState` | `eq` | `?filter=eq(lifecycleState,"PUBLISHED")` | - | | | `neq` | `?filter=neq(lifecycleState,"PUBLISHED")` | - | `careTypes.$it` | `CareType` | `eq` | `?filter=any(careTypes,eq($it,"GENERAL_PRACTITIONERS"))` | - | | | `neq` | `?filter=all(careTypes,neq($it,"GENERAL_PRACTITIONERS"))` | - | `createTime` | `date-time` | `eq` | `?filter=eq(createTime,"2024-03-16T14:15:30.500Z")` | - | | | `neq` | `?filter=neq(createTime,"2024-03-16T14:15:30.500Z")` | - | | | `gt` | `?filter=gt(createTime,"2024-03-16T14:15:30.500Z")` | - | | | `gte` | `?filter=gte(createTime,"2024-03-16T14:15:30.500Z")` | - | | | `lt` | `?filter=lt(createTime,"2024-03-16T14:15:30.500Z")` | - | | | `lte` | `?filter=lte(createTime,"2024-03-16T14:15:30.500Z")` | - | `updateTime` | `date-time` | `eq` | `?filter=eq(updateTime,"2024-03-16T14:15:30.500Z")` | - | | | `neq` | `?filter=neq(updateTime,"2024-03-16T14:15:30.500Z")` | - | | | `gt` | `?filter=gt(updateTime,"2024-03-16T14:15:30.500Z")` | - | | | `gte` | `?filter=gte(updateTime,"2024-03-16T14:15:30.500Z")` | - | | | `lt` | `?filter=lt(updateTime,"2024-03-16T14:15:30.500Z")` | - | | | `lte` | `?filter=lte(updateTime,"2024-03-16T14:15:30.500Z")` | + | Field | Type | Operator | Example | + |-------------------------------------------------------------|-------------------------|----------|----------------------------------------------------------------------------------------------------------------------| + | `id` | `uuid` | `eq` | `?filter=eq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | + | | | `neq` | `?filter=neq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | + | `name` | `string` | `eq` | `?filter=eq(name,"1.2.0")` | + | | | `neq` | `?filter=neq(name,"1.2.0")` | + | | | `has` | `?filter=has(name,"1.2")` | + | | | `stw` | `?filter=stw(name,"1.2")` | + | | | `enw` | `?filter=enw(name,"2.0")` | + | | | `reg` | `?filter=reg(name,"^[a-zA-Z0-9 ]+$")` | + | `description` | `string` | `eq` | `?filter=eq(description,"1.2.0")` | + | | | `neq` | `?filter=neq(description,"1.2.0")` | + | | | `has` | `?filter=has(description,"1.2")` | + | | | `stw` | `?filter=stw(description,"1.2")` | + | | | `enw` | `?filter=enw(description,"2.0")` | + | | | `reg` | `?filter=reg(description,"^[a-zA-Z0-9 ]+$")` | + | `informationStandardId` | `uuid` | `eq` | `?filter=eq(informationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856")` | + | | | `neq` | `?filter=neq(informationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856")` | + | `publishTime` | `date-time` | `eq` | `?filter=eq(publishTime,"2024-03-16T14:15:30.500Z")` | + | | | `neq` | `?filter=neq(publishTime,"2024-03-16T14:15:30.500Z")` | + | | | `gt` | `?filter=gt(publishTime,"2024-03-16T14:15:30.500Z")` | + | | | `gte` | `?filter=gte(publishTime,"2024-03-16T14:15:30.500Z")` | + | | | `lt` | `?filter=lt(publishTime,"2024-03-16T14:15:30.500Z")` | + | | | `lte` | `?filter=lte(publishTime,"2024-03-16T14:15:30.500Z")` | + | `semVer.major` | `integer` | `eq` | `?filter=eq(semVer.major,1)` | + | | | `neq` | `?filter=neq(semVer.major,1)` | + | | | `gt` | `?filter=gt(semVer.major,1)` | + | | | `gte` | `?filter=gte(semVer.major,1)` | + | | | `lt` | `?filter=lt(semVer.major,1)` | + | | | `lte` | `?filter=lte(semVer.major,1)` | + | `semVer.minor` | `integer` | `eq` | `?filter=eq(semVer.minor,2)` | + | | | `neq` | `?filter=neq(semVer.minor,2)` | + | | | `gt` | `?filter=gt(semVer.minor,2)` | + | | | `gte` | `?filter=gte(semVer.minor,2)` | + | | | `lt` | `?filter=lt(semVer.minor,2)` | + | | | `lte` | `?filter=lte(semVer.minor,2)` | + | `semVer.patch` | `integer` | `eq` | `?filter=eq(semVer.patch,0)` | + | | | `neq` | `?filter=neq(semVer.patch,0)` | + | | | `gt` | `?filter=gt(semVer.patch,0)` | + | | | `gte` | `?filter=gte(semVer.patch,0)` | + | | | `lt` | `?filter=lt(semVer.patch,0)` | + | | | `lte` | `?filter=lte(semVer.patch,0)` | + | `semVer.preRelease` | `string` | `eq` | `?filter=eq(semVer.preRelease,"beta")` | + | | | `neq` | `?filter=neq(semVer.preRelease,"beta")` | + | | | `has` | `?filter=has(semVer.preRelease,"be")` | + | | | `stw` | `?filter=stw(semVer.preRelease,"be")` | + | | | `enw` | `?filter=enw(semVer.preRelease,"ta")` | + | | | `reg` | `?filter=reg(semVer.preRelease,"^[a-zA-Z0-9 ]+$")` | + | `semVer.build` | `string` | `eq` | `?filter=eq(semVer.build,"exp.sha.5114f85")` | + | | | `neq` | `?filter=neq(semVer.build,"exp.sha.5114f85")` | + | | | `has` | `?filter=has(semVer.build,"exp.sha")` | + | | | `stw` | `?filter=stw(semVer.build,"exp.sha")` | + | | | `enw` | `?filter=enw(semVer.build,"5114f85")` | + | | | `reg` | `?filter=reg(semVer.build,"^[a-zA-Z0-9 ]+$")` | + | `lifecycleState` | `ProductLifecycleState` | `eq` | `?filter=eq(lifecycleState,"PUBLISHED")` | + | | | `neq` | `?filter=neq(lifecycleState,"PUBLISHED")` | + | `careTypes.$it` | `CareType` | `eq` | `?filter=any(careTypes,eq($it,"GENERAL_PRACTITIONERS"))` | + | | | `neq` | `?filter=all(careTypes,neq($it,"GENERAL_PRACTITIONERS"))` | + | `communicationStandardVersions.$it.id` | `uuid` | `eq` | `?filter=any(communicationStandardVersions,eq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | + | | | `neq` | `?filter=all(communicationStandardVersions,neq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | + | `communicationStandardVersions.$it.communicationStandardId` | `uuid` | `eq` | `?filter=any(communicationStandardVersions,eq($it.communicationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | + | | | `neq` | `?filter=all(communicationStandardVersions,neq($it.communicationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | + | `trustFrameworkVersions.$it.id` | `uuid` | `eq` | `?filter=any(trustFrameworkVersions,eq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | + | | | `neq` | `?filter=all(trustFrameworkVersions,neq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | + | `trustFrameworkVersions.$it.trustFrameworkId` | `uuid` | `eq` | `?filter=any(trustFrameworkVersions,eq($it.trustFrameworkId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | + | | | `neq` | `?filter=all(trustFrameworkVersions,neq($it.trustFrameworkId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | + | `createTime` | `date-time` | `eq` | `?filter=eq(createTime,"2024-03-16T14:15:30.500Z")` | + | | | `neq` | `?filter=neq(createTime,"2024-03-16T14:15:30.500Z")` | + | | | `gt` | `?filter=gt(createTime,"2024-03-16T14:15:30.500Z")` | + | | | `gte` | `?filter=gte(createTime,"2024-03-16T14:15:30.500Z")` | + | | | `lt` | `?filter=lt(createTime,"2024-03-16T14:15:30.500Z")` | + | | | `lte` | `?filter=lte(createTime,"2024-03-16T14:15:30.500Z")` | + | `updateTime` | `date-time` | `eq` | `?filter=eq(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `neq` | `?filter=neq(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `gt` | `?filter=gt(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `gte` | `?filter=gte(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `lt` | `?filter=lt(updateTime,"2024-03-16T14:15:30.500Z")` | + | | | `lte` | `?filter=lte(updateTime,"2024-03-16T14:15:30.500Z")` | operationId: listInformationStandardVersions @@ -4332,6 +4354,136 @@ paths: $ref: '#/components/responses/UnavailableError' 5XX: $ref: '#/components/responses/InternalError' + /information-standard-versions/{informationStandardVersionId}/communication-standard-versions/{communicationStandardVersionId}: + 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: '#/components/parameters/informationStandardVersionId' + - $ref: '#/components/parameters/communicationStandardVersionId' + responses: + '204': + $ref: '#/components/responses/EmptyResponse' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/PermissionDeniedError' + '404': + $ref: '#/components/responses/NotFoundError' + '422': + $ref: '#/components/responses/InvalidArgumentError' + '429': + $ref: '#/components/responses/ResourceExhaustedError' + '503': + $ref: '#/components/responses/UnavailableError' + 5XX: + $ref: '#/components/responses/InternalError' + 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: '#/components/parameters/informationStandardVersionId' + - $ref: '#/components/parameters/communicationStandardVersionId' + responses: + '204': + $ref: '#/components/responses/EmptyResponse' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/PermissionDeniedError' + '404': + $ref: '#/components/responses/NotFoundError' + '422': + $ref: '#/components/responses/InvalidArgumentError' + '429': + $ref: '#/components/responses/ResourceExhaustedError' + '503': + $ref: '#/components/responses/UnavailableError' + 5XX: + $ref: '#/components/responses/InternalError' + /information-standard-versions/{informationStandardVersionId}/trust-framework-versions/{trustFrameworkVersionId}: + 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: '#/components/parameters/informationStandardVersionId' + - $ref: '#/components/parameters/trustFrameworkVersionId' + responses: + '204': + $ref: '#/components/responses/EmptyResponse' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/PermissionDeniedError' + '404': + $ref: '#/components/responses/NotFoundError' + '422': + $ref: '#/components/responses/InvalidArgumentError' + '429': + $ref: '#/components/responses/ResourceExhaustedError' + '503': + $ref: '#/components/responses/UnavailableError' + 5XX: + $ref: '#/components/responses/InternalError' + 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: '#/components/parameters/informationStandardVersionId' + - $ref: '#/components/parameters/trustFrameworkVersionId' + responses: + '204': + $ref: '#/components/responses/EmptyResponse' + '400': + $ref: '#/components/responses/BadRequestError' + '401': + $ref: '#/components/responses/UnauthenticatedError' + '403': + $ref: '#/components/responses/PermissionDeniedError' + '404': + $ref: '#/components/responses/NotFoundError' + '422': + $ref: '#/components/responses/InvalidArgumentError' + '429': + $ref: '#/components/responses/ResourceExhaustedError' + '503': + $ref: '#/components/responses/UnavailableError' + 5XX: + $ref: '#/components/responses/InternalError' /trust-frameworks: get: summary: List all trust frameworks @@ -7341,6 +7493,14 @@ components: $ref: '#/components/schemas/CareType' examples: - - GENERAL_PRACTITIONERS + communicationStandardVersions: + type: array + items: + $ref: '#/components/schemas/BasicCommunicationStandardVersion' + trustFrameworkVersions: + type: array + items: + $ref: '#/components/schemas/BasicTrustFrameworkVersion' MainInformationStandardVersion: allOf: - $ref: '#/components/schemas/InformationStandardVersion' @@ -7452,6 +7612,10 @@ components: properties: informationStandardId: readOnly: true + communicationStandardVersions: + readOnly: true + trustFrameworkVersions: + readOnly: true TrustFrameworkVersion: description: The trust framework version information type: object @@ -8336,6 +8500,8 @@ x-tagGroups: tags: - information-standards - information-standard-versions + - information-standard-versions.communication-standard-versions + - information-standard-versions.trust-framework-versions - name: Trust frameworks tags: - trust-frameworks diff --git a/src/v1beta1/information-standard-versions/_paths/information-standard-versions#description.md b/src/v1beta1/information-standard-versions/_paths/information-standard-versions#description.md index c476ef2..bda6713 100644 --- a/src/v1beta1/information-standard-versions/_paths/information-standard-versions#description.md +++ b/src/v1beta1/information-standard-versions/_paths/information-standard-versions#description.md @@ -44,75 +44,83 @@ This causes results to be sorted by `publishTime` in descending order (from most The following table lists the field names and operators you can use in a filter expression. -| Field | Type | Operator | Example | -|-------------------------|-------------------------|----------|-----------------------------------------------------------------------------| -| `id` | `uuid` | `eq` | `?filter=eq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | -| | | `neq` | `?filter=neq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | -| `name` | `string` | `eq` | `?filter=eq(name,"1.2.0")` | -| | | `neq` | `?filter=neq(name,"1.2.0")` | -| | | `has` | `?filter=has(name,"1.2")` | -| | | `stw` | `?filter=stw(name,"1.2")` | -| | | `enw` | `?filter=enw(name,"2.0")` | -| | | `reg` | `?filter=reg(name,"^[a-zA-Z0-9 ]+$")` | -| `description` | `string` | `eq` | `?filter=eq(description,"1.2.0")` | -| | | `neq` | `?filter=neq(description,"1.2.0")` | -| | | `has` | `?filter=has(description,"1.2")` | -| | | `stw` | `?filter=stw(description,"1.2")` | -| | | `enw` | `?filter=enw(description,"2.0")` | -| | | `reg` | `?filter=reg(description,"^[a-zA-Z0-9 ]+$")` | -| `informationStandardId` | `uuid` | `eq` | `?filter=eq(informationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856")` | -| | | `neq` | `?filter=neq(informationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856")` | -| `publishTime` | `date-time` | `eq` | `?filter=eq(publishTime,"2024-03-16T14:15:30.500Z")` | -| | | `neq` | `?filter=neq(publishTime,"2024-03-16T14:15:30.500Z")` | -| | | `gt` | `?filter=gt(publishTime,"2024-03-16T14:15:30.500Z")` | -| | | `gte` | `?filter=gte(publishTime,"2024-03-16T14:15:30.500Z")` | -| | | `lt` | `?filter=lt(publishTime,"2024-03-16T14:15:30.500Z")` | -| | | `lte` | `?filter=lte(publishTime,"2024-03-16T14:15:30.500Z")` | -| `semVer.major` | `integer` | `eq` | `?filter=eq(semVer.major,1)` | -| | | `neq` | `?filter=neq(semVer.major,1)` | -| | | `gt` | `?filter=gt(semVer.major,1)` | -| | | `gte` | `?filter=gte(semVer.major,1)` | -| | | `lt` | `?filter=lt(semVer.major,1)` | -| | | `lte` | `?filter=lte(semVer.major,1)` | -| `semVer.minor` | `integer` | `eq` | `?filter=eq(semVer.minor,2)` | -| | | `neq` | `?filter=neq(semVer.minor,2)` | -| | | `gt` | `?filter=gt(semVer.minor,2)` | -| | | `gte` | `?filter=gte(semVer.minor,2)` | -| | | `lt` | `?filter=lt(semVer.minor,2)` | -| | | `lte` | `?filter=lte(semVer.minor,2)` | -| `semVer.patch` | `integer` | `eq` | `?filter=eq(semVer.patch,0)` | -| | | `neq` | `?filter=neq(semVer.patch,0)` | -| | | `gt` | `?filter=gt(semVer.patch,0)` | -| | | `gte` | `?filter=gte(semVer.patch,0)` | -| | | `lt` | `?filter=lt(semVer.patch,0)` | -| | | `lte` | `?filter=lte(semVer.patch,0)` | -| `semVer.preRelease` | `string` | `eq` | `?filter=eq(semVer.preRelease,"beta")` | -| | | `neq` | `?filter=neq(semVer.preRelease,"beta")` | -| | | `has` | `?filter=has(semVer.preRelease,"be")` | -| | | `stw` | `?filter=stw(semVer.preRelease,"be")` | -| | | `enw` | `?filter=enw(semVer.preRelease,"ta")` | -| | | `reg` | `?filter=reg(semVer.preRelease,"^[a-zA-Z0-9 ]+$")` | -| `semVer.build` | `string` | `eq` | `?filter=eq(semVer.build,"exp.sha.5114f85")` | -| | | `neq` | `?filter=neq(semVer.build,"exp.sha.5114f85")` | -| | | `has` | `?filter=has(semVer.build,"exp.sha")` | -| | | `stw` | `?filter=stw(semVer.build,"exp.sha")` | -| | | `enw` | `?filter=enw(semVer.build,"5114f85")` | -| | | `reg` | `?filter=reg(semVer.build,"^[a-zA-Z0-9 ]+$")` | -| `lifecycleState` | `ProductLifecycleState` | `eq` | `?filter=eq(lifecycleState,"PUBLISHED")` | -| | | `neq` | `?filter=neq(lifecycleState,"PUBLISHED")` | -| `careTypes.$it` | `CareType` | `eq` | `?filter=any(careTypes,eq($it,"GENERAL_PRACTITIONERS"))` | -| | | `neq` | `?filter=all(careTypes,neq($it,"GENERAL_PRACTITIONERS"))` | -| `createTime` | `date-time` | `eq` | `?filter=eq(createTime,"2024-03-16T14:15:30.500Z")` | -| | | `neq` | `?filter=neq(createTime,"2024-03-16T14:15:30.500Z")` | -| | | `gt` | `?filter=gt(createTime,"2024-03-16T14:15:30.500Z")` | -| | | `gte` | `?filter=gte(createTime,"2024-03-16T14:15:30.500Z")` | -| | | `lt` | `?filter=lt(createTime,"2024-03-16T14:15:30.500Z")` | -| | | `lte` | `?filter=lte(createTime,"2024-03-16T14:15:30.500Z")` | -| `updateTime` | `date-time` | `eq` | `?filter=eq(updateTime,"2024-03-16T14:15:30.500Z")` | -| | | `neq` | `?filter=neq(updateTime,"2024-03-16T14:15:30.500Z")` | -| | | `gt` | `?filter=gt(updateTime,"2024-03-16T14:15:30.500Z")` | -| | | `gte` | `?filter=gte(updateTime,"2024-03-16T14:15:30.500Z")` | -| | | `lt` | `?filter=lt(updateTime,"2024-03-16T14:15:30.500Z")` | -| | | `lte` | `?filter=lte(updateTime,"2024-03-16T14:15:30.500Z")` | +| Field | Type | Operator | Example | +|-------------------------------------------------------------|-------------------------|----------|----------------------------------------------------------------------------------------------------------------------| +| `id` | `uuid` | `eq` | `?filter=eq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | +| | | `neq` | `?filter=neq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | +| `name` | `string` | `eq` | `?filter=eq(name,"1.2.0")` | +| | | `neq` | `?filter=neq(name,"1.2.0")` | +| | | `has` | `?filter=has(name,"1.2")` | +| | | `stw` | `?filter=stw(name,"1.2")` | +| | | `enw` | `?filter=enw(name,"2.0")` | +| | | `reg` | `?filter=reg(name,"^[a-zA-Z0-9 ]+$")` | +| `description` | `string` | `eq` | `?filter=eq(description,"1.2.0")` | +| | | `neq` | `?filter=neq(description,"1.2.0")` | +| | | `has` | `?filter=has(description,"1.2")` | +| | | `stw` | `?filter=stw(description,"1.2")` | +| | | `enw` | `?filter=enw(description,"2.0")` | +| | | `reg` | `?filter=reg(description,"^[a-zA-Z0-9 ]+$")` | +| `informationStandardId` | `uuid` | `eq` | `?filter=eq(informationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856")` | +| | | `neq` | `?filter=neq(informationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856")` | +| `publishTime` | `date-time` | `eq` | `?filter=eq(publishTime,"2024-03-16T14:15:30.500Z")` | +| | | `neq` | `?filter=neq(publishTime,"2024-03-16T14:15:30.500Z")` | +| | | `gt` | `?filter=gt(publishTime,"2024-03-16T14:15:30.500Z")` | +| | | `gte` | `?filter=gte(publishTime,"2024-03-16T14:15:30.500Z")` | +| | | `lt` | `?filter=lt(publishTime,"2024-03-16T14:15:30.500Z")` | +| | | `lte` | `?filter=lte(publishTime,"2024-03-16T14:15:30.500Z")` | +| `semVer.major` | `integer` | `eq` | `?filter=eq(semVer.major,1)` | +| | | `neq` | `?filter=neq(semVer.major,1)` | +| | | `gt` | `?filter=gt(semVer.major,1)` | +| | | `gte` | `?filter=gte(semVer.major,1)` | +| | | `lt` | `?filter=lt(semVer.major,1)` | +| | | `lte` | `?filter=lte(semVer.major,1)` | +| `semVer.minor` | `integer` | `eq` | `?filter=eq(semVer.minor,2)` | +| | | `neq` | `?filter=neq(semVer.minor,2)` | +| | | `gt` | `?filter=gt(semVer.minor,2)` | +| | | `gte` | `?filter=gte(semVer.minor,2)` | +| | | `lt` | `?filter=lt(semVer.minor,2)` | +| | | `lte` | `?filter=lte(semVer.minor,2)` | +| `semVer.patch` | `integer` | `eq` | `?filter=eq(semVer.patch,0)` | +| | | `neq` | `?filter=neq(semVer.patch,0)` | +| | | `gt` | `?filter=gt(semVer.patch,0)` | +| | | `gte` | `?filter=gte(semVer.patch,0)` | +| | | `lt` | `?filter=lt(semVer.patch,0)` | +| | | `lte` | `?filter=lte(semVer.patch,0)` | +| `semVer.preRelease` | `string` | `eq` | `?filter=eq(semVer.preRelease,"beta")` | +| | | `neq` | `?filter=neq(semVer.preRelease,"beta")` | +| | | `has` | `?filter=has(semVer.preRelease,"be")` | +| | | `stw` | `?filter=stw(semVer.preRelease,"be")` | +| | | `enw` | `?filter=enw(semVer.preRelease,"ta")` | +| | | `reg` | `?filter=reg(semVer.preRelease,"^[a-zA-Z0-9 ]+$")` | +| `semVer.build` | `string` | `eq` | `?filter=eq(semVer.build,"exp.sha.5114f85")` | +| | | `neq` | `?filter=neq(semVer.build,"exp.sha.5114f85")` | +| | | `has` | `?filter=has(semVer.build,"exp.sha")` | +| | | `stw` | `?filter=stw(semVer.build,"exp.sha")` | +| | | `enw` | `?filter=enw(semVer.build,"5114f85")` | +| | | `reg` | `?filter=reg(semVer.build,"^[a-zA-Z0-9 ]+$")` | +| `lifecycleState` | `ProductLifecycleState` | `eq` | `?filter=eq(lifecycleState,"PUBLISHED")` | +| | | `neq` | `?filter=neq(lifecycleState,"PUBLISHED")` | +| `careTypes.$it` | `CareType` | `eq` | `?filter=any(careTypes,eq($it,"GENERAL_PRACTITIONERS"))` | +| | | `neq` | `?filter=all(careTypes,neq($it,"GENERAL_PRACTITIONERS"))` | +| `communicationStandardVersions.$it.id` | `uuid` | `eq` | `?filter=any(communicationStandardVersions,eq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | +| | | `neq` | `?filter=all(communicationStandardVersions,neq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | +| `communicationStandardVersions.$it.communicationStandardId` | `uuid` | `eq` | `?filter=any(communicationStandardVersions,eq($it.communicationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | +| | | `neq` | `?filter=all(communicationStandardVersions,neq($it.communicationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | +| `trustFrameworkVersions.$it.id` | `uuid` | `eq` | `?filter=any(trustFrameworkVersions,eq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | +| | | `neq` | `?filter=all(trustFrameworkVersions,neq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | +| `trustFrameworkVersions.$it.trustFrameworkId` | `uuid` | `eq` | `?filter=any(trustFrameworkVersions,eq($it.trustFrameworkId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | +| | | `neq` | `?filter=all(trustFrameworkVersions,neq($it.trustFrameworkId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | +| `createTime` | `date-time` | `eq` | `?filter=eq(createTime,"2024-03-16T14:15:30.500Z")` | +| | | `neq` | `?filter=neq(createTime,"2024-03-16T14:15:30.500Z")` | +| | | `gt` | `?filter=gt(createTime,"2024-03-16T14:15:30.500Z")` | +| | | `gte` | `?filter=gte(createTime,"2024-03-16T14:15:30.500Z")` | +| | | `lt` | `?filter=lt(createTime,"2024-03-16T14:15:30.500Z")` | +| | | `lte` | `?filter=lte(createTime,"2024-03-16T14:15:30.500Z")` | +| `updateTime` | `date-time` | `eq` | `?filter=eq(updateTime,"2024-03-16T14:15:30.500Z")` | +| | | `neq` | `?filter=neq(updateTime,"2024-03-16T14:15:30.500Z")` | +| | | `gt` | `?filter=gt(updateTime,"2024-03-16T14:15:30.500Z")` | +| | | `gte` | `?filter=gte(updateTime,"2024-03-16T14:15:30.500Z")` | +| | | `lt` | `?filter=lt(updateTime,"2024-03-16T14:15:30.500Z")` | +| | | `lte` | `?filter=lte(updateTime,"2024-03-16T14:15:30.500Z")` | \ No newline at end of file diff --git a/src/v1beta1/information-standard-versions/_schemas/InformationStandardVersion.yaml b/src/v1beta1/information-standard-versions/_schemas/InformationStandardVersion.yaml index 05cc847..c8c2c7e 100644 --- a/src/v1beta1/information-standard-versions/_schemas/InformationStandardVersion.yaml +++ b/src/v1beta1/information-standard-versions/_schemas/InformationStandardVersion.yaml @@ -80,4 +80,12 @@ properties: $ref: '../../_schemas/CareType.yaml' examples: - - - GENERAL_PRACTITIONERS \ No newline at end of file + - GENERAL_PRACTITIONERS + communicationStandardVersions: + type: array + items: + $ref: '../../communication-standard-versions/_schemas/BasicCommunicationStandardVersion.yaml' + trustFrameworkVersions: + type: array + items: + $ref: '../../trust-framework-versions/_schemas/BasicTrustFrameworkVersion.yaml' \ No newline at end of file diff --git a/src/v1beta1/information-standard-versions/_schemas/InformationStandardVersion_Update.yaml b/src/v1beta1/information-standard-versions/_schemas/InformationStandardVersion_Update.yaml index 23cc88e..c183967 100644 --- a/src/v1beta1/information-standard-versions/_schemas/InformationStandardVersion_Update.yaml +++ b/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 \ No newline at end of file diff --git a/src/v1beta1/information-standard-versions/communication-standard-versions/_paths/communication-standard-versions_{communicationStandardVersionId}.yaml b/src/v1beta1/information-standard-versions/communication-standard-versions/_paths/communication-standard-versions_{communicationStandardVersionId}.yaml new file mode 100644 index 0000000..a6915a2 --- /dev/null +++ b/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' \ No newline at end of file diff --git a/src/v1beta1/information-standard-versions/trust-framework-versions/_paths/trust-framework-versions_{trustFrameworkVersionId}.yaml b/src/v1beta1/information-standard-versions/trust-framework-versions/_paths/trust-framework-versions_{trustFrameworkVersionId}.yaml new file mode 100644 index 0000000..87c31d2 --- /dev/null +++ b/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' \ No newline at end of file diff --git a/src/v1beta1/information-standards/_paths/information-standards#description.md b/src/v1beta1/information-standards/_paths/information-standards#description.md index ecf7841..c23046f 100644 --- a/src/v1beta1/information-standards/_paths/information-standards#description.md +++ b/src/v1beta1/information-standards/_paths/information-standards#description.md @@ -32,39 +32,47 @@ This causes results to be sorted by `createTime` in descending order (from most The following table lists the field names and operators you can use in a filter expression. -| Field | Type | Operator | Example | -|------------------------------|-------------------------|----------|-----------------------------------------------------------------------| -| `id` | `uuid` | `eq` | `?filter=eq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | -| | | `neq` | `?filter=neq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | -| `name` | `string` | `eq` | `?filter=eq(name,"MedMij Huisartsgegevens")` | -| | | `neq` | `?filter=neq(name,"MedMij Huisartsgegevens")` | -| | | `has` | `?filter=has(name,"MedMij")` | -| | | `stw` | `?filter=stw(name,"MedMij")` | -| | | `enw` | `?filter=enw(name,"Huisartsgegevens")` | -| | | `reg` | `?filter=reg(name,"^[a-zA-Z0-9 ]+$")` | -| `description` | `string` | `eq` | `?filter=eq(description,"MedMij Huisartsgegevens")` | -| | | `neq` | `?filter=neq(description,"MedMij Huisartsgegevens")` | -| | | `has` | `?filter=has(description,"MedMij")` | -| | | `stw` | `?filter=stw(description,"MedMij")` | -| | | `enw` | `?filter=enw(description,"Huisartsgegevens")` | -| | | `reg` | `?filter=reg(description,"^[a-zA-Z0-9 ]+$")` | -| `organizationId` | `uuid` | `eq` | `?filter=eq(organizationId,"533d3fe3-bccc-405a-9904-4f516e892856")` | -| | | `neq` | `?filter=neq(organizationId,"533d3fe3-bccc-405a-9904-4f516e892856")` | -| `mainVersion.lifecycleState` | `ProductLifecycleState` | `eq` | `?filter=eq(mainVersion.lifecycleState,"PUBLISHED")` | -| | | `neq` | `?filter=neq(mainVersion.lifecycleState,"PUBLISHED")` | -| `mainVersion.careTypes.$it` | `CareType` | `eq` | `?filter=any(mainVersion.careTypes,eq($it,"GENERAL_PRACTITIONERS"))` | -| | | `neq` | `?filter=all(mainVersion.careTypes,neq($it,"GENERAL_PRACTITIONERS"))` | -| `createTime` | `date-time` | `eq` | `?filter=eq(createTime,"2024-03-16T14:15:30.500Z")` | -| | | `neq` | `?filter=neq(createTime,"2024-03-16T14:15:30.500Z")` | -| | | `gt` | `?filter=gt(createTime,"2024-03-16T14:15:30.500Z")` | -| | | `gte` | `?filter=gte(createTime,"2024-03-16T14:15:30.500Z")` | -| | | `lt` | `?filter=lt(createTime,"2024-03-16T14:15:30.500Z")` | -| | | `lte` | `?filter=lte(createTime,"2024-03-16T14:15:30.500Z")` | -| `updateTime` | `date-time` | `eq` | `?filter=eq(updateTime,"2024-03-16T14:15:30.500Z")` | -| | | `neq` | `?filter=neq(updateTime,"2024-03-16T14:15:30.500Z")` | -| | | `gt` | `?filter=gt(updateTime,"2024-03-16T14:15:30.500Z")` | -| | | `gte` | `?filter=gte(updateTime,"2024-03-16T14:15:30.500Z")` | -| | | `lt` | `?filter=lt(updateTime,"2024-03-16T14:15:30.500Z")` | -| | | `lte` | `?filter=lte(updateTime,"2024-03-16T14:15:30.500Z")` | +| Field | Type | Operator | Example | +|-------------------------------------------------------------------------|-------------------------|----------|----------------------------------------------------------------------------------------------------------------------------------| +| `id` | `uuid` | `eq` | `?filter=eq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | +| | | `neq` | `?filter=neq(id,"533d3fe3-bccc-405a-9904-4f516e892856")` | +| `name` | `string` | `eq` | `?filter=eq(name,"MedMij Huisartsgegevens")` | +| | | `neq` | `?filter=neq(name,"MedMij Huisartsgegevens")` | +| | | `has` | `?filter=has(name,"MedMij")` | +| | | `stw` | `?filter=stw(name,"MedMij")` | +| | | `enw` | `?filter=enw(name,"Huisartsgegevens")` | +| | | `reg` | `?filter=reg(name,"^[a-zA-Z0-9 ]+$")` | +| `description` | `string` | `eq` | `?filter=eq(description,"MedMij Huisartsgegevens")` | +| | | `neq` | `?filter=neq(description,"MedMij Huisartsgegevens")` | +| | | `has` | `?filter=has(description,"MedMij")` | +| | | `stw` | `?filter=stw(description,"MedMij")` | +| | | `enw` | `?filter=enw(description,"Huisartsgegevens")` | +| | | `reg` | `?filter=reg(description,"^[a-zA-Z0-9 ]+$")` | +| `organizationId` | `uuid` | `eq` | `?filter=eq(organizationId,"533d3fe3-bccc-405a-9904-4f516e892856")` | +| | | `neq` | `?filter=neq(organizationId,"533d3fe3-bccc-405a-9904-4f516e892856")` | +| `mainVersion.lifecycleState` | `ProductLifecycleState` | `eq` | `?filter=eq(mainVersion.lifecycleState,"PUBLISHED")` | +| | | `neq` | `?filter=neq(mainVersion.lifecycleState,"PUBLISHED")` | +| `mainVersion.careTypes.$it` | `CareType` | `eq` | `?filter=any(mainVersion.careTypes,eq($it,"GENERAL_PRACTITIONERS"))` | +| | | `neq` | `?filter=all(mainVersion.careTypes,neq($it,"GENERAL_PRACTITIONERS"))` | +| `mainVersion.communicationStandardVersions.$it.id` | `uuid` | `eq` | `?filter=any(mainVersion.communicationStandardVersions,eq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | +| | | `neq` | `?filter=all(mainVersion.communicationStandardVersions,neq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | +| `mainVersion.communicationStandardVersions.$it.communicationStandardId` | `uuid` | `eq` | `?filter=any(mainVersion.communicationStandardVersions,eq($it.communicationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | +| | | `neq` | `?filter=all(mainVersion.communicationStandardVersions,neq($it.communicationStandardId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | +| `mainVersion.trustFrameworkVersions.$it.id` | `uuid` | `eq` | `?filter=any(mainVersion.trustFrameworkVersions,eq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | +| | | `neq` | `?filter=all(mainVersion.trustFrameworkVersions,neq($it.id,"533d3fe3-bccc-405a-9904-4f516e892856"))` | +| `mainVersion.trustFrameworkVersions.$it.trustFrameworkId` | `uuid` | `eq` | `?filter=any(mainVersion.trustFrameworkVersions,eq($it.trustFrameworkId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | +| | | `neq` | `?filter=all(mainVersion.trustFrameworkVersions,neq($it.trustFrameworkId,"533d3fe3-bccc-405a-9904-4f516e892856"))` | +| `createTime` | `date-time` | `eq` | `?filter=eq(createTime,"2024-03-16T14:15:30.500Z")` | +| | | `neq` | `?filter=neq(createTime,"2024-03-16T14:15:30.500Z")` | +| | | `gt` | `?filter=gt(createTime,"2024-03-16T14:15:30.500Z")` | +| | | `gte` | `?filter=gte(createTime,"2024-03-16T14:15:30.500Z")` | +| | | `lt` | `?filter=lt(createTime,"2024-03-16T14:15:30.500Z")` | +| | | `lte` | `?filter=lte(createTime,"2024-03-16T14:15:30.500Z")` | +| `updateTime` | `date-time` | `eq` | `?filter=eq(updateTime,"2024-03-16T14:15:30.500Z")` | +| | | `neq` | `?filter=neq(updateTime,"2024-03-16T14:15:30.500Z")` | +| | | `gt` | `?filter=gt(updateTime,"2024-03-16T14:15:30.500Z")` | +| | | `gte` | `?filter=gte(updateTime,"2024-03-16T14:15:30.500Z")` | +| | | `lt` | `?filter=lt(updateTime,"2024-03-16T14:15:30.500Z")` | +| | | `lte` | `?filter=lte(updateTime,"2024-03-16T14:15:30.500Z")` | \ No newline at end of file diff --git a/src/v1beta1/openapi.yaml b/src/v1beta1/openapi.yaml index c3f2ff0..1d418f6 100644 --- a/src/v1beta1/openapi.yaml +++ b/src/v1beta1/openapi.yaml @@ -89,6 +89,12 @@ tags: - name: information-standard-versions description: Information standard versions API x-displayName: Information standard versions + - name: information-standard-versions.communication-standard-versions + description: Information standard version communication standard versions API + x-displayName: Information standard version communication standard versions + - name: information-standard-versions.trust-framework-versions + description: Information standard version trust framework versions API + x-displayName: Information standard version trust framework versions # trust-frameworks - name: trust-frameworks @@ -132,6 +138,8 @@ x-tagGroups: tags: - information-standards - information-standard-versions + - information-standard-versions.communication-standard-versions + - information-standard-versions.trust-framework-versions - name: Trust frameworks tags: - trust-frameworks @@ -242,6 +250,12 @@ paths: $ref: './information-standard-versions/_paths/information-standard-versions.yaml' /information-standard-versions/{informationStandardVersionId}: $ref: './information-standard-versions/_paths/information-standard-versions_{informationStandardVersionId}.yaml' + # information-standard-versions/communication-standard-versions + /information-standard-versions/{informationStandardVersionId}/communication-standard-versions/{communicationStandardVersionId}: + $ref: './information-standard-versions/communication-standard-versions/_paths/communication-standard-versions_{communicationStandardVersionId}.yaml' + # information-standard-versions/trust-framework-versions + /information-standard-versions/{informationStandardVersionId}/trust-framework-versions/{trustFrameworkVersionId}: + $ref: './information-standard-versions/trust-framework-versions/_paths/trust-framework-versions_{trustFrameworkVersionId}.yaml' # trust-frameworks /trust-frameworks: