From d7de4805a081a1667869b14534fdac31c84c4c55 Mon Sep 17 00:00:00 2001 From: avanbremen Date: Mon, 30 Sep 2024 14:12:58 +0200 Subject: [PATCH] Update adding-a-trust-framework.md --- .../agreements/adding-a-trust-framework.md | 67 ++++++++++++++++++- .../agreements/getting-trust-frameworks.md | 61 ----------------- ...t-framework-entity-relationship-diagram.md | 10 --- mkdocs.yml | 1 - 4 files changed, 66 insertions(+), 73 deletions(-) delete mode 100644 docs/learn/agreements/getting-trust-frameworks.md delete mode 100644 docs/learn/agreements/snippets/trust-framework-entity-relationship-diagram.md diff --git a/docs/learn/agreements/adding-a-trust-framework.md b/docs/learn/agreements/adding-a-trust-framework.md index 6f084bb..974be66 100644 --- a/docs/learn/agreements/adding-a-trust-framework.md +++ b/docs/learn/agreements/adding-a-trust-framework.md @@ -2,7 +2,16 @@ ## Entity relationship diagram ---8<-- "learn/agreements/snippets/trust-framework-entity-relationship-diagram.md" +``` mermaid +erDiagram + TRUST-FRAMEWORK ||--o{ VERSION : contains + TRUST-FRAMEWORK }o..|| ORGANIZATION : references +``` + +!!! info + + - Exactly one `TRUST-FRAMEWORK` *contains* zero or more `VERSION` + - Zero or more `TRUST-FRAMEWORK` *references* exactly one `ORGANIZATION` ## Add trust framework @@ -112,4 +121,60 @@ https://oas.zorgapis.nl/#tag/trust-frameworks/operation/updateTrustFramework){: target="_blank" } or fork our [Postman Collection]( https://www.postman.com/zorgapis/zorgapis/collection/6oerml3/zorgapis-api){: target="_blank" } + and explore our API. + +## Get trust frameworks + +=== "Request" + + ```json + GET https://api.zorgapis.nl/v1beta1/trust-frameworks HTTP/1.1 + ``` + +=== "Response" + + ```json hl_lines="6 15" + HTTP/1.1 200 OK + Content-Type: application/json + + --8<-- "learn/agreements/snippets/get-trust-frameworks_response.json" + ``` + + 1. The UUID of the [trust framework](#add-trust-framework). + 2. The UUID of the [main version](#set-trust-framework-main-version-request). + +!!! note + + To learn more, view the [API reference]( + https://oas.zorgapis.nl/#tag/trust-frameworks/operation/listTrustFrameworks){: target="_blank" } + or fork our [Postman Collection]( + https://www.postman.com/zorgapis/zorgapis/collection/6oerml3/zorgapis-api){: target="_blank" } + and explore our API. + +## Get trust framework versions + +List all versions for the trust framework with id `#!js "3b49f2e6-fd5c-48a8-a59c-5fcbed78e5ae"`: + +=== "Request" + + ```json + GET https://api.zorgapis.nl/v1beta1/trust-framework-versions + ?filter=eq(trustFrameworkId,"3b49f2e6-fd5c-48a8-a59c-5fcbed78e5ae") HTTP/1.1 + ``` + +=== "Response" + + ```json hl_lines="9" + HTTP/1.1 200 OK + Content-Type: application/json + + --8<-- "learn/agreements/snippets/get-trust-framework-versions_response.json" + ``` + +!!! note + + To learn more, view the [API reference]( + https://oas.zorgapis.nl/#tag/trust-framework-versions/operation/listTrustFrameworkVersions){: target="_blank" } + or fork our [Postman Collection]( + https://www.postman.com/zorgapis/zorgapis/collection/6oerml3/zorgapis-api){: target="_blank" } and explore our API. \ No newline at end of file diff --git a/docs/learn/agreements/getting-trust-frameworks.md b/docs/learn/agreements/getting-trust-frameworks.md deleted file mode 100644 index 0fd5446..0000000 --- a/docs/learn/agreements/getting-trust-frameworks.md +++ /dev/null @@ -1,61 +0,0 @@ -# Getting trust frameworks - -## Entity relationship diagram - ---8<-- "learn/agreements/snippets/trust-framework-entity-relationship-diagram.md" - -## Get trust frameworks - -=== "Request" - - ```json - GET https://api.zorgapis.nl/v1beta1/trust-frameworks HTTP/1.1 - ``` - -=== "Response" - - ```json hl_lines="6 15" - HTTP/1.1 200 OK - Content-Type: application/json - - --8<-- "learn/agreements/snippets/get-trust-frameworks_response.json" - ``` - - 1. The UUID of the [trust framework](./adding-a-trust-framework.md#add-trust-framework). - 2. The UUID of the [main version](./adding-a-trust-framework.md#set-trust-framework-main-version-request). - -!!! note - - To learn more, view the [API reference]( - https://oas.zorgapis.nl/#tag/trust-frameworks/operation/listTrustFrameworks){: target="_blank" } - or fork our [Postman Collection]( - https://www.postman.com/zorgapis/zorgapis/collection/6oerml3/zorgapis-api){: target="_blank" } - and explore our API. - -## Get trust framework versions - -List all versions for the trust framework with id `#!js "3b49f2e6-fd5c-48a8-a59c-5fcbed78e5ae"`: - -=== "Request" - - ```json - GET https://api.zorgapis.nl/v1beta1/trust-framework-versions - ?filter=eq(trustFrameworkId,"3b49f2e6-fd5c-48a8-a59c-5fcbed78e5ae") HTTP/1.1 - ``` - -=== "Response" - - ```json hl_lines="9" - HTTP/1.1 200 OK - Content-Type: application/json - - --8<-- "learn/agreements/snippets/get-trust-framework-versions_response.json" - ``` - -!!! note - - To learn more, view the [API reference]( - https://oas.zorgapis.nl/#tag/trust-framework-versions/operation/listTrustFrameworkVersions){: target="_blank" } - or fork our [Postman Collection]( - https://www.postman.com/zorgapis/zorgapis/collection/6oerml3/zorgapis-api){: target="_blank" } - and explore our API. \ No newline at end of file diff --git a/docs/learn/agreements/snippets/trust-framework-entity-relationship-diagram.md b/docs/learn/agreements/snippets/trust-framework-entity-relationship-diagram.md deleted file mode 100644 index 9c6a246..0000000 --- a/docs/learn/agreements/snippets/trust-framework-entity-relationship-diagram.md +++ /dev/null @@ -1,10 +0,0 @@ -``` mermaid -erDiagram - TRUST-FRAMEWORK ||--o{ VERSION : contains - TRUST-FRAMEWORK }o..|| ORGANIZATION : references -``` - -!!! info - - - Exactly one `TRUST-FRAMEWORK` *contains* zero or more `VERSION` - - Zero or more `TRUST-FRAMEWORK` *references* exactly one `ORGANIZATION` \ No newline at end of file diff --git a/mkdocs.yml b/mkdocs.yml index dae7b42..ab99322 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -148,7 +148,6 @@ nav: - Adding a communication standard: learn/standards/adding-a-communication-standard.md - Agreements: - learn/agreements/index.md - - Getting trust frameworks: learn/agreements/getting-trust-frameworks.md - Adding a trust framework: learn/agreements/adding-a-trust-framework.md - Play: - play/index.md