Merge branch 'feature/add-usecase-description' of github.com:nmshd/do…

…cumentation into feature/add-usecase-description
nmshd · Oct 12, 2023 · fc39452 · fc39452
2 parents b4a8970 + 5e30d64
commit fc39452
Show file tree

Hide file tree

Showing 44 changed files with 63 additions and 41 deletions.
diff --git a/_docs_use-cases/use-case-consumption-accept-incoming-request.md b/_docs_use-cases/use-case-consumption-accept-incoming-request.md
@@ -19,7 +19,7 @@ properties:
   - comments:
   - actor: Identity
   - component: Runtime
-  - trigger:
+  - trigger: REST API
   - precondition:
   - result:
   - priority: n/a

diff --git a/_docs_use-cases/use-case-consumption-check-if-incoming-request-can-be-accepted.md b/_docs_use-cases/use-case-consumption-check-if-incoming-request-can-be-accepted.md
@@ -19,7 +19,7 @@ properties:
   - comments:
   - actor: Identity
   - component: Runtime
-  - trigger:
+  - trigger: REST API
   - precondition:
   - result:
   - priority: n/a

diff --git a/_docs_use-cases/use-case-consumption-check-if-incoming-request-can-be-rejected.md b/_docs_use-cases/use-case-consumption-check-if-incoming-request-can-be-rejected.md
@@ -19,7 +19,7 @@ properties:
   - comments:
   - actor: Identity
   - component: Runtime
-  - trigger:
+  - trigger: REST API
   - precondition:
   - result:
   - priority: n/a

diff --git a/_docs_use-cases/use-case-consumption-check-if-outgoing-request-can-be-created.md b/_docs_use-cases/use-case-consumption-check-if-outgoing-request-can-be-created.md
@@ -32,6 +32,7 @@ properties:
   - link: consumption/check-if-outgoing-request-can-be-created
 require:
 required_by:
+  - /use-case-consumption-create-outgoing-request
 ---
 
 {% include use-cases/use-case-consumption-check-if-outgoing-request-can-be-created.md %}
diff --git a/_docs_use-cases/use-case-consumption-create-a-shared-attribute-copy.md b/_docs_use-cases/use-case-consumption-create-a-shared-attribute-copy.md
@@ -19,7 +19,7 @@ properties:
   - comments:
   - actor: Identity
   - component: Runtime
-  - trigger:
+  - trigger: Runtime
   - precondition:
   - result:
   - priority: n/a

diff --git a/_docs_use-cases/use-case-consumption-create-an-attribute.md b/_docs_use-cases/use-case-consumption-create-an-attribute.md
@@ -19,7 +19,7 @@ properties:
   - comments:
   - actor: Identity
   - component: Runtime
-  - trigger:
+  - trigger: REST API
   - precondition:
   - result:
   - priority: n/a

diff --git a/_docs_use-cases/use-case-consumption-create-draft.md b/_docs_use-cases/use-case-consumption-create-draft.md
@@ -19,7 +19,7 @@ properties:
   - comments:
   - actor: Identity
   - component: Runtime
-  - trigger:
+  - trigger: Runtime
   - precondition:
   - result:
   - priority: n/a

diff --git a/_docs_use-cases/use-case-consumption-create-outgoing-request.md b/_docs_use-cases/use-case-consumption-create-outgoing-request.md
@@ -31,7 +31,10 @@ properties:
   - published: default
   - link: consumption/create-outgoing-request
 require:
+  - /use-case-consumption-check-if-outgoing-request-can-be-created
 required_by:
+  - integrate/integration-example
+  - integrate/requests-over-messages
 ---
 
 {% include use-cases/use-case-consumption-create-outgoing-request.md %}
diff --git a/_docs_use-cases/use-case-consumption-delete-draft.md b/_docs_use-cases/use-case-consumption-delete-draft.md
@@ -19,7 +19,7 @@ properties:
   - comments:
   - actor: Identity
   - component: Runtime
-  - trigger:
+  - trigger: Runtime
   - precondition:
   - result:
   - priority: n/a

