Skip to content

Commit

Permalink
Merge pull request #102 from openEHR/feature/SPECITS-73-Optimizing_ya…
Browse files Browse the repository at this point in the history 
…ml_specs

SPECITS-73 Optimizing yaml specs
  • Loading branch information
@sebastian-iancu
sebastian-iancu authored Mar 12, 2024
2 parents 3784f89 + aa45982 commit 8a33e2e
Show file tree
Hide file tree
Showing 64 changed files with 12,329 additions and 5,256 deletions.
18 changes: 16 additions & 2 deletions .redocly.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -12,8 +12,22 @@ theme:
hideDownloadButton: true
# https://redocly.com/docs/api-reference-docs/configuration/theming/
theme:
spacing:
unit: 4
sectionHorizontal: 30
sectionVertical: 0
typography:
fontSize: '16px'
smoothing: 'antialiased'
optimizeSpeed: true
headings:
fontFamily: "Source Sans Pro"
fontWeight: "700"
code:
fontSize: "14px"
fontFamily: "monospace"
colors:
tonalOffset: 0.1
tonalOffset: 0.3
sidebar:
width: "300px"
textColor: "#000000"
textColor: "#333333"
205 changes: 2 additions & 203 deletions computable/OAS/definition-codegen.openapi.yaml
View file
Original file line number Diff line number Diff line change
Expand Up @@ -11,164 +11,8 @@ info:
license:
name: Creative Commons Attribution-NoDerivs 3.0 Unported
url: https://creativecommons.org/licenses/by-nd/3.0/
description: |+
<table>
<colgroup>
<col style="width: 20%;">
<col style="width: 80%;">
</colgroup>
<thead>
<tr>
<th colspan="2">© 2018 - 2023 The openEHR Foundation</th>
</tr>
</thead>
<tbody>
<tr>
<td colspan="2">
The <a href="https://www.openEHR.org" target="_blank" rel="noopener">openEHR Foundation</a> is an independent, non-profit foundation, facilitating the sharing of health records by consumers and clinicians via open specifications, clinical models and open platform implementations.
</td>
</tr>
<tr>
<td><strong>Licence</strong></td>
<td><span class="image"><img src="https://specifications.openehr.org/images/cc-by-nd-88x31.png" alt="image"></span> Creative Commons Attribution-NoDerivs 3.0 Unported.
<a href="https://creativecommons.org/licenses/by-nd/3.0/" class="bare">https://creativecommons.org/licenses/by-nd/3.0/</a>
</td>
</tr>
<tr>
<td><strong>Support</strong></td>
<td>Issues: <a href="https://specifications.openehr.org/components/ITS/open_issues" target="_blank" rel="noopener">Problem Reports</a><br>
Web: <a href="https://specifications.openehr.org" target="_blank" rel="noopener">specifications.openEHR.org</a>
</td>
</tr>
</tbody>
</table>
### Amendment Record
<table>
<colgroup>
<col style="width: 9%;">
<col style="width: 55%;">
<col style="width: 18%;">
<col style="width: 18%;">
</colgroup>
<thead>
<tr>
<th>Issue</th>
<th>Details</th>
<th>Raiser, Implementer</th>
<th>Completed</th>
</tr>
</thead>
<tbody>
<tr>
<th colspan="4"><a href="https://specifications.openehr.org/releases/ITS-REST/latest" target="_blank" rel="noopener">Release-1.0.3</a></th>
</tr>
<tr>
<td>5.1</td>
<td><a href="https://specifications.openehr.org/tickets/SPECITS-66" target="_blank" rel="noopener">SPECITS-66</a>:
Migrate REST API specs to 'openAPI' format</td>
<td>S Iancu</td>
<td>19 Dec 2022</td>
</tr>
<tr>
<th colspan="4"><a href="https://specifications.openehr.org/releases/ITS-REST/Release-1.0.2" target="_blank" rel="noopener">Release-1.0.2</a></th>
</tr>
<tr>
<td>4.2</td>
<td><a href="https://specifications.openehr.org/tickets/SPECITS-59" target="_blank" rel="noopener">SPECITS-59</a>:
Specify mimeType used by adl2 template</td>
<td>S Iancu</td>
<td>26 Mar 2021</td>
</tr>
<tr>
<td>4.1</td>
<td><a href="https://specifications.openehr.org/tickets/SPECITS-42" target="_blank" rel="noopener">SPECITS-42</a>:
Fix TEMPLATE_ID value format in examples</td>
<td>S Iancu</td>
<td>21 Mar 2021</td>
</tr>
<tr>
<td>4.1</td>
<td><a href="https://specifications.openehr.org/tickets/SPECITS-41" target="_blank" rel="noopener">SPECITS-41</a>:
Add double quotes to ETag and If-Match headers</td>
<td>S Iancu</td>
<td>21 Mar 2021</td>
</tr>
<tr>
<td>4.0</td>
<td><a href="https://specifications.openehr.org/tickets/SPECITS-57" target="_blank" rel="noopener">SPECITS-57</a>:
Updating request and response examples of GET adl1.4 template in relation with headers about simplified JSON formats</td>
<td>E Sundvall, S Iancu</td>
<td>13 Mar 2021</td>
</tr>
<tr>
<th colspan="4"><a href="https://specifications.openehr.org/releases/ITS-REST/Release-1.0.1" target="_blank" rel="noopener">Release-1.0.1</a></th>
</tr>
<tr>
<td>3.0</td>
<td><a href="https://specifications.openehr.org/tickets/SPECITS-32" target="_blank" rel="noopener">SPECITS-32</a>: Fix typos and minor documentary errors (fixes
<a href="https://specifications.openehr.org/tickets/SPECPR-252" target="_blank" rel="noopener">SPECPR-253</a>,
<a href="https://specifications.openehr.org/tickets/SPECPR-289" target="_blank" rel="noopener">SPECPR-289</a>)</td>
<td>J Smolka, P Pazos, E Sundvall, T Beale, S Iancu</td>
<td>1 Sep 2019</td>
</tr>
<tr>
<td>2.2</td>
<td><a href="https://specifications.openehr.org/tickets/SPECITS-24" target="_blank" rel="noopener">SPECITS-24</a>: Added changelog</td>
<td>J Smolka, S Iancu</td>
<td>12 May 2019</td>
</tr>
<tr>
<td></td>
<td><a href="https://specifications.openehr.org/tickets/SPECITS-25" target="_blank" rel="noopener">SPECITS-25</a>,
<a href="https://specifications.openehr.org/tickets/SPECITS-29" target="_blank" rel="noopener">SPECITS-29</a>: Change layout and structure</td>
<td>J Smolka, S Iancu</td>
<td>12 May 2019</td>
</tr>
<tr>
<td>2.1</td>
<td>Update links to new openEHR specifications website</td>
<td>S Iancu</td>
<td>16 Dec 2018</td>
</tr>
<tr>
<th colspan="4"><a href="https://specifications.openehr.org/releases/ITS-REST/Release-1.0.0" target="_blank" rel="noopener">Release-1.0.0</a></th>
</tr>
</tbody>
</table>
# Intro
## Acknowledgements
### Editor
- Sebastian Iancu, Architect, Code24, Netherlands
### Contributors
This specification benefited from wide formal and informal input from the openEHR and wider health informatics community. The openEHR Foundation would like to recognise the following people for their contributions.
- Birger Haarbrandt, MSc, Peter L. Reichertz Institut for Medical Informatics (PLRI), Germany
- Bjørn Næss, DIPS, Norway
- Bostjan Lah, Senior Architect, Better, Slovenia
- Erik Sundvall, Information Architect at Karolinska University Hospital, Sweden
- Heath Frankel, Ocean Informatics, Australia
- Ian McNicoll MD, FreshEHR, UK
- Jake Smolka, Software Engineer, Better, Slovenia
- Matija Polajnar, PhD, Software Engineer, Better, Slovenia
- Pablo Pazos Gutierrez, Senior engineer, CaboLabs, Uruguay
- Rong Chen MD, PhD, Cambio Healthcare Systems, Sweden
- Sebastian Iancu, Architect, Code24, Netherlands
- Seref Arikan, MEcon, Ocean Informatics UK, Centre for Health Informatics and Multi-professional Education (CHIME) UK
- Thomas Beale, Ars Semantica UK, openEHR Foundation Management Board
### Trademarks
- 'openEHR' is a trademark of the [openEHR Foundation](https://www.openEHR.org)
- 'OpenAPI' is a trademark of the [The Linux Foundation](https://www.linuxfoundation.org)
## Preface
description: |
## Description
### Purpose
Expand Down Expand Up @@ -196,19 +40,6 @@ info:
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>.
### Feedback
Feedback may be provided on the [Implementation Technology Specifications forum](https://discourse.openehr.org/c/specifications/its/41).
Issues may be raised on the [specifications Problem Report tracker](https://openehr.atlassian.net/browse/SPECPR).
To see changes made due to previously reported issues, see the [ITS component Change Request tracker](https://specifications.openehr.org/components/ITS/history).
### Conformance
tbd.
servers:
- url: https://{baseUrl}/v1
description: An example openEHR server URL.
Expand All @@ -234,39 +65,12 @@ tags:
See also [ADL2 Template specifications](https://specifications.openehr.org/releases/AM/latest/ADL2.html#_templates).
- name: Query
x-displayName: Stored Query
x-summary: ''
description: |
Management of [stored (registered) queries](https://specifications.openehr.org/releases/SM/latest/openehr_platform.html#_registered_queries) in the system.
Actions upon resources of this group are also formally described in the [I_DEFINITION_QUERY](https://specifications.openehr.org/releases/SM/latest/openehr_platform.html#_i_definition_query_interface) Abstract Service Model interface.
Stored queries are identified by their [qualified name and version](query.html#tag/Qualified_query_name).
They can be executed using the [query endpoint](query.html#tag/Query/operation/query_execute_stored_query_body).
- name: TemplateList_schema
x-displayName: Template list
description: |
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: |
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" />
The AOM/ADL 2 `OPERATIONAL_TEMPLATE` resource:
<SchemaDefinition schemaRef="#/components/schemas/OperationalTemplateV2" />
The `WebTemplate` alternative resource:
<SchemaDefinition schemaRef="#/components/schemas/WebTemplate" />
- name: StoredQuery_schema
x-displayName: Stored Query
description: |
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" />
paths:
/definition/template/adl1.4:
post:
Expand Down Expand Up @@ -1724,8 +1528,3 @@ x-tagGroups:
- ADL1.4
- ADL2
- Query
- name: Resource schema
tags:
- TemplateList_schema
- Template_schema
- StoredQuery_schema
Loading

0 comments on commit 8a33e2e

Please sign in to comment.