regenerate docs (codegen and SPECITS-66)

Author: sebastian-iancu

computable/OAS/definition-codegen.openapi.yaml

@@ -192,7 +192,7 @@ info:
 
     ### Status
 
-    This specification is in the `STABLE` state, and can be downloaded as [OpenAPI specification](https://spec.openapis.org/oas/v3.0.3) file (in yaml format) [for validation](computable/OAS/definition-validation.openapi.yaml), or [for code generators](computable/OAS/definition-codegen.openapi.yaml).
+    This specification is in the `STABLE` state, and can be downloaded as [OpenAPI specification](https://spec.openapis.org/oas/v3.0.3) file (in YAML format) [for validation](computable/OAS/definition-validation.openapi.yaml), or [for code generators](computable/OAS/definition-codegen.openapi.yaml).
     Users are encouraged to comment on and/or advise on these paragraphs as well as the main content.
 
     The development version of this document can be found at <https://specifications.openehr.org/releases/ITS-REST/latest/definition.html>.
@@ -538,31 +538,27 @@ tags:
   - name: TemplateList_schema
     x-displayName: Template list
     description: |
-      This represents a list of Template meta information associated with uploaded templates.
+      This resource represents the list of `Template` meta-information associated with uploaded templates - see also [Service Model - Definition Package](https://specifications.openehr.org/releases/SM/latest/openehr_platform.html#_definition_package).
 
       <SchemaDefinition schemaRef="#/components/schemas/TemplateList" />
   - name: Template_schema
     x-displayName: Template
     description: |
-      This is related to [AOM and ADL 1.4](https://specifications.openehr.org/releases/AM/latest) Operational Templates (OPTs) and [AOM2](https://specifications.openehr.org/releases/AM/latest/AOM2.html#_templates) templates.
-
-      ## AOM/ADL 1.4 OPERATIONAL_TEMPLATE
+      The following resources are formally specified in the [Archetype Model](https://specifications.openehr.org/releases/AM/latest) as AOM/ADL 1.4 Operational Templates (OPTs) and as [AOM2 templates](https://specifications.openehr.org/releases/AM/latest/AOM2.html#_templates).
+      <div class="mb-5"></div>
 
+      The AOM/ADL 1.4 `OPERATIONAL_TEMPLATE` resource:
       <SchemaDefinition schemaRef="#/components/schemas/OperationalTemplate" />
 
-      ## AOM/ADL 2 OPERATIONAL_TEMPLATE
-
+      The AOM/ADL 2 `OPERATIONAL_TEMPLATE` resource:
       <SchemaDefinition schemaRef="#/components/schemas/OperationalTemplateV2" />
 
-      ## Web Template
-
+      The `WebTemplate` alternative resource:
       <SchemaDefinition schemaRef="#/components/schemas/WebTemplate" />
   - name: StoredQuery_schema
     x-displayName: Stored Query
     description: |
-      The following schemas are also related to [AQL queries](https://specifications.openehr.org/releases/QUERY/latest/AQL.html).
-
-      ### Stored Query schema
+      This resource represents the definition of a stored Query and is formally specified in the Service Model as [Registered Queries](https://specifications.openehr.org/releases/SM/latest/openehr_platform.html#_registered_queries).
 
       <SchemaDefinition schemaRef="#/components/schemas/StoredQuery" />
 x-tagGroups:

computable/OAS/definition-validation.openapi.yaml

@@ -192,7 +192,7 @@ info:
 
     ### Status
 
-    This specification is in the `STABLE` state, and can be downloaded as [OpenAPI specification](https://spec.openapis.org/oas/v3.0.3) file (in yaml format) [for validation](computable/OAS/definition-validation.openapi.yaml), or [for code generators](computable/OAS/definition-codegen.openapi.yaml).
+    This specification is in the `STABLE` state, and can be downloaded as [OpenAPI specification](https://spec.openapis.org/oas/v3.0.3) file (in YAML format) [for validation](computable/OAS/definition-validation.openapi.yaml), or [for code generators](computable/OAS/definition-codegen.openapi.yaml).
     Users are encouraged to comment on and/or advise on these paragraphs as well as the main content.
 
     The development version of this document can be found at <https://specifications.openehr.org/releases/ITS-REST/latest/definition.html>.
@@ -538,31 +538,27 @@ tags:
   - name: TemplateList_schema
     x-displayName: Template list
     description: |
-      This represents a list of Template meta information associated with uploaded templates.
+      This resource represents the list of `Template` meta-information associated with uploaded templates - see also [Service Model - Definition Package](https://specifications.openehr.org/releases/SM/latest/openehr_platform.html#_definition_package).
 
       <SchemaDefinition schemaRef="#/components/schemas/TemplateList" />
   - name: Template_schema
     x-displayName: Template
     description: |
-      This is related to [AOM and ADL 1.4](https://specifications.openehr.org/releases/AM/latest) Operational Templates (OPTs) and [AOM2](https://specifications.openehr.org/releases/AM/latest/AOM2.html#_templates) templates.
-
-      ## AOM/ADL 1.4 OPERATIONAL_TEMPLATE
+      The following resources are formally specified in the [Archetype Model](https://specifications.openehr.org/releases/AM/latest) as AOM/ADL 1.4 Operational Templates (OPTs) and as [AOM2 templates](https://specifications.openehr.org/releases/AM/latest/AOM2.html#_templates).
+      <div class="mb-5"></div>
 
+      The AOM/ADL 1.4 `OPERATIONAL_TEMPLATE` resource:
       <SchemaDefinition schemaRef="#/components/schemas/OperationalTemplate" />
 
-      ## AOM/ADL 2 OPERATIONAL_TEMPLATE
-
+      The AOM/ADL 2 `OPERATIONAL_TEMPLATE` resource:
       <SchemaDefinition schemaRef="#/components/schemas/OperationalTemplateV2" />
 
-      ## Web Template
-
+      The `WebTemplate` alternative resource:
       <SchemaDefinition schemaRef="#/components/schemas/WebTemplate" />
   - name: StoredQuery_schema
     x-displayName: Stored Query
     description: |
-      The following schemas are also related to [AQL queries](https://specifications.openehr.org/releases/QUERY/latest/AQL.html).
-
-      ### Stored Query schema
+      This resource represents the definition of a stored Query and is formally specified in the Service Model as [Registered Queries](https://specifications.openehr.org/releases/SM/latest/openehr_platform.html#_registered_queries).
 
       <SchemaDefinition schemaRef="#/components/schemas/StoredQuery" />
 x-tagGroups:

computable/OAS/ehr-codegen.openapi.yaml

@@ -202,7 +202,7 @@ info:
 
     ### Status
 
-    This specification is in the `STABLE` state, and can be downloaded as [OpenAPI specification](https://spec.openapis.org/oas/v3.0.3) file (in yaml format) [for validation](computable/OAS/ehr-validation.openapi.yaml), or [for code generators](computable/OAS/ehr-codegen.openapi.yaml).
+    This specification is in the `STABLE` state, and can be downloaded as [OpenAPI specification](https://spec.openapis.org/oas/v3.0.3) file (in YAML format) [for validation](computable/OAS/ehr-validation.openapi.yaml), or [for code generators](computable/OAS/ehr-codegen.openapi.yaml).
     Users are encouraged to comment on and/or advise on these paragraphs as well as the main content.
 
     The development version of this document can be found at <https://specifications.openehr.org/releases/ITS-REST/latest/ehr.html>.
@@ -838,40 +838,53 @@ tags:
   - name: EHR_schema
     x-displayName: EHR
     description: |
-      This is related to [EHR](https://specifications.openehr.org/releases/RM/latest/ehr.html#_ehr_class).
+      This resource is formally specified in Reference Model as the [EHR](https://specifications.openehr.org/releases/RM/latest/ehr.html#_ehr_class) class.
 
       <SchemaDefinition schemaRef="#/components/schemas/Ehr" />
   - name: EHR_STATUS_schema
     x-displayName: EHR_STATUS
     description: |
-      This is related to [EHR_STATUS](https://specifications.openehr.org/releases/RM/latest/ehr.html#_ehr_status_class) and [VERSIONED_EHR_STATUS](https://specifications.openehr.org/releases/RM/latest/ehr.html#_versioned_ehr_status_class).
+      The following resources are formally specified in the Reference Model as [EHR_STATUS](https://specifications.openehr.org/releases/RM/latest/ehr.html#_ehr_status_class) and [VERSIONED_EHR_STATUS](https://specifications.openehr.org/releases/RM/latest/ehr.html#_versioned_ehr_status_class) classes.
+      <div class="mb-5"></div>
 
+      The `EHR_STATUS` resource:
       <SchemaDefinition schemaRef="#/components/schemas/EhrStatus" />
+
+      The `VERSIONED_EHR_STATUS` resource:
       <SchemaDefinition schemaRef="#/components/schemas/VersionedEhrStatus" />
   - name: COMPOSITION_schema
     x-displayName: COMPOSITION
     description: |
-      This is related to [COMPOSITION](https://specifications.openehr.org/releases/RM/latest/ehr.html#_composition_class) and [VERSIONED_COMPOSITION](https://specifications.openehr.org/releases/RM/latest/ehr.html#_versioned_composition_class).
+      The following resources are formally specified in the Reference Model as [COMPOSITION](https://specifications.openehr.org/releases/RM/latest/ehr.html#_composition_class) and [VERSIONED_COMPOSITION](https://specifications.openehr.org/releases/RM/latest/ehr.html#_versioned_composition_class) classes.
+      <div class="mb-5"></div>
 
+      The `COMPOSITION` resource:
       <SchemaDefinition schemaRef="#/components/schemas/Composition" />
+
+      The abstract `CONTENT_ITEM` class, used in `COMPOSITION`:
+      <SchemaDefinition schemaRef="#/components/schemas/ContentItem" />
+
+      The abstract `ITEM_STRUCTURE` class, used in `CONTENT_ITEM`:
+      <SchemaDefinition schemaRef="#/components/schemas/ItemStructure" />
+
+      The `VERSIONED_COMPOSITION` resource:
       <SchemaDefinition schemaRef="#/components/schemas/VersionedComposition" />
   - name: DIRECTORY_schema
     x-displayName: DIRECTORY
     description: |
-      This is related to [directory](https://specifications.openehr.org/releases/RM/latest/ehr.html#_directory) [FOLDER](https://specifications.openehr.org/releases/RM/latest/common.html#_folder_class).
+      This resource is formally specified in Reference Model in the [directory](https://specifications.openehr.org/releases/RM/latest/ehr.html#_directory) section, using [FOLDER](https://specifications.openehr.org/releases/RM/latest/common.html#_folder_class) class.
 
       <SchemaDefinition schemaRef="#/components/schemas/Folder" />
-  - name: ITEM_STRUCTURE_schema
-    x-displayName: ITEM_STRUCTURE
-    description: |
-      This is related to [ITEM_STRUCTURE](https://specifications.openehr.org/releases/RM/latest/data_structures.html#_item_structure_class).
-
-      <SchemaDefinition schemaRef="#/components/schemas/ItemStructure" />
   - name: CONTRIBUTION_schema
     x-displayName: CONTRIBUTION
     description: |
-      This is related to [CONTRIBUTION](https://specifications.openehr.org/releases/RM/latest/common.html#_contribution_class).
+      The following resources are formally specified in the Reference Model as the [CONTRIBUTION](https://specifications.openehr.org/releases/RM/latest/common.html#_contribution_class) class.
+      <div class="mb-5"></div>
+
+      A new `CONTRIBUTION` to be committed:
+      <SchemaDefinition schemaRef="#/components/schemas/NewContribution" />
 
+      A retrieved `CONTRIBUTION`:
       <SchemaDefinition schemaRef="#/components/schemas/Contribution" />
 x-tagGroups:
   - name: Resource endpoints
@@ -887,7 +900,6 @@ x-tagGroups:
       - EHR_STATUS_schema
       - COMPOSITION_schema
       - DIRECTORY_schema
-      - ITEM_STRUCTURE_schema
       - CONTRIBUTION_schema
 components:
   schemas:
@@ -2185,7 +2197,9 @@ components:
       discriminator:
         propertyName: _type
         mapping:
+          ENTRY: '#/components/schemas/AbstractEntry'
           ADMIN_ENTRY: '#/components/schemas/AdminEntry'
+          CARE_ENTRY: '#/components/schemas/CareEntry'
           OBSERVATION: '#/components/schemas/Observation'
           EVALUATION: '#/components/schemas/Evaluation'
           INSTRUCTION: '#/components/schemas/Instruction'
@@ -2218,6 +2232,7 @@ components:
         propertyName: _type
         mapping:
           ADMIN_ENTRY: '#/components/schemas/AdminEntry'
+          CARE_ENTRY: '#/components/schemas/CareEntry'
           OBSERVATION: '#/components/schemas/Observation'
           EVALUATION: '#/components/schemas/Evaluation'
           INSTRUCTION: '#/components/schemas/Instruction'

computable/OAS/ehr-validation.openapi.yaml

@@ -202,7 +202,7 @@ info:
 
     ### Status
 
-    This specification is in the `STABLE` state, and can be downloaded as [OpenAPI specification](https://spec.openapis.org/oas/v3.0.3) file (in yaml format) [for validation](computable/OAS/ehr-validation.openapi.yaml), or [for code generators](computable/OAS/ehr-codegen.openapi.yaml).
+    This specification is in the `STABLE` state, and can be downloaded as [OpenAPI specification](https://spec.openapis.org/oas/v3.0.3) file (in YAML format) [for validation](computable/OAS/ehr-validation.openapi.yaml), or [for code generators](computable/OAS/ehr-codegen.openapi.yaml).
     Users are encouraged to comment on and/or advise on these paragraphs as well as the main content.
 
     The development version of this document can be found at <https://specifications.openehr.org/releases/ITS-REST/latest/ehr.html>.
@@ -838,40 +838,53 @@ tags:
   - name: EHR_schema
     x-displayName: EHR
     description: |
-      This is related to [EHR](https://specifications.openehr.org/releases/RM/latest/ehr.html#_ehr_class).
+      This resource is formally specified in Reference Model as the [EHR](https://specifications.openehr.org/releases/RM/latest/ehr.html#_ehr_class) class.
 
       <SchemaDefinition schemaRef="#/components/schemas/Ehr" />
   - name: EHR_STATUS_schema
     x-displayName: EHR_STATUS
     description: |
-      This is related to [EHR_STATUS](https://specifications.openehr.org/releases/RM/latest/ehr.html#_ehr_status_class) and [VERSIONED_EHR_STATUS](https://specifications.openehr.org/releases/RM/latest/ehr.html#_versioned_ehr_status_class).
+      The following resources are formally specified in the Reference Model as [EHR_STATUS](https://specifications.openehr.org/releases/RM/latest/ehr.html#_ehr_status_class) and [VERSIONED_EHR_STATUS](https://specifications.openehr.org/releases/RM/latest/ehr.html#_versioned_ehr_status_class) classes.
+      <div class="mb-5"></div>
 
+      The `EHR_STATUS` resource:
       <SchemaDefinition schemaRef="#/components/schemas/EhrStatus" />
+
+      The `VERSIONED_EHR_STATUS` resource:
       <SchemaDefinition schemaRef="#/components/schemas/VersionedEhrStatus" />
   - name: COMPOSITION_schema
     x-displayName: COMPOSITION
     description: |
-      This is related to [COMPOSITION](https://specifications.openehr.org/releases/RM/latest/ehr.html#_composition_class) and [VERSIONED_COMPOSITION](https://specifications.openehr.org/releases/RM/latest/ehr.html#_versioned_composition_class).
+      The following resources are formally specified in the Reference Model as [COMPOSITION](https://specifications.openehr.org/releases/RM/latest/ehr.html#_composition_class) and [VERSIONED_COMPOSITION](https://specifications.openehr.org/releases/RM/latest/ehr.html#_versioned_composition_class) classes.
+      <div class="mb-5"></div>
 
+      The `COMPOSITION` resource:
       <SchemaDefinition schemaRef="#/components/schemas/Composition" />
+
+      The abstract `CONTENT_ITEM` class, used in `COMPOSITION`:
+      <SchemaDefinition schemaRef="#/components/schemas/UContentItem" />
+
+      The abstract `ITEM_STRUCTURE` class, used in `CONTENT_ITEM`:
+      <SchemaDefinition schemaRef="#/components/schemas/UItemStructure" />
+
+      The `VERSIONED_COMPOSITION` resource:
       <SchemaDefinition schemaRef="#/components/schemas/VersionedComposition" />
   - name: DIRECTORY_schema
     x-displayName: DIRECTORY
     description: |
-      This is related to [directory](https://specifications.openehr.org/releases/RM/latest/ehr.html#_directory) [FOLDER](https://specifications.openehr.org/releases/RM/latest/common.html#_folder_class).
+      This resource is formally specified in Reference Model in the [directory](https://specifications.openehr.org/releases/RM/latest/ehr.html#_directory) section, using [FOLDER](https://specifications.openehr.org/releases/RM/latest/common.html#_folder_class) class.
 
       <SchemaDefinition schemaRef="#/components/schemas/Folder" />
-  - name: ITEM_STRUCTURE_schema
-    x-displayName: ITEM_STRUCTURE
-    description: |
-      This is related to [ITEM_STRUCTURE](https://specifications.openehr.org/releases/RM/latest/data_structures.html#_item_structure_class).
-
-      <SchemaDefinition schemaRef="#/components/schemas/UItemStructure" />
   - name: CONTRIBUTION_schema
     x-displayName: CONTRIBUTION
     description: |
-      This is related to [CONTRIBUTION](https://specifications.openehr.org/releases/RM/latest/common.html#_contribution_class).
+      The following resources are formally specified in the Reference Model as the [CONTRIBUTION](https://specifications.openehr.org/releases/RM/latest/common.html#_contribution_class) class.
+      <div class="mb-5"></div>
+
+      A new `CONTRIBUTION` to be committed:
+      <SchemaDefinition schemaRef="#/components/schemas/NewContribution" />
 
+      A retrieved `CONTRIBUTION`:
       <SchemaDefinition schemaRef="#/components/schemas/Contribution" />
 x-tagGroups:
   - name: Resource endpoints
@@ -887,13 +900,15 @@ x-tagGroups:
       - EHR_STATUS_schema
       - COMPOSITION_schema
       - DIRECTORY_schema
-      - ITEM_STRUCTURE_schema
       - CONTRIBUTION_schema
 components:
   schemas:
     UAbstractItemStructure:
       title: ITEM_STRUCTURE
       type: object
+    UAbstractContentItem:
+      title: CONTENT_ITEM
+      type: object
     HierObjectId:
       title: HIER_OBJECT_ID
       required: