Feature/Add Attribute succession scenario and use cases (#179)

* feat: add draft of attribute succession scenario * feat: add scenario and use case description in one file * feat: update withe excel * feat: update use-cases from excel * fix: adjust GetSharedVersionsOfIdentityAttribute use case * feat: omit 'RepositoryAttribute' in use cases * feat: move content to use case pages and add links * feat: adjust content of CreateIdentityAttribute use case * fix: correct updated returns of use cases * feat: integrate comments * feat: change page title and links * chore: update status * feat: some rephrasing * feat: integrate comments for identity attribute use cases * feat: integrate comments for relationship attribute use cases * feat: be more precise about LocalAttributes in scenario * feat: integrate comments for get versions use cases * feat: add structure to scenario description * feat: adjust scenario text * feat: link to share own attribute scenario * feat: integrate review comments * feat: make sematics of use cases consistent * feat: add terms onw/peer shared Identity/RelationshipAttribute to DMO * chore: update use case names using RepositoryAttribute * feat: integrate comments * feat: adjust redirect * fix: redirect of rename pages --------- Co-authored-by: Vinzent Lange <[email protected]>
nmshd · May 8, 2024 · eac7495 · eac7495
1 parent 37cb3ab
commit eac7495
Show file tree

Hide file tree

Showing 226 changed files with 831 additions and 339 deletions.
diff --git a/_data/navigation.yml b/_data/navigation.yml
@@ -97,6 +97,8 @@ docs_integrate:
     children:
       - title: "Share own Attribute to peer"
         url: /integrate/share-own-attribute-to-peer
+      - title: "Succeeding Attributes to update their values"
+        url: /integrate/succeeding-attributes-to-update-their-values
   - title: Manage attributes of others
     children:
       - title: "Read Attribute from peer"

diff --git a/_docs_integrate/access-the-connector.md b/_docs_integrate/access-the-connector.md
@@ -15,7 +15,7 @@ properties:
   - component: integrate
   - level:
   - implementation status: DOCS ONLY
-  - documentation status: OPEN
+  - documentation status: OLD
   - published: true
   - link: integrate/access-the-connector
 require:

diff --git a/_docs_integrate/create-own-identityattribute.md b/_docs_integrate/create-own-identityattribute.md
@@ -19,7 +19,7 @@ properties:
 require:
   - integrate/identityattribute-introduction
 required_by:
-  - integrate/test-your-request's-validity
+  - integrate/test-your-requests-validity
 ---
 
 {% include scenarios/integrate/create-own-identityattribute.md %}
diff --git a/_docs_integrate/creating-complex-requests.md b/_docs_integrate/creating-complex-requests.md
@@ -1,7 +1,7 @@
 ---
 # !!! Warning: Do not edit this file; any changes must be replicated in Excel !!!
 permalink: integrate/creating-complex-requests
-published: true
+published: false
 title: "Creating complex requests"
 type: scenario
 toc: true

diff --git a/_docs_integrate/delete-attribute.md b/_docs_integrate/delete-attribute.md
@@ -2,7 +2,7 @@
 # !!! Warning: Do not edit this file; any changes must be replicated in Excel !!!
 permalink: integrate/delete-attribute
 published: false
-title: "Delete Attribute"
+title: "delete Attribute"
 type: scenario
 toc: true
 properties:

diff --git a/_docs_integrate/delete-identity-from-enmeshed.md b/_docs_integrate/delete-identity-from-enmeshed.md
@@ -1,7 +1,7 @@
 ---
 # !!! Warning: Do not edit this file; any changes must be replicated in Excel !!!
 permalink: integrate/delete-identity-from-enmeshed
-published: true
+published: false
 title: "Delete Identity from enmeshed"
 type: scenario
 toc: true

diff --git a/_docs_integrate/delete-relationship.md b/_docs_integrate/delete-relationship.md
@@ -2,7 +2,7 @@
 # !!! Warning: Do not edit this file; any changes must be replicated in Excel !!!
 permalink: integrate/delete-relationship
 published: false
-title: "Delete Relationship"
+title: "delete Relationship"
 type: scenario
 toc: true
 properties:

diff --git a/_docs_integrate/establish-a-relationship-to-another-identity.md b/_docs_integrate/establish-a-relationship-to-another-identity.md
@@ -0,0 +1,23 @@
+---
+# !!! Warning: Do not edit this file; any changes must be replicated in Excel !!!
+permalink: integrate/establish-a-relationship-to-another-identity
+published: false
+title: "Establish a relationship to another Identity"
+type: scenario
+toc: true
+properties:
+  - id: SC107
+  - category: Get in touch with other Identities
+  - description: Create Relationship Template (with respective content) Communicate Template to peer (over side channel) Scan Template / Press Link Check and accept Request Send Relationship Request (including Response to Template's Request) Receive Relationship Request Check Relationship Request Accept Relationship Request
+  - customer:
+  - component: integrate
+  - level:
+  - implementation status:
+  - documentation status:
+  - published:
+  - link: integrate/establish-a-relationship-to-another-identity
+require:
+required_by:
+---
+
+{% include scenarios/integrate/establish-a-relationship-to-another-identity.md %}
diff --git a/_docs_integrate/faq.md b/_docs_integrate/faq.md
@@ -1,7 +1,7 @@
 ---
 # !!! Warning: Do not edit this file; any changes must be replicated in Excel !!!
 permalink: integrate/faq
-published: true
+published: false
 title: "FAQ"
 type: scenario
 toc: true

diff --git a/_docs_integrate/notification-introduction.md b/_docs_integrate/notification-introduction.md
@@ -6,7 +6,7 @@ title: "Notification introduction"
 type: scenario
 toc: true
 properties:
-  - id: SC102
+  - id: SC106
   - category: Working with Notifications
   - description:
   - customer: All

diff --git a/_docs_integrate/prepare-enmeshed-onboarding-package.md b/_docs_integrate/prepare-enmeshed-onboarding-package.md
diff --git a/...tegrate/process-received-enmeshed-onboarding-package-and-create-relationship.md b/...tegrate/process-received-enmeshed-onboarding-package-and-create-relationship.md
diff --git a/_docs_integrate/process-responses-to-outgoing-requests.md b/_docs_integrate/process-responses-to-outgoing-requests.md
@@ -1,7 +1,7 @@
 ---
 # !!! Warning: Do not edit this file; any changes must be replicated in Excel !!!
 permalink: integrate/process-responses-to-outgoing-requests
-published: true
+published: false
 title: "Process responses to outgoing requests"
 type: scenario
 toc: true

diff --git a/_docs_integrate/request-and-process-attributes-by-messages.md b/_docs_integrate/request-and-process-attributes-by-messages.md
@@ -1,7 +1,7 @@
 ---
 # !!! Warning: Do not edit this file; any changes must be replicated in Excel !!!
 permalink: integrate/request-and-process-attributes-by-messages
-published: true
+published: false
 title: "Request and process attributes by messages"
 type: scenario
 toc: true

diff --git a/_docs_integrate/requesting-authentication.md b/_docs_integrate/requesting-authentication.md
@@ -1,7 +1,7 @@
 ---
 # !!! Warning: Do not edit this file; any changes must be replicated in Excel !!!
 permalink: integrate/requesting-authentication
-published: true
+published: false
 title: "Requesting authentication"
 type: scenario
 toc: true

diff --git a/_docs_integrate/respond-to-incoming-requests.md b/_docs_integrate/respond-to-incoming-requests.md
@@ -1,7 +1,7 @@
 ---
 # !!! Warning: Do not edit this file; any changes must be replicated in Excel !!!
 permalink: integrate/respond-to-incoming-requests
-published: true
+published: false
 title: "Respond to incoming requests"
 type: scenario
 toc: true

diff --git a/_docs_integrate/sending-messages-with-attachments.md b/_docs_integrate/sending-messages-with-attachments.md
@@ -1,7 +1,7 @@
 ---
 # !!! Warning: Do not edit this file; any changes must be replicated in Excel !!!
 permalink: integrate/sending-messages-with-attachments
-published: true
+published: false
 title: "Sending Messages with attachments"
 type: scenario
 toc: true

diff --git a/_docs_integrate/succeed-attribute-of-peer.md b/_docs_integrate/succeed-attribute-of-peer.md
@@ -1,7 +1,7 @@
 ---
 # !!! Warning: Do not edit this file; any changes must be replicated in Excel !!!
 permalink: integrate/succeed-attribute-of-peer
-published: true
+published: false
 title: "Succeed attribute of peer"
 type: scenario
 toc: true

diff --git a/_docs_integrate/succeeding-attributes-to-update-their-values.md b/_docs_integrate/succeeding-attributes-to-update-their-values.md
@@ -0,0 +1,24 @@
+---
+# !!! Warning: Do not edit this file; any changes must be replicated in Excel !!!
+permalink: integrate/succeeding-attributes-to-update-their-values
+published: true
+title: "Succeeding Attributes to update their values"
+type: scenario
+toc: true
+properties:
+  - id: SC053
+  - category: Manage attributes of yourself
+  - description:
+  - customer: All
+  - component: integrate
+  - level: Beginner
+  - implementation status: DONE
+  - documentation status: DONE
+  - published:
+  - link: integrate/succeeding-attributes-to-update-their-values
+redirect_from: /integrate/updating-identityattributes-of-yourself
+require:
+required_by:
+---
+
+{% include scenarios/integrate/succeeding-attributes-to-update-their-values.md %}
diff --git a/_docs_integrate/support.md b/_docs_integrate/support.md
@@ -1,7 +1,7 @@
 ---
 # !!! Warning: Do not edit this file; any changes must be replicated in Excel !!!
 permalink: integrate/support
-published: true
+published: false
 title: "Support"
 type: scenario
 toc: true

diff --git a/_docs_integrate/updating-identityattributes-of-yourself.md b/_docs_integrate/updating-identityattributes-of-yourself.md
diff --git a/...ling-events-with-google-pubsub-service.md → ...ndling-events-with-google-cloud-pubsub.md b/...ling-events-with-google-pubsub-service.md → ...ndling-events-with-google-cloud-pubsub.md
diff --git a/_docs_operate/log-event-ids.md b/_docs_operate/log-event-ids.md
@@ -13,7 +13,7 @@ properties:
   - component: operate
   - level:
   - implementation status:
-  - documentation status:
+  - documentation status: DONE
   - published: true
   - link: operate/log-event-ids
 require:

diff --git a/...-cases/use-case-anonymous-load-token-by-id-and-key-without-having-an-account.md b/...-cases/use-case-anonymous-load-token-by-id-and-key-without-having-an-account.md
@@ -31,6 +31,7 @@ properties:
   - api_route_regex:
   - published: default
   - link: anonymous/load-token-by-id-and-key-without-having-an-account
+  - redirect_from:
 require:
 required_by:
 ---

diff --git a/...e-case-anonymous-load-token-by-truncated-reference-without-having-an-account.md b/...e-case-anonymous-load-token-by-truncated-reference-without-having-an-account.md
@@ -31,6 +31,7 @@ properties:
   - api_route_regex:
   - published: default
   - link: anonymous/load-token-by-truncated-reference-without-having-an-account
+  - redirect_from:
 require:
 required_by:
 ---

diff --git a/_docs_use-cases/use-case-consumption-accept-incoming-request.md b/_docs_use-cases/use-case-consumption-accept-incoming-request.md
@@ -31,6 +31,7 @@ properties:
   - api_route_regex: PUT /api/v2/Requests/Incoming/{id}/Accept
   - published: default
   - link: consumption/accept-incoming-request
+  - redirect_from:
 require:
 required_by:
 api_route_regex: ^PUT /api/v2/Requests/Incoming/{id}/Accept$

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
@@ -31,6 +31,7 @@ properties:
   - api_route_regex: put /api/v2/Requests/Incoming/{id}/CanAccept
   - published: default
   - link: consumption/check-if-incoming-request-can-be-accepted
+  - redirect_from:
 require:
 required_by:
 api_route_regex: ^put /api/v2/Requests/Incoming/{id}/CanAccept$

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
@@ -31,6 +31,7 @@ properties:
   - api_route_regex: put /api/v2/Requests/Incoming/{id}/canReject
   - published: default
   - link: consumption/check-if-incoming-request-can-be-rejected
+  - redirect_from:
 require:
 required_by:
 api_route_regex: ^put /api/v2/Requests/Incoming/{id}/canReject$

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
@@ -31,6 +31,7 @@ properties:
   - api_route_regex: post /api/v2/Requests/Outgoing/Validate
   - published: default
   - link: consumption/check-if-outgoing-request-can-be-created
+  - redirect_from:
 require:
 required_by:
 api_route_regex: ^post /api/v2/Requests/Outgoing/Validate$

diff --git a/...use-cases/use-case-consumption-create-a-blueprint-of-a-relationship-template.md b/...use-cases/use-case-consumption-create-a-blueprint-of-a-relationship-template.md
@@ -31,6 +31,7 @@ properties:
   - api_route_regex:
   - published:
   - link: consumption/create-a-blueprint-of-a-relationship-template
+  - redirect_from:
 require:
 required_by:
 ---

diff --git a/...e-case-consumption-create-an-attribute.md → ...nsumption-create-a-repositoryattribute.md b/...e-case-consumption-create-an-attribute.md → ...nsumption-create-a-repositoryattribute.md
@@ -1,7 +1,7 @@
 ---
-permalink: /use-case-consumption-create-an-attribute
+permalink: /use-case-consumption-create-a-repositoryattribute
 published: true
-title: "Create an Attribute"
+title: "Create a RepositoryAttribute"
 type: use-case
 toc: true
 sidebar:
@@ -12,11 +12,11 @@ properties:
   - component: Runtime
   - layer: Consumption
   - facade: AttributesFacade
-  - function: createAttribute
+  - function: createRepositoryAttribute
   - description:
   - feature category: Normalized attributes
   - tech category: Attributes
-  - status: CHANGES REQUIRED
+  - status: DONE
   - documentation status: DONE
   - comments: We cannot create RelationshipAttributes with this UseCase
   - actor: Identity
@@ -30,10 +30,11 @@ properties:
   - changed_at:
   - api_route_regex: post /api/v2/Attributes
   - published: default
-  - link: consumption/create-an-attribute
+  - link: consumption/create-a-repositoryattribute
+redirect_from: /use-case-consumption-create-an-attribute
 require:
 required_by:
 api_route_regex: ^post /api/v2/Attributes$
 ---
 
-{% include use-cases/use-case-consumption-create-an-attribute.md %}
+{% include use-cases/use-case-consumption-create-a-repositoryattribute.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
@@ -31,6 +31,7 @@ properties:
   - api_route_regex:
   - published: default
   - link: consumption/create-a-shared-attribute-copy
+  - redirect_from:
 require:
 required_by:
 ---

diff --git a/...ion-create-and-complete-outgoing-request-from-relationship-template-response.md b/...ion-create-and-complete-outgoing-request-from-relationship-template-response.md
@@ -31,6 +31,7 @@ properties:
   - api_route_regex:
   - published: default
   - link: consumption/create-and-complete-outgoing-request-from-relationship-template-response
+  - redirect_from:
 require:
 required_by:
 ---