diff --git a/_docs_use-cases/use-case-consumption-execute-a-relationshipattributequery.md b/_docs_use-cases/use-case-consumption-execute-a-relationshipattributequery.md
@@ -19,7 +19,7 @@ properties:
   - comments:
   - actor: Identity
   - component: Runtime
-  - trigger:
+  - trigger: REST API
   - precondition:
   - result:
   - priority: n/a

diff --git a/_docs_use-cases/use-case-consumption-execute-a-thirdpartyattributequery.md b/_docs_use-cases/use-case-consumption-execute-a-thirdpartyattributequery.md
@@ -19,7 +19,7 @@ properties:
   - comments:
   - actor: Identity
   - component: Runtime
-  - trigger:
+  - trigger: REST API
   - precondition:
   - result:
   - priority: n/a

diff --git a/_docs_use-cases/use-case-consumption-execute-an-identityattributequery.md b/_docs_use-cases/use-case-consumption-execute-an-identityattributequery.md
@@ -19,7 +19,7 @@ properties:
   - comments:
   - actor: Identity
   - component: Runtime
-  - trigger:
+  - trigger: REST API
   - precondition:
   - result:
   - priority: n/a

diff --git a/_docs_use-cases/use-case-consumption-get-attribute.md b/_docs_use-cases/use-case-consumption-get-attribute.md
@@ -19,7 +19,7 @@ properties:
   - comments:
   - actor: Identity
   - component: Runtime
-  - trigger:
+  - trigger: REST API
   - precondition:
   - result:
   - priority: n/a

diff --git a/_docs_use-cases/use-case-consumption-get-attributelistener.md b/_docs_use-cases/use-case-consumption-get-attributelistener.md
@@ -19,7 +19,7 @@ properties:
   - comments:
   - actor: Identity
   - component: Runtime
-  - trigger:
+  - trigger: Runtime
   - precondition:
   - result:
   - priority: n/a

diff --git a/_docs_use-cases/use-case-consumption-get-attributes-of-peer.md b/_docs_use-cases/use-case-consumption-get-attributes-of-peer.md
@@ -19,7 +19,7 @@ properties:
   - comments:
   - actor: Identity
   - component: Runtime
-  - trigger:
+  - trigger: REST API
   - precondition:
   - result:
   - priority: n/a

diff --git a/_docs_use-cases/use-case-consumption-get-attributes-shared-to-peer.md b/_docs_use-cases/use-case-consumption-get-attributes-shared-to-peer.md
@@ -19,7 +19,7 @@ properties:
   - comments:
   - actor: Identity
   - component: Runtime
-  - trigger:
+  - trigger: REST API
   - precondition:
   - result:
   - priority: n/a

diff --git a/_docs_use-cases/use-case-consumption-get-draft.md b/_docs_use-cases/use-case-consumption-get-draft.md
@@ -19,7 +19,7 @@ properties:
   - comments:
   - actor: Identity
   - component: Runtime
-  - trigger:
+  - trigger: Runtime
   - precondition:
   - result:
   - priority: n/a

diff --git a/_docs_use-cases/use-case-consumption-get-incoming-request.md b/_docs_use-cases/use-case-consumption-get-incoming-request.md
@@ -19,7 +19,7 @@ properties:
   - comments:
   - actor: Identity
   - component: Runtime
-  - trigger:
+  - trigger: REST API
   - precondition:
   - result:
   - priority: n/a

diff --git a/_docs_use-cases/use-case-consumption-query-attributelisteners.md b/_docs_use-cases/use-case-consumption-query-attributelisteners.md
@@ -19,7 +19,7 @@ properties:
   - comments:
   - actor: Identity
   - component: Runtime
-  - trigger:
+  - trigger: Runtime
   - precondition:
   - result:
   - priority: n/a

diff --git a/_docs_use-cases/use-case-consumption-query-attributes.md b/_docs_use-cases/use-case-consumption-query-attributes.md
@@ -19,7 +19,7 @@ properties:
   - comments:
   - actor: Identity
   - component: Runtime
-  - trigger:
+  - trigger: REST API
   - precondition:
   - result:
   - priority: n/a

diff --git a/_docs_use-cases/use-case-consumption-query-drafts.md b/_docs_use-cases/use-case-consumption-query-drafts.md
@@ -19,7 +19,7 @@ properties:
   - comments:
   - actor: Identity
   - component: Runtime
-  - trigger:
+  - trigger: Runtime
   - precondition:
   - result:
   - priority: n/a

diff --git a/_docs_use-cases/use-case-consumption-query-incoming-requests.md b/_docs_use-cases/use-case-consumption-query-incoming-requests.md
@@ -19,7 +19,7 @@ properties:
   - comments:
   - actor: Identity
   - component: Runtime
-  - trigger:
+  - trigger: REST API
   - precondition:
   - result:
   - priority: n/a

diff --git a/_docs_use-cases/use-case-consumption-reject-incoming-request.md b/_docs_use-cases/use-case-consumption-reject-incoming-request.md
@@ -19,7 +19,7 @@ properties:
   - comments:
   - actor: Identity
   - component: Runtime
-  - trigger:
+  - trigger: REST API
   - precondition:
   - result:
   - priority: n/a

diff --git a/_docs_use-cases/use-case-consumption-update-draft.md b/_docs_use-cases/use-case-consumption-update-draft.md
@@ -19,7 +19,7 @@ properties:
   - comments:
   - actor: Identity
   - component: Runtime
-  - trigger:
+  - trigger: Runtime
   - precondition:
   - result:
   - priority: n/a

diff --git a/...-number-of-requests-and-the-status-codes-that-were-returned-by-the-connector.md b/...-number-of-requests-and-the-status-codes-that-were-returned-by-the-connector.md
@@ -1,7 +1,7 @@
 ---
 permalink: /use-case-device-get-the-number-of-requests-and-the-status-codes-that-were-returned-by-the-connector
 published: true
-title: "Get the number of requests and the status codes that were returned by the Connector."
+title: "Get the number of requests and the status codes that were returned by the Connector"
 type: use-case
 toc: true
 sidebar:

diff --git a/_docs_use-cases/use-case-transport-create-challenge.md b/_docs_use-cases/use-case-transport-create-challenge.md
@@ -19,7 +19,7 @@ properties:
   - comments:
   - actor: Identity
   - component: Runtime
-  - trigger:
+  - trigger: REST API
   - precondition:
   - result:
   - priority: n/a

diff --git a/_docs_use-cases/use-case-transport-create-device.md b/_docs_use-cases/use-case-transport-create-device.md
@@ -19,7 +19,7 @@ properties:
   - comments:
   - actor: Identity
   - component: Runtime
-  - trigger:
+  - trigger: Runtime
   - precondition:
   - result:
   - priority: n/a

diff --git a/_docs_use-cases/use-case-transport-create-own-token.md b/_docs_use-cases/use-case-transport-create-own-token.md
@@ -19,7 +19,7 @@ properties:
   - comments:
   - actor: Identity
   - component: Runtime
-  - trigger:
+  - trigger: REST API
   - precondition:
   - result:
   - priority: n/a

diff --git a/_docs_use-cases/use-case-transport-create-token-for-file.md b/_docs_use-cases/use-case-transport-create-token-for-file.md
@@ -19,7 +19,7 @@ properties:
   - comments:
   - actor: Identity
   - component: Runtime
-  - trigger:
+  - trigger: REST API
   - precondition:
   - result:
   - priority: n/a

diff --git a/_docs_use-cases/use-case-transport-download-file.md b/_docs_use-cases/use-case-transport-download-file.md
@@ -19,7 +19,7 @@ properties:
   - comments:
   - actor: Identity
   - component: Runtime
-  - trigger:
+  - trigger: REST API
   - precondition:
   - result:
   - priority: n/a

diff --git a/_docs_use-cases/use-case-transport-get-device-onboarding-info.md b/_docs_use-cases/use-case-transport-get-device-onboarding-info.md
@@ -19,7 +19,7 @@ properties:
   - comments:
   - actor: Identity
   - component: Runtime
-  - trigger:
+  - trigger: Runtime
   - precondition:
   - result:
   - priority: n/a

diff --git a/_docs_use-cases/use-case-transport-get-device-onboarding-token.md b/_docs_use-cases/use-case-transport-get-device-onboarding-token.md
@@ -19,7 +19,7 @@ properties:
   - comments:
   - actor: Identity
   - component: Runtime
-  - trigger:
+  - trigger: Runtime
   - precondition:
   - result:
   - priority: n/a

diff --git a/_docs_use-cases/use-case-transport-get-device.md b/_docs_use-cases/use-case-transport-get-device.md
@@ -19,7 +19,7 @@ properties:
   - comments:
   - actor: Identity
   - component: Runtime
-  - trigger:
+  - trigger: Runtime
   - precondition:
   - result:
   - priority: n/a

diff --git a/_docs_use-cases/use-case-transport-get-or-load-file.md b/_docs_use-cases/use-case-transport-get-or-load-file.md
@@ -19,7 +19,7 @@ properties:
   - comments:
   - actor: Identity
   - component: Runtime
-  - trigger:
+  - trigger: REST API
   - precondition:
   - result:
   - priority: n/a

diff --git a/_docs_use-cases/use-case-transport-get-own-file.md b/_docs_use-cases/use-case-transport-get-own-file.md
@@ -19,7 +19,7 @@ properties:
   - comments:
   - actor: Identity
   - component: Runtime
-  - trigger:
+  - trigger: REST API
   - precondition:
   - result:
   - priority: n/a

diff --git a/_docs_use-cases/use-case-transport-load-token-created-by-others.md b/_docs_use-cases/use-case-transport-load-token-created-by-others.md
@@ -19,7 +19,7 @@ properties:
   - comments:
   - actor: Identity
   - component: Runtime
-  - trigger:
+  - trigger: REST API
   - precondition:
   - result:
   - priority: n/a

diff --git a/_docs_use-cases/use-case-transport-query-devices.md b/_docs_use-cases/use-case-transport-query-devices.md
@@ -19,7 +19,7 @@ properties:
   - comments:
   - actor: Identity
   - component: Runtime
-  - trigger:
+  - trigger: Runtime
   - precondition:
   - result:
   - priority: n/a

diff --git a/_docs_use-cases/use-case-transport-query-files.md b/_docs_use-cases/use-case-transport-query-files.md
@@ -19,7 +19,7 @@ properties:
   - comments:
   - actor: Identity
   - component: Runtime
-  - trigger:
+  - trigger: REST API
   - precondition:
   - result:
   - priority: n/a

diff --git a/_docs_use-cases/use-case-transport-update-device.md b/_docs_use-cases/use-case-transport-update-device.md
@@ -19,7 +19,7 @@ properties:
   - comments:
   - actor: Identity
   - component: Runtime
-  - trigger:
+  - trigger: Runtime
   - precondition:
   - result:
   - priority: n/a

diff --git a/_docs_use-cases/use-case-transport-upload-own-file.md b/_docs_use-cases/use-case-transport-upload-own-file.md
@@ -19,7 +19,7 @@ properties:
   - comments:
   - actor: Identity
   - component: Runtime
-  - trigger:
+  - trigger: REST API
   - precondition:
   - result:
   - priority: n/a

diff --git a/_docs_use-cases/use-case-transport-validate-challenge.md b/_docs_use-cases/use-case-transport-validate-challenge.md
@@ -19,7 +19,7 @@ properties:
   - comments:
   - actor: Identity
   - component: Runtime
-  - trigger:
+  - trigger: REST API
   - precondition:
   - result:
   - priority: n/a

diff --git a/_includes/properties_list.html b/_includes/properties_list.html
@@ -1,4 +1,3 @@
-<!--
 <div>
     <table>
         {% for property in page.properties%}
@@ -38,4 +37,3 @@
         </tr>
     </table>
 </div>
--->
diff --git a/...udes/use-cases/use-case-consumption-check-if-outgoing-request-can-be-created.md b/...udes/use-cases/use-case-consumption-check-if-outgoing-request-can-be-created.md
@@ -1,5 +1,7 @@
 Validates an outgoing request without creating it.
 
+{% include properties_list.html %}
+
 The content is the to be created request defined in the [data model](/integrate/data-model-overview#request).
 
 ## Example Body