From eac7495b167be2270328538dc7a8ebbeddb2ba02 Mon Sep 17 00:00:00 2001 From: Milena Czierlinski <146972016+Milena-Czierlinski@users.noreply.github.com> Date: Tue, 20 Feb 2024 15:50:40 +0100 Subject: [PATCH] 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 --- _data/navigation.yml | 2 + _docs_integrate/access-the-connector.md | 2 +- .../create-own-identityattribute.md | 2 +- _docs_integrate/creating-complex-requests.md | 2 +- _docs_integrate/delete-attribute.md | 2 +- .../delete-identity-from-enmeshed.md | 2 +- _docs_integrate/delete-relationship.md | 2 +- ...lish-a-relationship-to-another-identity.md | 23 +++++ _docs_integrate/faq.md | 2 +- _docs_integrate/notification-introduction.md | 2 +- .../prepare-enmeshed-onboarding-package.md | 23 ----- ...oarding-package-and-create-relationship.md | 23 ----- .../process-responses-to-outgoing-requests.md | 2 +- ...uest-and-process-attributes-by-messages.md | 2 +- _docs_integrate/requesting-authentication.md | 2 +- .../respond-to-incoming-requests.md | 2 +- .../sending-messages-with-attachments.md | 2 +- _docs_integrate/succeed-attribute-of-peer.md | 2 +- ...eding-attributes-to-update-their-values.md | 24 ++++++ _docs_integrate/support.md | 2 +- ...updating-identityattributes-of-yourself.md | 23 ----- ...ndling-events-with-google-cloud-pubsub.md} | 0 _docs_operate/log-event-ids.md | 2 +- ...by-id-and-key-without-having-an-account.md | 1 + ...ted-reference-without-having-an-account.md | 1 + ...ase-consumption-accept-incoming-request.md | 1 + ...eck-if-incoming-request-can-be-accepted.md | 1 + ...eck-if-incoming-request-can-be-rejected.md | 1 + ...heck-if-outgoing-request-can-be-created.md | 1 + ...-a-blueprint-of-a-relationship-template.md | 1 + ...nsumption-create-a-repositoryattribute.md} | 13 +-- ...sumption-create-a-shared-attribute-copy.md | 1 + ...est-from-relationship-template-response.md | 1 + ...reate-and-share-a-relationshipattribute.md | 39 +++++++++ ...case-consumption-create-automation-rule.md | 1 + .../use-case-consumption-create-draft.md | 1 + .../use-case-consumption-create-mail.md | 1 + ...ase-consumption-create-outgoing-request.md | 1 + ...-relationship-template-out-of-blueprint.md | 1 + ...eate-requestitem-to-delete-relationship.md | 1 + ...-requestitem-to-delete-shared-attribute.md | 1 + ...-inform-about-forced-attribute-deletion.md | 1 + ...form-about-forced-relationship-deletion.md | 1 + .../use-case-consumption-create-setting.md | 1 + .../use-case-consumption-delete-attribute.md | 3 +- ...se-consumption-delete-attributelistener.md | 1 + ...case-consumption-delete-automation-rule.md | 1 + .../use-case-consumption-delete-blueprint.md | 1 + .../use-case-consumption-delete-draft.md | 1 + .../use-case-consumption-delete-setting.md | 1 + ...ase-consumption-delete-shared-attribute.md | 1 + ...e-consumption-discards-outgoing-request.md | 1 + ...on-execute-a-relationshipattributequery.md | 1 + ...tion-execute-a-thirdpartyattributequery.md | 1 + ...ption-execute-an-identityattributequery.md | 1 + ...se-case-consumption-execute-an-iqlquery.md | 1 + .../use-case-consumption-get-attribute.md | 3 +- ...-case-consumption-get-attributelistener.md | 1 + ...case-consumption-get-attributes-of-peer.md | 5 +- ...nsumption-get-attributes-shared-to-peer.md | 3 +- ...se-case-consumption-get-automation-rule.md | 1 + .../use-case-consumption-get-blueprint.md | 1 + .../use-case-consumption-get-draft.md | 1 + ...e-case-consumption-get-incoming-request.md | 1 + .../use-case-consumption-get-mail.md | 1 + ...e-case-consumption-get-outgoing-request.md | 1 + .../use-case-consumption-get-setting.md | 1 + ...hared-versions-of-a-repositoryattribute.md | 39 +++++++++ ...onsumption-get-versions-of-an-attribute.md | 39 +++++++++ ...er-about-repositoryattribute-succession.md | 39 +++++++++ ...ption-pin-mark-as-favorite-relationship.md | 1 + ...se-consumption-query-attributelisteners.md | 1 + .../use-case-consumption-query-attributes.md | 1 + ...case-consumption-query-automation-rules.md | 1 + .../use-case-consumption-query-blueprints.md | 1 + .../use-case-consumption-query-drafts.md | 1 + ...ase-consumption-query-incoming-requests.md | 1 + .../use-case-consumption-query-mails.md | 1 + ...ase-consumption-query-outgoing-requests.md | 1 + .../use-case-consumption-query-settings.md | 1 + ...ase-consumption-reject-incoming-request.md | 1 + ...tion-set-categorization-of-relationship.md | 1 + ...incoming-request-to-check-prerequisites.md | 1 + ...-status-of-incoming-request-to-complete.md | 1 + ...-status-of-incoming-request-to-received.md | 1 + ...ming-request-to-require-manual-decision.md | 1 + ...-status-of-outgoing-request-to-complete.md | 1 + ...-set-status-of-outgoing-request-to-sent.md | 1 + ...onsumption-share-a-repositoryattribute.md} | 15 ++-- ...a-relationshipattribute-and-notify-peer.md | 39 +++++++++ ...sumption-succeed-a-repositoryattribute.md} | 15 ++-- .../use-case-consumption-update-attribute.md | 38 --------- ...case-consumption-update-automation-rule.md | 1 + .../use-case-consumption-update-blueprint.md | 1 + .../use-case-consumption-update-draft.md | 1 + .../use-case-consumption-update-setting.md | 1 + .../use-case-device-clear-all-profiles.md | 1 + ...-case-device-configure_-config-property.md | 1 + ...device-create-profile-with-new-identity.md | 1 + .../use-case-device-delete_-rest-endpoint.md | 1 + ...ase-device-get-appruntime-health-status.md | 1 + ...vice-get-appruntime-version-information.md | 1 + ...-device-get-profile-by-enmeshed-address.md | 1 + .../use-case-device-get-profile.md | 1 + .../use-case-device-get-profiles.md | 1 + ...use-case-device-get-support-information.md | 1 + ...-device-get-the-connector-health-status.md | 1 + ...e-get-the-connector-version-information.md | 1 + ...des-that-were-returned-by-the-connector.md | 1 + .../use-case-device-get_-rest-endpoint.md | 1 + ...board-device-by-device-onboarding-token.md | 1 + .../use-case-device-post_-rest-endpoint.md | 1 + .../use-case-device-put_-rest-endpoint.md | 1 + .../use-case-device-rename-profile.md | 1 + ...evice-restore-identity-by-recovery-data.md | 1 + ...-profile-login---create-profile-session.md | 1 + ...device-set-up-global-exception-handling.md | 1 + ...set-up-or-change-auto-logout-of-profile.md | 1 + ...ce-set-up-or-change-password-of-profile.md | 1 + .../use-case-human-cancel_-action.md | 1 + ...use-case-human-device_-external-usecase.md | 1 + .../use-case-human-enter_-data-on-screen.md | 1 + ...e-case-human-navigate-to-screen_-screen.md | 1 + .../use-case-human-negative_-action.md | 1 + .../use-case-human-positive_-action.md | 1 + ...human-scan_-qr-code-on-different-device.md | 1 + .../use-case-human-select_-item-on-screen.md | 1 + ...se-transport-accept-relationship-change.md | 1 + ...-transport-approve-deletion-of-identity.md | 1 + ...l-identity-deletion-within-grace-period.md | 1 + ...ase-transport-check-identity-by-address.md | 1 + .../use-case-transport-create-challenge.md | 1 + .../use-case-transport-create-device.md | 1 + ...transport-create-identity-recovery-data.md | 1 + ...ansport-create-own-relationshiptemplate.md | 1 + .../use-case-transport-create-own-token.md | 1 + ...e-case-transport-create-qrcode-for-file.md | 1 + ...te-qrcode-for-own-relationship-template.md | 1 + ...-relationship-with-relationshiptemplate.md | 1 + ...se-case-transport-create-token-for-file.md | 1 + ...ate-token-for-own-relationship-template.md | 1 + ...-transport-create-token-qrcode-for-file.md | 1 + ...en-qrcode-for-own-relationship-template.md | 1 + ...elete-device-which-is-not-onboarded-yet.md | 1 + ...atawallet-synchronization-with-backbone.md | 1 + ...e-transport-download-file-of-attachment.md | 1 + .../use-case-transport-download-file.md | 1 + ...atawallet-synchronization-with-backbone.md | 1 + ...ansport-get-attributes-for-relationship.md | 1 + ...ase-transport-get-currently-used-device.md | 1 + ...e-transport-get-currently-used-identity.md | 1 + ...se-transport-get-device-onboarding-info.md | 1 + ...e-transport-get-device-onboarding-token.md | 1 + .../use-case-transport-get-device.md | 1 + ...ansport-get-file-metadata-of-attachment.md | 1 + ...case-transport-get-message-by-messageid.md | 1 + .../use-case-transport-get-or-load-file.md | 1 + .../use-case-transport-get-own-file.md | 1 + ...e-transport-get-qrcode-for-single-token.md | 1 + ...e-transport-get-relationship-by-address.md | 1 + ...port-get-relationship-by-relationshipid.md | 1 + ...ase-transport-get-relationship-template.md | 1 + ...et-synchronization-status-with-backbone.md | 1 + ...use-case-transport-get-token-by-tokenid.md | 1 + ...port-load-item-from-truncated-reference.md | 1 + ...relationship-template-created-by-others.md | 1 + ...-transport-load-token-created-by-others.md | 1 + ...backbone-of-unauthorized-profile-access.md | 1 + .../use-case-transport-query-devices.md | 1 + .../use-case-transport-query-files.md | 1 + .../use-case-transport-query-messages.md | 1 + ...-transport-query-relationship-templates.md | 1 + .../use-case-transport-query-relationships.md | 1 + ...se-transport-query-tokens-by-parameters.md | 1 + ...ase-transport-query-used-backbone-quota.md | 1 + ...ister-pushnotificationtoken-at-backbone.md | 1 + ...se-transport-reject-relationship-change.md | 1 + ...se-transport-remove-profile-from-device.md | 1 + ...-transport-request-deletion-of-identity.md | 1 + ...se-transport-revoke-relationship-change.md | 1 + ...se-transport-send-message-to-recipients.md | 1 + ...chronize-datawallet-updates-to-backbone.md | 1 + ...ansport-synchronize-updates-of-backbone.md | 1 + ...ger-device-deletion-of-onboarded-device.md | 1 + .../use-case-transport-update-device.md | 1 + .../use-case-transport-upload-own-file.md | 1 + .../use-case-transport-validate-challenge.md | 1 + ...r_interface-get-app-version-information.md | 1 + ...se-user_interface-refresh-screen-screen.md | 1 + ...-case-user_interface-show-screen-screen.md | 1 + ...start-app-with-parameters-by-using-link.md | 1 + ..._interface-start-app-without-parameters.md | 1 + _docs_use/create-an-identity.md | 2 +- _docs_use/delete-identity-from-enmeshed.md | 2 +- _docs_use/delete-profile-from-the-app.md | 2 +- ...personalized-and-non-personalized-codes.md | 23 ----- ...digital-relationship-to-an-organization.md | 23 +++++ ...w-digital-relationship-to-another-user.md} | 10 +-- _docs_use/get-overview-of-your-data.md | 2 +- _docs_use/install-the-app.md | 2 +- ...nually-fill-attributes-of-your-identity.md | 2 +- ...oarding-package-and-create-relationship.md | 23 ----- _docs_use/process-requests-of-contact.md | 2 +- ...new-online-account-with-an-organization.md | 23 +++++ ...gister-new-online-account-with-enmeshed.md | 23 ----- ...rofile-to-distinguish-multiple-profiles.md | 2 +- ...t-up-digital-communication-by-printouts.md | 23 ----- .../send-prefabricated-request-to-contact.md | 2 +- ...sting-online-account-at-an-organization.md | 23 +++++ ...ade-existing-online-account-to-enmeshed.md | 23 ----- ...-to-trigger-enmeshed-on-the-same-device.md | 23 ----- .../integrate/data-model-overview.md | 14 +++- ...eding-attributes-to-update-their-values.md | 84 +++++++++++++++++++ ...updating-identityattributes-of-yourself.md | 17 ---- ...onsumption-create-a-repositoryattribute.md | 19 +++++ ...se-case-consumption-create-an-attribute.md | 18 ---- ...reate-and-share-a-relationshipattribute.md | 25 ++++++ ...hared-versions-of-a-repositoryattribute.md | 25 ++++++ ...onsumption-get-versions-of-an-attribute.md | 21 +++++ ...er-about-repositoryattribute-succession.md | 30 +++++++ ...consumption-share-a-repositoryattribute.md | 32 +++++++ .../use-case-consumption-share-attribute.md | 0 ...a-relationshipattribute-and-notify-peer.md | 27 ++++++ ...nsumption-succeed-a-repositoryattribute.md | 27 ++++++ .../use-case-consumption-succeed-attribute.md | 0 .../use-case-consumption-update-attribute.md | 0 226 files changed, 831 insertions(+), 339 deletions(-) create mode 100644 _docs_integrate/establish-a-relationship-to-another-identity.md delete mode 100644 _docs_integrate/prepare-enmeshed-onboarding-package.md delete mode 100644 _docs_integrate/process-received-enmeshed-onboarding-package-and-create-relationship.md create mode 100644 _docs_integrate/succeeding-attributes-to-update-their-values.md delete mode 100644 _docs_integrate/updating-identityattributes-of-yourself.md rename _docs_operate/{handling-events-with-google-pubsub-service.md => handling-events-with-google-cloud-pubsub.md} (100%) rename _docs_use-cases/{use-case-consumption-create-an-attribute.md => use-case-consumption-create-a-repositoryattribute.md} (67%) create mode 100644 _docs_use-cases/use-case-consumption-create-and-share-a-relationshipattribute.md create mode 100644 _docs_use-cases/use-case-consumption-get-shared-versions-of-a-repositoryattribute.md create mode 100644 _docs_use-cases/use-case-consumption-get-versions-of-an-attribute.md create mode 100644 _docs_use-cases/use-case-consumption-notify-peer-about-repositoryattribute-succession.md rename _docs_use-cases/{use-case-consumption-share-attribute.md => use-case-consumption-share-a-repositoryattribute.md} (63%) create mode 100644 _docs_use-cases/use-case-consumption-succeed-a-relationshipattribute-and-notify-peer.md rename _docs_use-cases/{use-case-consumption-succeed-attribute.md => use-case-consumption-succeed-a-repositoryattribute.md} (63%) delete mode 100644 _docs_use-cases/use-case-consumption-update-attribute.md delete mode 100644 _docs_use/distinguish-personalized-and-non-personalized-codes.md create mode 100644 _docs_use/establish-a-new-digital-relationship-to-an-organization.md rename _docs_use/{create-own-enmeshed-codes-to-share-with-your-peers.md => establish-a-new-digital-relationship-to-another-user.md} (52%) delete mode 100644 _docs_use/process-received-enmeshed-onboarding-package-and-create-relationship.md create mode 100644 _docs_use/register-a-new-online-account-with-an-organization.md delete mode 100644 _docs_use/register-new-online-account-with-enmeshed.md delete mode 100644 _docs_use/scan-qr-codes-to-set-up-digital-communication-by-printouts.md create mode 100644 _docs_use/upgrade-an-existing-online-account-at-an-organization.md delete mode 100644 _docs_use/upgrade-existing-online-account-to-enmeshed.md delete mode 100644 _docs_use/use-nmshd-links-to-trigger-enmeshed-on-the-same-device.md create mode 100644 _includes/scenarios/integrate/succeeding-attributes-to-update-their-values.md delete mode 100644 _includes/scenarios/integrate/updating-identityattributes-of-yourself.md create mode 100644 _includes/use-cases/use-case-consumption-create-a-repositoryattribute.md delete mode 100644 _includes/use-cases/use-case-consumption-create-an-attribute.md create mode 100644 _includes/use-cases/use-case-consumption-create-and-share-a-relationshipattribute.md create mode 100644 _includes/use-cases/use-case-consumption-get-shared-versions-of-a-repositoryattribute.md create mode 100644 _includes/use-cases/use-case-consumption-get-versions-of-an-attribute.md create mode 100644 _includes/use-cases/use-case-consumption-notify-peer-about-repositoryattribute-succession.md create mode 100644 _includes/use-cases/use-case-consumption-share-a-repositoryattribute.md delete mode 100644 _includes/use-cases/use-case-consumption-share-attribute.md create mode 100644 _includes/use-cases/use-case-consumption-succeed-a-relationshipattribute-and-notify-peer.md create mode 100644 _includes/use-cases/use-case-consumption-succeed-a-repositoryattribute.md delete mode 100644 _includes/use-cases/use-case-consumption-succeed-attribute.md delete mode 100644 _includes/use-cases/use-case-consumption-update-attribute.md diff --git a/_data/navigation.yml b/_data/navigation.yml index ef81cc3a9..71f62a828 100644 --- 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 index fd2367542..d8b93c560 100644 --- 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 index ee3f8a125..263ac9740 100644 --- 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 index 4f68829f6..3d137a146 100644 --- 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 index 57c49344b..c16a340ed 100644 --- 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 index 2ef11c418..17e3bad13 100644 --- 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 index 8acb30a06..e72b6266f 100644 --- 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 new file mode 100644 index 000000000..7f3c20e06 --- /dev/null +++ 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 index 8fc8cce21..11789e02d 100644 --- 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 index 44856be22..833cb99cc 100644 --- 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 deleted file mode 100644 index 8b67dfb79..000000000 --- a/_docs_integrate/prepare-enmeshed-onboarding-package.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -# !!! Warning: Do not edit this file; any changes must be replicated in Excel !!! -permalink: integrate/prepare-enmeshed-onboarding-package -published: false -title: "Prepare enmeshed onboarding package" -type: scenario -toc: true -properties: - - id: SC074 - - category: Get in touch with other Identities - - description: - - customer: All - - component: integrate - - level: Beginner - - implementation status: DONE - - documentation status: OPEN - - published: - - link: integrate/prepare-enmeshed-onboarding-package -require: -required_by: ---- - -{% include scenarios/integrate/prepare-enmeshed-onboarding-package.md %} diff --git a/_docs_integrate/process-received-enmeshed-onboarding-package-and-create-relationship.md b/_docs_integrate/process-received-enmeshed-onboarding-package-and-create-relationship.md deleted file mode 100644 index 651bf64c3..000000000 --- a/_docs_integrate/process-received-enmeshed-onboarding-package-and-create-relationship.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -# !!! Warning: Do not edit this file; any changes must be replicated in Excel !!! -permalink: integrate/process-received-enmeshed-onboarding-package-and-create-relationship -published: true -title: "Process received enmeshed onboarding package and create relationship" -type: scenario -toc: true -properties: - - id: SC064 - - category: Get in touch with other Identities - - description: - - customer: All - - component: integrate - - level: Advanced - - implementation status: DONE - - documentation status: OPEN - - published: - - link: integrate/process-received-enmeshed-onboarding-package-and-create-relationship -require: -required_by: ---- - -{% include scenarios/integrate/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 index 91a5114d4..b8b5646a9 100644 --- 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 index 0b2fcc969..4e40db75d 100644 --- 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 index 0bdd422ee..30121ef1d 100644 --- 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 index 12fb82c79..abfa5c22f 100644 --- 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 index 36d9fcfe8..20d454439 100644 --- 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 index 8f20b1abf..5b4801e89 100644 --- 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 new file mode 100644 index 000000000..6b8e9cc1a --- /dev/null +++ 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 index af9de28b3..9e3f3a98f 100644 --- 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 deleted file mode 100644 index 941583a8e..000000000 --- a/_docs_integrate/updating-identityattributes-of-yourself.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -# !!! Warning: Do not edit this file; any changes must be replicated in Excel !!! -permalink: integrate/updating-identityattributes-of-yourself -published: true -title: "Updating IdentityAttributes of yourself" -type: scenario -toc: true -properties: - - id: SC053 - - category: Manage attributes of yourself - - description: - - customer: All - - component: integrate - - level: Beginner - - implementation status: OPEN - - documentation status: OPEN - - published: - - link: integrate/updating-identityattributes-of-yourself -require: -required_by: ---- - -{% include scenarios/integrate/updating-identityattributes-of-yourself.md %} diff --git a/_docs_operate/handling-events-with-google-pubsub-service.md b/_docs_operate/handling-events-with-google-cloud-pubsub.md similarity index 100% rename from _docs_operate/handling-events-with-google-pubsub-service.md rename to _docs_operate/handling-events-with-google-cloud-pubsub.md diff --git a/_docs_operate/log-event-ids.md b/_docs_operate/log-event-ids.md index 543f59e81..3e97aa28c 100644 --- 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/_docs_use-cases/use-case-anonymous-load-token-by-id-and-key-without-having-an-account.md b/_docs_use-cases/use-case-anonymous-load-token-by-id-and-key-without-having-an-account.md index 20cdadb79..d656593dc 100644 --- a/_docs_use-cases/use-case-anonymous-load-token-by-id-and-key-without-having-an-account.md +++ b/_docs_use-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/_docs_use-cases/use-case-anonymous-load-token-by-truncated-reference-without-having-an-account.md b/_docs_use-cases/use-case-anonymous-load-token-by-truncated-reference-without-having-an-account.md index 72740db0a..6463f553f 100644 --- a/_docs_use-cases/use-case-anonymous-load-token-by-truncated-reference-without-having-an-account.md +++ b/_docs_use-cases/use-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 index 253cffc61..cf238669e 100644 --- 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 index 031ec5bc6..29a276541 100644 --- 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 index d3fc6833b..6a9e2cc04 100644 --- 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 index ea8ed2801..d2c1fc9ac 100644 --- 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/_docs_use-cases/use-case-consumption-create-a-blueprint-of-a-relationship-template.md b/_docs_use-cases/use-case-consumption-create-a-blueprint-of-a-relationship-template.md index bb82afb64..6bceb2c15 100644 --- a/_docs_use-cases/use-case-consumption-create-a-blueprint-of-a-relationship-template.md +++ b/_docs_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/_docs_use-cases/use-case-consumption-create-an-attribute.md b/_docs_use-cases/use-case-consumption-create-a-repositoryattribute.md similarity index 67% rename from _docs_use-cases/use-case-consumption-create-an-attribute.md rename to _docs_use-cases/use-case-consumption-create-a-repositoryattribute.md index 12a18a356..a1f3e2f36 100644 --- a/_docs_use-cases/use-case-consumption-create-an-attribute.md +++ b/_docs_use-cases/use-case-consumption-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 index db88621e8..75330d1b9 100644 --- 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/_docs_use-cases/use-case-consumption-create-and-complete-outgoing-request-from-relationship-template-response.md b/_docs_use-cases/use-case-consumption-create-and-complete-outgoing-request-from-relationship-template-response.md index ec1d14e9e..8ecf06656 100644 --- a/_docs_use-cases/use-case-consumption-create-and-complete-outgoing-request-from-relationship-template-response.md +++ b/_docs_use-cases/use-case-consumption-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: --- diff --git a/_docs_use-cases/use-case-consumption-create-and-share-a-relationshipattribute.md b/_docs_use-cases/use-case-consumption-create-and-share-a-relationshipattribute.md new file mode 100644 index 000000000..017f64bfc --- /dev/null +++ b/_docs_use-cases/use-case-consumption-create-and-share-a-relationshipattribute.md @@ -0,0 +1,39 @@ +--- +permalink: /use-case-consumption-create-and-share-a-relationshipattribute +published: true +title: "Create and share a RelationshipAttribute" +type: use-case +toc: true +sidebar: + - title: "Integrate Enmeshed" + nav: "docs_integrate" +properties: + - id: RA21 + - component: Runtime + - layer: Consumption + - facade: AttributesFacade + - function: createAndShareRelationshipAttribute + - description: + - feature category: Cross-identity attribute sharing + - tech category: Attributes + - status: + - documentation status: + - comments: + - actor: Identity + - trigger: + - precondition: + - result: + - priority: + - complexity: + - size: + - created_at: + - changed_at: + - api_route_regex: + - published: + - link: consumption/create-and-share-a-relationshipattribute + - redirect_from: +require: +required_by: +--- + +{% include use-cases/use-case-consumption-create-and-share-a-relationshipattribute.md %} diff --git a/_docs_use-cases/use-case-consumption-create-automation-rule.md b/_docs_use-cases/use-case-consumption-create-automation-rule.md index 2f7e80c1c..fa8561494 100644 --- a/_docs_use-cases/use-case-consumption-create-automation-rule.md +++ b/_docs_use-cases/use-case-consumption-create-automation-rule.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: - link: consumption/create-automation-rule + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-consumption-create-draft.md b/_docs_use-cases/use-case-consumption-create-draft.md index 169ebde37..3f289604b 100644 --- a/_docs_use-cases/use-case-consumption-create-draft.md +++ b/_docs_use-cases/use-case-consumption-create-draft.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: - link: consumption/create-draft + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-consumption-create-mail.md b/_docs_use-cases/use-case-consumption-create-mail.md index 7e15f9c6d..7bd0ffdb3 100644 --- a/_docs_use-cases/use-case-consumption-create-mail.md +++ b/_docs_use-cases/use-case-consumption-create-mail.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: - link: consumption/create-mail + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-consumption-create-outgoing-request.md b/_docs_use-cases/use-case-consumption-create-outgoing-request.md index 34722ccfa..896b9d733 100644 --- a/_docs_use-cases/use-case-consumption-create-outgoing-request.md +++ b/_docs_use-cases/use-case-consumption-create-outgoing-request.md @@ -31,6 +31,7 @@ properties: - api_route_regex: post /api/v2/Requests/Outgoing - published: default - link: consumption/create-outgoing-request + - redirect_from: require: required_by: api_route_regex: ^post /api/v2/Requests/Outgoing$ diff --git a/_docs_use-cases/use-case-consumption-create-relationship-template-out-of-blueprint.md b/_docs_use-cases/use-case-consumption-create-relationship-template-out-of-blueprint.md index 99203df4e..fcbf3ed1c 100644 --- a/_docs_use-cases/use-case-consumption-create-relationship-template-out-of-blueprint.md +++ b/_docs_use-cases/use-case-consumption-create-relationship-template-out-of-blueprint.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: - link: consumption/create-relationship-template-out-of-blueprint + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-consumption-create-requestitem-to-delete-relationship.md b/_docs_use-cases/use-case-consumption-create-requestitem-to-delete-relationship.md index 7a984e0f8..0a8d73ff4 100644 --- a/_docs_use-cases/use-case-consumption-create-requestitem-to-delete-relationship.md +++ b/_docs_use-cases/use-case-consumption-create-requestitem-to-delete-relationship.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: - link: consumption/create-requestitem-to-delete-relationship + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-consumption-create-requestitem-to-delete-shared-attribute.md b/_docs_use-cases/use-case-consumption-create-requestitem-to-delete-shared-attribute.md index 7332214fc..25162cea0 100644 --- a/_docs_use-cases/use-case-consumption-create-requestitem-to-delete-shared-attribute.md +++ b/_docs_use-cases/use-case-consumption-create-requestitem-to-delete-shared-attribute.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: - link: consumption/create-requestitem-to-delete-shared-attribute + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-consumption-create-requestitem-to-inform-about-forced-attribute-deletion.md b/_docs_use-cases/use-case-consumption-create-requestitem-to-inform-about-forced-attribute-deletion.md index e68d623ba..a2d8cec83 100644 --- a/_docs_use-cases/use-case-consumption-create-requestitem-to-inform-about-forced-attribute-deletion.md +++ b/_docs_use-cases/use-case-consumption-create-requestitem-to-inform-about-forced-attribute-deletion.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: - link: consumption/create-requestitem-to-inform-about-forced-attribute-deletion + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-consumption-create-requestitem-to-inform-about-forced-relationship-deletion.md b/_docs_use-cases/use-case-consumption-create-requestitem-to-inform-about-forced-relationship-deletion.md index 762d48760..293f3ba5d 100644 --- a/_docs_use-cases/use-case-consumption-create-requestitem-to-inform-about-forced-relationship-deletion.md +++ b/_docs_use-cases/use-case-consumption-create-requestitem-to-inform-about-forced-relationship-deletion.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: - link: consumption/create-requestitem-to-inform-about-forced-relationship-deletion + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-consumption-create-setting.md b/_docs_use-cases/use-case-consumption-create-setting.md index 37689c00e..cc7b6afd2 100644 --- a/_docs_use-cases/use-case-consumption-create-setting.md +++ b/_docs_use-cases/use-case-consumption-create-setting.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: - link: consumption/create-setting + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-consumption-delete-attribute.md b/_docs_use-cases/use-case-consumption-delete-attribute.md index 4a921bd6f..5998467e9 100644 --- a/_docs_use-cases/use-case-consumption-delete-attribute.md +++ b/_docs_use-cases/use-case-consumption-delete-attribute.md @@ -14,7 +14,7 @@ properties: - facade: AttributesFacade - function: deleteAttribute - description: - - feature category: Normalized attributes + - feature category: Cross-identity attribute sharing - tech category: Attributes - status: QUESTIONS - documentation status: @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: consumption/delete-attribute + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-consumption-delete-attributelistener.md b/_docs_use-cases/use-case-consumption-delete-attributelistener.md index 75f668cee..866626c54 100644 --- a/_docs_use-cases/use-case-consumption-delete-attributelistener.md +++ b/_docs_use-cases/use-case-consumption-delete-attributelistener.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: - link: consumption/delete-attributelistener + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-consumption-delete-automation-rule.md b/_docs_use-cases/use-case-consumption-delete-automation-rule.md index f878f160b..df72a651c 100644 --- a/_docs_use-cases/use-case-consumption-delete-automation-rule.md +++ b/_docs_use-cases/use-case-consumption-delete-automation-rule.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: - link: consumption/delete-automation-rule + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-consumption-delete-blueprint.md b/_docs_use-cases/use-case-consumption-delete-blueprint.md index 9c7a6b385..af2a7f6fb 100644 --- a/_docs_use-cases/use-case-consumption-delete-blueprint.md +++ b/_docs_use-cases/use-case-consumption-delete-blueprint.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: - link: consumption/delete-blueprint + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-consumption-delete-draft.md b/_docs_use-cases/use-case-consumption-delete-draft.md index 56d5d39ab..c8ebcc383 100644 --- a/_docs_use-cases/use-case-consumption-delete-draft.md +++ b/_docs_use-cases/use-case-consumption-delete-draft.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: - link: consumption/delete-draft + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-consumption-delete-setting.md b/_docs_use-cases/use-case-consumption-delete-setting.md index cc58ceb57..6677df821 100644 --- a/_docs_use-cases/use-case-consumption-delete-setting.md +++ b/_docs_use-cases/use-case-consumption-delete-setting.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: - link: consumption/delete-setting + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-consumption-delete-shared-attribute.md b/_docs_use-cases/use-case-consumption-delete-shared-attribute.md index a66b8d030..48a022ca0 100644 --- a/_docs_use-cases/use-case-consumption-delete-shared-attribute.md +++ b/_docs_use-cases/use-case-consumption-delete-shared-attribute.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: - link: consumption/delete-shared-attribute + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-consumption-discards-outgoing-request.md b/_docs_use-cases/use-case-consumption-discards-outgoing-request.md index e78f6a563..cc57995fb 100644 --- a/_docs_use-cases/use-case-consumption-discards-outgoing-request.md +++ b/_docs_use-cases/use-case-consumption-discards-outgoing-request.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: consumption/discards-outgoing-request + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-consumption-execute-a-relationshipattributequery.md b/_docs_use-cases/use-case-consumption-execute-a-relationshipattributequery.md index 2ddad8412..f33f58b9a 100644 --- a/_docs_use-cases/use-case-consumption-execute-a-relationshipattributequery.md +++ b/_docs_use-cases/use-case-consumption-execute-a-relationshipattributequery.md @@ -31,6 +31,7 @@ properties: - api_route_regex: post /api/v2/Attributes/ExecuteRelationshipAttributeQuery - published: default - link: consumption/execute-a-relationshipattributequery + - redirect_from: require: required_by: api_route_regex: ^post /api/v2/Attributes/ExecuteRelationshipAttributeQuery$ diff --git a/_docs_use-cases/use-case-consumption-execute-a-thirdpartyattributequery.md b/_docs_use-cases/use-case-consumption-execute-a-thirdpartyattributequery.md index 2395ae35b..272c9dbe4 100644 --- a/_docs_use-cases/use-case-consumption-execute-a-thirdpartyattributequery.md +++ b/_docs_use-cases/use-case-consumption-execute-a-thirdpartyattributequery.md @@ -31,6 +31,7 @@ properties: - api_route_regex: post /api/v2/Attributes/executeThirdpartyAttributeQuery - published: default - link: consumption/execute-a-thirdpartyattributequery + - redirect_from: require: required_by: api_route_regex: ^post /api/v2/Attributes/executeThirdpartyAttributeQuery$ diff --git a/_docs_use-cases/use-case-consumption-execute-an-identityattributequery.md b/_docs_use-cases/use-case-consumption-execute-an-identityattributequery.md index a828c0b1b..ab87830f5 100644 --- a/_docs_use-cases/use-case-consumption-execute-an-identityattributequery.md +++ b/_docs_use-cases/use-case-consumption-execute-an-identityattributequery.md @@ -31,6 +31,7 @@ properties: - api_route_regex: post /api/v2/Attributes/ExecuteIdentityAttributeQuery - published: default - link: consumption/execute-an-identityattributequery + - redirect_from: require: required_by: api_route_regex: ^post /api/v2/Attributes/ExecuteIdentityAttributeQuery$ diff --git a/_docs_use-cases/use-case-consumption-execute-an-iqlquery.md b/_docs_use-cases/use-case-consumption-execute-an-iqlquery.md index e99cce5fa..ddcb6d77b 100644 --- a/_docs_use-cases/use-case-consumption-execute-an-iqlquery.md +++ b/_docs_use-cases/use-case-consumption-execute-an-iqlquery.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: - link: consumption/execute-an-iqlquery + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-consumption-get-attribute.md b/_docs_use-cases/use-case-consumption-get-attribute.md index 89db79d65..a7115be57 100644 --- a/_docs_use-cases/use-case-consumption-get-attribute.md +++ b/_docs_use-cases/use-case-consumption-get-attribute.md @@ -14,7 +14,7 @@ properties: - facade: AttributesFacade - function: getAttribute - description: Fetches the attribute with the given 'id'. - - feature category: Normalized attributes + - feature category: Cross-identity attribute sharing - tech category: Attributes - status: DONE - documentation status: DONE @@ -31,6 +31,7 @@ properties: - api_route_regex: get /api/v2/Attributes/{id} - published: default - link: consumption/get-attribute + - redirect_from: require: required_by: api_route_regex: ^get /api/v2/Attributes/{id}$ diff --git a/_docs_use-cases/use-case-consumption-get-attributelistener.md b/_docs_use-cases/use-case-consumption-get-attributelistener.md index c848b63d9..869acebc4 100644 --- a/_docs_use-cases/use-case-consumption-get-attributelistener.md +++ b/_docs_use-cases/use-case-consumption-get-attributelistener.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: - link: consumption/get-attributelistener + - redirect_from: require: required_by: --- 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 index c516bebe9..516a86a32 100644 --- a/_docs_use-cases/use-case-consumption-get-attributes-of-peer.md +++ b/_docs_use-cases/use-case-consumption-get-attributes-of-peer.md @@ -12,9 +12,9 @@ properties: - component: Runtime - layer: Consumption - facade: AttributesFacade - - function: getPeerAttributes + - function: getPeerSharedAttributes - description: - - feature category: Normalized attributes + - feature category: Cross-identity attribute sharing - tech category: Attributes - status: DONE - documentation status: DONE @@ -31,6 +31,7 @@ properties: - api_route_regex: GET /api/v2/Attributes - published: default - link: consumption/get-attributes-of-peer + - redirect_from: require: required_by: api_route_regex: ^GET /api/v2/Attributes$ 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 index bc4f53970..735c75fc1 100644 --- 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 @@ -12,7 +12,7 @@ properties: - component: Runtime - layer: Consumption - facade: AttributesFacade - - function: getSharedToPeerAttributes + - function: getOwnSharedAttributes - description: - feature category: Cross-identity attribute sharing - tech category: Attributes @@ -31,6 +31,7 @@ properties: - api_route_regex: GET /api/v2/Attributes - published: default - link: consumption/get-attributes-shared-to-peer + - redirect_from: require: required_by: api_route_regex: ^GET /api/v2/Attributes$ diff --git a/_docs_use-cases/use-case-consumption-get-automation-rule.md b/_docs_use-cases/use-case-consumption-get-automation-rule.md index 391a9dbe6..c7c1c5af5 100644 --- a/_docs_use-cases/use-case-consumption-get-automation-rule.md +++ b/_docs_use-cases/use-case-consumption-get-automation-rule.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: - link: consumption/get-automation-rule + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-consumption-get-blueprint.md b/_docs_use-cases/use-case-consumption-get-blueprint.md index 481d99a66..9bf1e19c4 100644 --- a/_docs_use-cases/use-case-consumption-get-blueprint.md +++ b/_docs_use-cases/use-case-consumption-get-blueprint.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: - link: consumption/get-blueprint + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-consumption-get-draft.md b/_docs_use-cases/use-case-consumption-get-draft.md index 39817225b..7a2905d4e 100644 --- a/_docs_use-cases/use-case-consumption-get-draft.md +++ b/_docs_use-cases/use-case-consumption-get-draft.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: - link: consumption/get-draft + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-consumption-get-incoming-request.md b/_docs_use-cases/use-case-consumption-get-incoming-request.md index e7fd81198..baa61b4d4 100644 --- a/_docs_use-cases/use-case-consumption-get-incoming-request.md +++ b/_docs_use-cases/use-case-consumption-get-incoming-request.md @@ -31,6 +31,7 @@ properties: - api_route_regex: get /api/v2/Requests/Incoming/{id} - published: default - link: consumption/get-incoming-request + - redirect_from: require: required_by: api_route_regex: ^get /api/v2/Requests/Incoming/{id}$ diff --git a/_docs_use-cases/use-case-consumption-get-mail.md b/_docs_use-cases/use-case-consumption-get-mail.md index 85882490e..ec22d4daf 100644 --- a/_docs_use-cases/use-case-consumption-get-mail.md +++ b/_docs_use-cases/use-case-consumption-get-mail.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: - link: consumption/get-mail + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-consumption-get-outgoing-request.md b/_docs_use-cases/use-case-consumption-get-outgoing-request.md index 19543e81a..cce85baf9 100644 --- a/_docs_use-cases/use-case-consumption-get-outgoing-request.md +++ b/_docs_use-cases/use-case-consumption-get-outgoing-request.md @@ -31,6 +31,7 @@ properties: - api_route_regex: get /api/v2/Requests/Outgoing/{id} - published: default - link: consumption/get-outgoing-request + - redirect_from: require: required_by: api_route_regex: ^get /api/v2/Requests/Outgoing/{id}$ diff --git a/_docs_use-cases/use-case-consumption-get-setting.md b/_docs_use-cases/use-case-consumption-get-setting.md index 3f7cfe3ef..d149823ab 100644 --- a/_docs_use-cases/use-case-consumption-get-setting.md +++ b/_docs_use-cases/use-case-consumption-get-setting.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: - link: consumption/get-setting + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-consumption-get-shared-versions-of-a-repositoryattribute.md b/_docs_use-cases/use-case-consumption-get-shared-versions-of-a-repositoryattribute.md new file mode 100644 index 000000000..6060b4270 --- /dev/null +++ b/_docs_use-cases/use-case-consumption-get-shared-versions-of-a-repositoryattribute.md @@ -0,0 +1,39 @@ +--- +permalink: /use-case-consumption-get-shared-versions-of-a-repositoryattribute +published: true +title: "Get shared versions of a RepositoryAttribute" +type: use-case +toc: true +sidebar: + - title: "Integrate Enmeshed" + nav: "docs_integrate" +properties: + - id: RA20 + - component: Runtime + - layer: Consumption + - facade: AttributesFacade + - function: getSharedVersionsOfRepositoryAttribute + - description: + - feature category: Cross-identity attribute sharing + - tech category: Attributes + - status: + - documentation status: + - comments: + - actor: Identity + - trigger: + - precondition: + - result: + - priority: + - complexity: + - size: + - created_at: + - changed_at: + - api_route_regex: + - published: + - link: consumption/get-shared-versions-of-a-repositoryattribute + - redirect_from: +require: +required_by: +--- + +{% include use-cases/use-case-consumption-get-shared-versions-of-a-repositoryattribute.md %} diff --git a/_docs_use-cases/use-case-consumption-get-versions-of-an-attribute.md b/_docs_use-cases/use-case-consumption-get-versions-of-an-attribute.md new file mode 100644 index 000000000..e237c68cb --- /dev/null +++ b/_docs_use-cases/use-case-consumption-get-versions-of-an-attribute.md @@ -0,0 +1,39 @@ +--- +permalink: /use-case-consumption-get-versions-of-an-attribute +published: true +title: "Get versions of an attribute" +type: use-case +toc: true +sidebar: + - title: "Integrate Enmeshed" + nav: "docs_integrate" +properties: + - id: RA19 + - component: Runtime + - layer: Consumption + - facade: AttributesFacade + - function: getVersionsOfAttribute + - description: + - feature category: + - tech category: Attributes + - status: + - documentation status: + - comments: + - actor: Identity + - trigger: + - precondition: + - result: + - priority: + - complexity: + - size: + - created_at: + - changed_at: + - api_route_regex: + - published: + - link: consumption/get-versions-of-an-attribute + - redirect_from: +require: +required_by: +--- + +{% include use-cases/use-case-consumption-get-versions-of-an-attribute.md %} diff --git a/_docs_use-cases/use-case-consumption-notify-peer-about-repositoryattribute-succession.md b/_docs_use-cases/use-case-consumption-notify-peer-about-repositoryattribute-succession.md new file mode 100644 index 000000000..9c5640af8 --- /dev/null +++ b/_docs_use-cases/use-case-consumption-notify-peer-about-repositoryattribute-succession.md @@ -0,0 +1,39 @@ +--- +permalink: /use-case-consumption-notify-peer-about-repositoryattribute-succession +published: true +title: "Notify peer about RepositoryAttribute succession" +type: use-case +toc: true +sidebar: + - title: "Integrate Enmeshed" + nav: "docs_integrate" +properties: + - id: RA18 + - component: Runtime + - layer: Consumption + - facade: AttributesFacade + - function: notifyPeerAboutRepositoryAttributeSuccession + - description: + - feature category: Cross-identity attribute sharing + - tech category: Attributes + - status: + - documentation status: + - comments: + - actor: Identity + - trigger: + - precondition: + - result: + - priority: + - complexity: + - size: + - created_at: + - changed_at: + - api_route_regex: + - published: + - link: consumption/notify-peer-about-repositoryattribute-succession + - redirect_from: +require: +required_by: +--- + +{% include use-cases/use-case-consumption-notify-peer-about-repositoryattribute-succession.md %} diff --git a/_docs_use-cases/use-case-consumption-pin-mark-as-favorite-relationship.md b/_docs_use-cases/use-case-consumption-pin-mark-as-favorite-relationship.md index 15cc8f6c4..bac42d853 100644 --- a/_docs_use-cases/use-case-consumption-pin-mark-as-favorite-relationship.md +++ b/_docs_use-cases/use-case-consumption-pin-mark-as-favorite-relationship.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: - link: consumption/pin/mark-as-favorite-relationship + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-consumption-query-attributelisteners.md b/_docs_use-cases/use-case-consumption-query-attributelisteners.md index 73d4add1f..b7d30b760 100644 --- a/_docs_use-cases/use-case-consumption-query-attributelisteners.md +++ b/_docs_use-cases/use-case-consumption-query-attributelisteners.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: - link: consumption/query-attributelisteners + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-consumption-query-attributes.md b/_docs_use-cases/use-case-consumption-query-attributes.md index 6fec6098e..c172003eb 100644 --- a/_docs_use-cases/use-case-consumption-query-attributes.md +++ b/_docs_use-cases/use-case-consumption-query-attributes.md @@ -31,6 +31,7 @@ properties: - api_route_regex: get /api/v2/Attributes - published: default - link: consumption/query-attributes + - redirect_from: require: required_by: api_route_regex: ^get /api/v2/Attributes$ diff --git a/_docs_use-cases/use-case-consumption-query-automation-rules.md b/_docs_use-cases/use-case-consumption-query-automation-rules.md index b3e86b7cd..8bed9c3ba 100644 --- a/_docs_use-cases/use-case-consumption-query-automation-rules.md +++ b/_docs_use-cases/use-case-consumption-query-automation-rules.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: - link: consumption/query-automation-rules + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-consumption-query-blueprints.md b/_docs_use-cases/use-case-consumption-query-blueprints.md index 0bed457cc..0e0a9d663 100644 --- a/_docs_use-cases/use-case-consumption-query-blueprints.md +++ b/_docs_use-cases/use-case-consumption-query-blueprints.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: - link: consumption/query-blueprints + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-consumption-query-drafts.md b/_docs_use-cases/use-case-consumption-query-drafts.md index 006e33ddb..405833048 100644 --- a/_docs_use-cases/use-case-consumption-query-drafts.md +++ b/_docs_use-cases/use-case-consumption-query-drafts.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: - link: consumption/query-drafts + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-consumption-query-incoming-requests.md b/_docs_use-cases/use-case-consumption-query-incoming-requests.md index f4a037b8d..bda9f53e3 100644 --- a/_docs_use-cases/use-case-consumption-query-incoming-requests.md +++ b/_docs_use-cases/use-case-consumption-query-incoming-requests.md @@ -31,6 +31,7 @@ properties: - api_route_regex: get /api/v2/Requests/incoming - published: default - link: consumption/query-incoming-requests + - redirect_from: require: required_by: api_route_regex: ^get /api/v2/Requests/incoming$ diff --git a/_docs_use-cases/use-case-consumption-query-mails.md b/_docs_use-cases/use-case-consumption-query-mails.md index ce75a0e64..50c1a4382 100644 --- a/_docs_use-cases/use-case-consumption-query-mails.md +++ b/_docs_use-cases/use-case-consumption-query-mails.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: - link: consumption/query-mails + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-consumption-query-outgoing-requests.md b/_docs_use-cases/use-case-consumption-query-outgoing-requests.md index c4b87e601..cd6ef038f 100644 --- a/_docs_use-cases/use-case-consumption-query-outgoing-requests.md +++ b/_docs_use-cases/use-case-consumption-query-outgoing-requests.md @@ -31,6 +31,7 @@ properties: - api_route_regex: get /api/v2/Requests/Outgoing - published: default - link: consumption/query-outgoing-requests + - redirect_from: require: required_by: api_route_regex: ^get /api/v2/Requests/Outgoing$ diff --git a/_docs_use-cases/use-case-consumption-query-settings.md b/_docs_use-cases/use-case-consumption-query-settings.md index e7b3d6e1c..14ccfb775 100644 --- a/_docs_use-cases/use-case-consumption-query-settings.md +++ b/_docs_use-cases/use-case-consumption-query-settings.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: - link: consumption/query-settings + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-consumption-reject-incoming-request.md b/_docs_use-cases/use-case-consumption-reject-incoming-request.md index 9fcc27158..0473bb217 100644 --- a/_docs_use-cases/use-case-consumption-reject-incoming-request.md +++ b/_docs_use-cases/use-case-consumption-reject-incoming-request.md @@ -31,6 +31,7 @@ properties: - api_route_regex: put /api/v2/Requests/Incoming/{id}/Reject - published: default - link: consumption/reject-incoming-request + - redirect_from: require: required_by: api_route_regex: ^put /api/v2/Requests/Incoming/{id}/Reject$ diff --git a/_docs_use-cases/use-case-consumption-set-categorization-of-relationship.md b/_docs_use-cases/use-case-consumption-set-categorization-of-relationship.md index 6b736c531..0e3bed3a1 100644 --- a/_docs_use-cases/use-case-consumption-set-categorization-of-relationship.md +++ b/_docs_use-cases/use-case-consumption-set-categorization-of-relationship.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: - link: consumption/set-categorization-of-relationship + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-consumption-set-status-of-incoming-request-to-check-prerequisites.md b/_docs_use-cases/use-case-consumption-set-status-of-incoming-request-to-check-prerequisites.md index 2bed1f949..513b01e5f 100644 --- a/_docs_use-cases/use-case-consumption-set-status-of-incoming-request-to-check-prerequisites.md +++ b/_docs_use-cases/use-case-consumption-set-status-of-incoming-request-to-check-prerequisites.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: consumption/set-status-of-incoming-request-to-check-prerequisites + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-consumption-set-status-of-incoming-request-to-complete.md b/_docs_use-cases/use-case-consumption-set-status-of-incoming-request-to-complete.md index 25b7db8bc..98b1ea7ae 100644 --- a/_docs_use-cases/use-case-consumption-set-status-of-incoming-request-to-complete.md +++ b/_docs_use-cases/use-case-consumption-set-status-of-incoming-request-to-complete.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: consumption/set-status-of-incoming-request-to-complete + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-consumption-set-status-of-incoming-request-to-received.md b/_docs_use-cases/use-case-consumption-set-status-of-incoming-request-to-received.md index f12bd0a95..625a339e7 100644 --- a/_docs_use-cases/use-case-consumption-set-status-of-incoming-request-to-received.md +++ b/_docs_use-cases/use-case-consumption-set-status-of-incoming-request-to-received.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: consumption/set-status-of-incoming-request-to-received + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-consumption-set-status-of-incoming-request-to-require-manual-decision.md b/_docs_use-cases/use-case-consumption-set-status-of-incoming-request-to-require-manual-decision.md index d39195b6a..0c479cd10 100644 --- a/_docs_use-cases/use-case-consumption-set-status-of-incoming-request-to-require-manual-decision.md +++ b/_docs_use-cases/use-case-consumption-set-status-of-incoming-request-to-require-manual-decision.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: consumption/set-status-of-incoming-request-to-require-manual-decision + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-consumption-set-status-of-outgoing-request-to-complete.md b/_docs_use-cases/use-case-consumption-set-status-of-outgoing-request-to-complete.md index e16d7c489..d4268a179 100644 --- a/_docs_use-cases/use-case-consumption-set-status-of-outgoing-request-to-complete.md +++ b/_docs_use-cases/use-case-consumption-set-status-of-outgoing-request-to-complete.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: consumption/set-status-of-outgoing-request-to-complete + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-consumption-set-status-of-outgoing-request-to-sent.md b/_docs_use-cases/use-case-consumption-set-status-of-outgoing-request-to-sent.md index 462f82d73..07003382a 100644 --- a/_docs_use-cases/use-case-consumption-set-status-of-outgoing-request-to-sent.md +++ b/_docs_use-cases/use-case-consumption-set-status-of-outgoing-request-to-sent.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: consumption/set-status-of-outgoing-request-to-sent + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-consumption-share-attribute.md b/_docs_use-cases/use-case-consumption-share-a-repositoryattribute.md similarity index 63% rename from _docs_use-cases/use-case-consumption-share-attribute.md rename to _docs_use-cases/use-case-consumption-share-a-repositoryattribute.md index 8ae89a82f..e8bc00f9b 100644 --- a/_docs_use-cases/use-case-consumption-share-attribute.md +++ b/_docs_use-cases/use-case-consumption-share-a-repositoryattribute.md @@ -1,7 +1,7 @@ --- -permalink: /use-case-consumption-share-attribute -published: false -title: "Share Attribute" +permalink: /use-case-consumption-share-a-repositoryattribute +published: true +title: "Share a RepositoryAttribute" type: use-case toc: true sidebar: @@ -12,11 +12,11 @@ properties: - component: Runtime - layer: Consumption - facade: AttributesFacade - - function: shareAttribute + - function: shareRepositoryAttribute - description: - feature category: Cross-identity attribute sharing - tech category: Attributes - - status: CHANGES REQUIRED + - status: - documentation status: - comments: - actor: Identity @@ -30,9 +30,10 @@ properties: - changed_at: - api_route_regex: - published: default - - link: consumption/share-attribute + - link: consumption/share-a-repositoryattribute + - redirect_from: require: required_by: --- -{% include use-cases/use-case-consumption-share-attribute.md %} +{% include use-cases/use-case-consumption-share-a-repositoryattribute.md %} diff --git a/_docs_use-cases/use-case-consumption-succeed-a-relationshipattribute-and-notify-peer.md b/_docs_use-cases/use-case-consumption-succeed-a-relationshipattribute-and-notify-peer.md new file mode 100644 index 000000000..d12acf044 --- /dev/null +++ b/_docs_use-cases/use-case-consumption-succeed-a-relationshipattribute-and-notify-peer.md @@ -0,0 +1,39 @@ +--- +permalink: /use-case-consumption-succeed-a-relationshipattribute-and-notify-peer +published: true +title: "Succeed a RelationshipAttribute and notify peer" +type: use-case +toc: true +sidebar: + - title: "Integrate Enmeshed" + nav: "docs_integrate" +properties: + - id: RA17 + - component: Runtime + - layer: Consumption + - facade: AttributesFacade + - function: succeedRelationshipAttributeAndNotifyPeer + - description: + - feature category: Cross-identity attribute sharing + - tech category: Attributes + - status: + - documentation status: + - comments: + - actor: Identity + - trigger: + - precondition: + - result: + - priority: + - complexity: + - size: + - created_at: + - changed_at: + - api_route_regex: + - published: + - link: consumption/succeed-a-relationshipattribute-and-notify-peer + - redirect_from: +require: +required_by: +--- + +{% include use-cases/use-case-consumption-succeed-a-relationshipattribute-and-notify-peer.md %} diff --git a/_docs_use-cases/use-case-consumption-succeed-attribute.md b/_docs_use-cases/use-case-consumption-succeed-a-repositoryattribute.md similarity index 63% rename from _docs_use-cases/use-case-consumption-succeed-attribute.md rename to _docs_use-cases/use-case-consumption-succeed-a-repositoryattribute.md index da69033ec..65e909b46 100644 --- a/_docs_use-cases/use-case-consumption-succeed-attribute.md +++ b/_docs_use-cases/use-case-consumption-succeed-a-repositoryattribute.md @@ -1,7 +1,7 @@ --- -permalink: /use-case-consumption-succeed-attribute -published: false -title: "Succeed Attribute" +permalink: /use-case-consumption-succeed-a-repositoryattribute +published: true +title: "Succeed a RepositoryAttribute" type: use-case toc: true sidebar: @@ -12,11 +12,11 @@ properties: - component: Runtime - layer: Consumption - facade: AttributesFacade - - function: succeedAttribute + - function: succeedRepositoryAttribute - description: - feature category: Cross-identity attribute sharing - tech category: Attributes - - status: QUESTIONS + - status: - documentation status: - comments: - actor: Identity @@ -30,9 +30,10 @@ properties: - changed_at: - api_route_regex: - published: default - - link: consumption/succeed-attribute + - link: consumption/succeed-a-repositoryattribute + - redirect_from: require: required_by: --- -{% include use-cases/use-case-consumption-succeed-attribute.md %} +{% include use-cases/use-case-consumption-succeed-a-repositoryattribute.md %} diff --git a/_docs_use-cases/use-case-consumption-update-attribute.md b/_docs_use-cases/use-case-consumption-update-attribute.md deleted file mode 100644 index 521468159..000000000 --- a/_docs_use-cases/use-case-consumption-update-attribute.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -permalink: /use-case-consumption-update-attribute -published: false -title: "Update Attribute" -type: use-case -toc: true -sidebar: - - title: "Integrate Enmeshed" - nav: "docs_integrate" -properties: - - id: RA12 - - component: Runtime - - layer: Consumption - - facade: AttributesFacade - - function: updateAttribute - - description: - - feature category: Normalized attributes - - tech category: Attributes - - status: CHANGES REQUIRED - - documentation status: - - comments: Will be removed - - actor: Identity - - trigger: - - precondition: - - result: - - priority: HIGH - - complexity: MEDIUM - - size: M - - created_at: - - changed_at: - - api_route_regex: - - published: default - - link: consumption/update-attribute -require: -required_by: ---- - -{% include use-cases/use-case-consumption-update-attribute.md %} diff --git a/_docs_use-cases/use-case-consumption-update-automation-rule.md b/_docs_use-cases/use-case-consumption-update-automation-rule.md index c290d6de9..83a9b35d7 100644 --- a/_docs_use-cases/use-case-consumption-update-automation-rule.md +++ b/_docs_use-cases/use-case-consumption-update-automation-rule.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: - link: consumption/update-automation-rule + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-consumption-update-blueprint.md b/_docs_use-cases/use-case-consumption-update-blueprint.md index 78c751269..eac71765b 100644 --- a/_docs_use-cases/use-case-consumption-update-blueprint.md +++ b/_docs_use-cases/use-case-consumption-update-blueprint.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: - link: consumption/update-blueprint + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-consumption-update-draft.md b/_docs_use-cases/use-case-consumption-update-draft.md index 484ac547d..11b3aad0e 100644 --- a/_docs_use-cases/use-case-consumption-update-draft.md +++ b/_docs_use-cases/use-case-consumption-update-draft.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: - link: consumption/update-draft + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-consumption-update-setting.md b/_docs_use-cases/use-case-consumption-update-setting.md index ee2b8de00..1535135f7 100644 --- a/_docs_use-cases/use-case-consumption-update-setting.md +++ b/_docs_use-cases/use-case-consumption-update-setting.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: - link: consumption/update-setting + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-device-clear-all-profiles.md b/_docs_use-cases/use-case-device-clear-all-profiles.md index e2bbca774..24fd253c3 100644 --- a/_docs_use-cases/use-case-device-clear-all-profiles.md +++ b/_docs_use-cases/use-case-device-clear-all-profiles.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: device/clear-all-profiles + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-device-configure_-config-property.md b/_docs_use-cases/use-case-device-configure_-config-property.md index 0ecfb6d44..eea31b7e9 100644 --- a/_docs_use-cases/use-case-device-configure_-config-property.md +++ b/_docs_use-cases/use-case-device-configure_-config-property.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: device/configure-config-property + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-device-create-profile-with-new-identity.md b/_docs_use-cases/use-case-device-create-profile-with-new-identity.md index 7c90b9e17..6ccd47124 100644 --- a/_docs_use-cases/use-case-device-create-profile-with-new-identity.md +++ b/_docs_use-cases/use-case-device-create-profile-with-new-identity.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: device/create-profile-with-new-identity + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-device-delete_-rest-endpoint.md b/_docs_use-cases/use-case-device-delete_-rest-endpoint.md index 7385cb186..b4173d7ba 100644 --- a/_docs_use-cases/use-case-device-delete_-rest-endpoint.md +++ b/_docs_use-cases/use-case-device-delete_-rest-endpoint.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: device/delete-rest-endpoint + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-device-get-appruntime-health-status.md b/_docs_use-cases/use-case-device-get-appruntime-health-status.md index ee0b13d82..6bc6ce7f1 100644 --- a/_docs_use-cases/use-case-device-get-appruntime-health-status.md +++ b/_docs_use-cases/use-case-device-get-appruntime-health-status.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: device/get-appruntime-health-status + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-device-get-appruntime-version-information.md b/_docs_use-cases/use-case-device-get-appruntime-version-information.md index b6da96d9f..91e34b60f 100644 --- a/_docs_use-cases/use-case-device-get-appruntime-version-information.md +++ b/_docs_use-cases/use-case-device-get-appruntime-version-information.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: device/get-appruntime-version-information + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-device-get-profile-by-enmeshed-address.md b/_docs_use-cases/use-case-device-get-profile-by-enmeshed-address.md index 8b194a651..18b486069 100644 --- a/_docs_use-cases/use-case-device-get-profile-by-enmeshed-address.md +++ b/_docs_use-cases/use-case-device-get-profile-by-enmeshed-address.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: device/get-profile-by-enmeshed-address + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-device-get-profile.md b/_docs_use-cases/use-case-device-get-profile.md index a5efa1bef..ee61ccc47 100644 --- a/_docs_use-cases/use-case-device-get-profile.md +++ b/_docs_use-cases/use-case-device-get-profile.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: device/get-profile + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-device-get-profiles.md b/_docs_use-cases/use-case-device-get-profiles.md index 53be820c6..b960789a6 100644 --- a/_docs_use-cases/use-case-device-get-profiles.md +++ b/_docs_use-cases/use-case-device-get-profiles.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: device/get-profiles + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-device-get-support-information.md b/_docs_use-cases/use-case-device-get-support-information.md index f25868317..13b6a7b1b 100644 --- a/_docs_use-cases/use-case-device-get-support-information.md +++ b/_docs_use-cases/use-case-device-get-support-information.md @@ -31,6 +31,7 @@ properties: - api_route_regex: GET /Monitoring/Support - published: default - link: device/get-support-information + - redirect_from: require: required_by: api_route_regex: ^GET /Monitoring/Support$ diff --git a/_docs_use-cases/use-case-device-get-the-connector-health-status.md b/_docs_use-cases/use-case-device-get-the-connector-health-status.md index f02494f32..d0fecf55c 100644 --- a/_docs_use-cases/use-case-device-get-the-connector-health-status.md +++ b/_docs_use-cases/use-case-device-get-the-connector-health-status.md @@ -31,6 +31,7 @@ properties: - api_route_regex: GET /health - published: default - link: device/get-the-connector-health-status + - redirect_from: require: required_by: api_route_regex: ^GET /health$ diff --git a/_docs_use-cases/use-case-device-get-the-connector-version-information.md b/_docs_use-cases/use-case-device-get-the-connector-version-information.md index 0fce69c56..595d60dd7 100644 --- a/_docs_use-cases/use-case-device-get-the-connector-version-information.md +++ b/_docs_use-cases/use-case-device-get-the-connector-version-information.md @@ -31,6 +31,7 @@ properties: - api_route_regex: GET /Monitoring/Version - published: default - link: device/get-the-connector-version-information + - redirect_from: require: required_by: api_route_regex: ^GET /Monitoring/Version$ diff --git a/_docs_use-cases/use-case-device-get-the-number-of-requests-and-the-status-codes-that-were-returned-by-the-connector.md b/_docs_use-cases/use-case-device-get-the-number-of-requests-and-the-status-codes-that-were-returned-by-the-connector.md index 6fd041531..79defef0c 100644 --- a/_docs_use-cases/use-case-device-get-the-number-of-requests-and-the-status-codes-that-were-returned-by-the-connector.md +++ b/_docs_use-cases/use-case-device-get-the-number-of-requests-and-the-status-codes-that-were-returned-by-the-connector.md @@ -31,6 +31,7 @@ properties: - api_route_regex: GET /Monitoring/Requests - published: default - link: device/get-the-number-of-requests-and-the-status-codes-that-were-returned-by-the-connector + - redirect_from: require: required_by: api_route_regex: ^GET /Monitoring/Requests$ diff --git a/_docs_use-cases/use-case-device-get_-rest-endpoint.md b/_docs_use-cases/use-case-device-get_-rest-endpoint.md index d48f80412..824416925 100644 --- a/_docs_use-cases/use-case-device-get_-rest-endpoint.md +++ b/_docs_use-cases/use-case-device-get_-rest-endpoint.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: device/get-rest-endpoint + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-device-onboard-device-by-device-onboarding-token.md b/_docs_use-cases/use-case-device-onboard-device-by-device-onboarding-token.md index 5783b9a60..b23b08d6b 100644 --- a/_docs_use-cases/use-case-device-onboard-device-by-device-onboarding-token.md +++ b/_docs_use-cases/use-case-device-onboard-device-by-device-onboarding-token.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: device/onboard-device-by-device-onboarding-token + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-device-post_-rest-endpoint.md b/_docs_use-cases/use-case-device-post_-rest-endpoint.md index 7963cb3a9..033605f1c 100644 --- a/_docs_use-cases/use-case-device-post_-rest-endpoint.md +++ b/_docs_use-cases/use-case-device-post_-rest-endpoint.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: device/post-rest-endpoint + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-device-put_-rest-endpoint.md b/_docs_use-cases/use-case-device-put_-rest-endpoint.md index c21a7e5c2..6321cdf71 100644 --- a/_docs_use-cases/use-case-device-put_-rest-endpoint.md +++ b/_docs_use-cases/use-case-device-put_-rest-endpoint.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: device/put-rest-endpoint + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-device-rename-profile.md b/_docs_use-cases/use-case-device-rename-profile.md index 77646b7b2..2cc5b3fe9 100644 --- a/_docs_use-cases/use-case-device-rename-profile.md +++ b/_docs_use-cases/use-case-device-rename-profile.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: device/rename-profile + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-device-restore-identity-by-recovery-data.md b/_docs_use-cases/use-case-device-restore-identity-by-recovery-data.md index e835eeecb..f36e0f6df 100644 --- a/_docs_use-cases/use-case-device-restore-identity-by-recovery-data.md +++ b/_docs_use-cases/use-case-device-restore-identity-by-recovery-data.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: - link: device/restore-identity-by-recovery-data + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-device-select-profile---profile-login---create-profile-session.md b/_docs_use-cases/use-case-device-select-profile---profile-login---create-profile-session.md index d424d1108..189b9fcbd 100644 --- a/_docs_use-cases/use-case-device-select-profile---profile-login---create-profile-session.md +++ b/_docs_use-cases/use-case-device-select-profile---profile-login---create-profile-session.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: device/select-profile-/-profile-login-/-create-profile-session + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-device-set-up-global-exception-handling.md b/_docs_use-cases/use-case-device-set-up-global-exception-handling.md index fa40f82ec..d7cb522a0 100644 --- a/_docs_use-cases/use-case-device-set-up-global-exception-handling.md +++ b/_docs_use-cases/use-case-device-set-up-global-exception-handling.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: device/set-up-global-exception-handling + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-device-set-up-or-change-auto-logout-of-profile.md b/_docs_use-cases/use-case-device-set-up-or-change-auto-logout-of-profile.md index 220fc9fec..18ecd852d 100644 --- a/_docs_use-cases/use-case-device-set-up-or-change-auto-logout-of-profile.md +++ b/_docs_use-cases/use-case-device-set-up-or-change-auto-logout-of-profile.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: - link: device/set-up-or-change-auto-logout-of-profile + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-device-set-up-or-change-password-of-profile.md b/_docs_use-cases/use-case-device-set-up-or-change-password-of-profile.md index 1ad3693d2..1443c779a 100644 --- a/_docs_use-cases/use-case-device-set-up-or-change-password-of-profile.md +++ b/_docs_use-cases/use-case-device-set-up-or-change-password-of-profile.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: - link: device/set-up-or-change-password-of-profile + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-human-cancel_-action.md b/_docs_use-cases/use-case-human-cancel_-action.md index 83a34ae6b..b366414cd 100644 --- a/_docs_use-cases/use-case-human-cancel_-action.md +++ b/_docs_use-cases/use-case-human-cancel_-action.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: human/cancel-action + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-human-device_-external-usecase.md b/_docs_use-cases/use-case-human-device_-external-usecase.md index 22d7be885..6444c3f5b 100644 --- a/_docs_use-cases/use-case-human-device_-external-usecase.md +++ b/_docs_use-cases/use-case-human-device_-external-usecase.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: human/device-external-usecase + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-human-enter_-data-on-screen.md b/_docs_use-cases/use-case-human-enter_-data-on-screen.md index cfb9e4da1..0477616ec 100644 --- a/_docs_use-cases/use-case-human-enter_-data-on-screen.md +++ b/_docs_use-cases/use-case-human-enter_-data-on-screen.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: human/enter-data-on-screen + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-human-navigate-to-screen_-screen.md b/_docs_use-cases/use-case-human-navigate-to-screen_-screen.md index e9be69054..1ea12443a 100644 --- a/_docs_use-cases/use-case-human-navigate-to-screen_-screen.md +++ b/_docs_use-cases/use-case-human-navigate-to-screen_-screen.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: human/navigate-to-screen-screen + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-human-negative_-action.md b/_docs_use-cases/use-case-human-negative_-action.md index ca8239484..8d3e91082 100644 --- a/_docs_use-cases/use-case-human-negative_-action.md +++ b/_docs_use-cases/use-case-human-negative_-action.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: human/negative-action + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-human-positive_-action.md b/_docs_use-cases/use-case-human-positive_-action.md index a3db30619..b67bd7630 100644 --- a/_docs_use-cases/use-case-human-positive_-action.md +++ b/_docs_use-cases/use-case-human-positive_-action.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: human/positive-action + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-human-scan_-qr-code-on-different-device.md b/_docs_use-cases/use-case-human-scan_-qr-code-on-different-device.md index e91f33083..2a5b37b23 100644 --- a/_docs_use-cases/use-case-human-scan_-qr-code-on-different-device.md +++ b/_docs_use-cases/use-case-human-scan_-qr-code-on-different-device.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: human/scan-qr-code-on-different-device + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-human-select_-item-on-screen.md b/_docs_use-cases/use-case-human-select_-item-on-screen.md index 60524f5ff..85d8e6185 100644 --- a/_docs_use-cases/use-case-human-select_-item-on-screen.md +++ b/_docs_use-cases/use-case-human-select_-item-on-screen.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: human/select-item-on-screen + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-transport-accept-relationship-change.md b/_docs_use-cases/use-case-transport-accept-relationship-change.md index 6f9a46472..1bc7f58b4 100644 --- a/_docs_use-cases/use-case-transport-accept-relationship-change.md +++ b/_docs_use-cases/use-case-transport-accept-relationship-change.md @@ -31,6 +31,7 @@ properties: - api_route_regex: PUT /api/v2/Relationships/{id}/Changes/{changeId}/Accept - published: default - link: transport/accept-relationship-change + - redirect_from: require: required_by: api_route_regex: ^PUT /api/v2/Relationships/{id}/Changes/{changeId}/Accept$ diff --git a/_docs_use-cases/use-case-transport-approve-deletion-of-identity.md b/_docs_use-cases/use-case-transport-approve-deletion-of-identity.md index c618fa622..5f5a15e28 100644 --- a/_docs_use-cases/use-case-transport-approve-deletion-of-identity.md +++ b/_docs_use-cases/use-case-transport-approve-deletion-of-identity.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: - link: transport/approve-deletion-of-identity + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-transport-cancel-identity-deletion-within-grace-period.md b/_docs_use-cases/use-case-transport-cancel-identity-deletion-within-grace-period.md index 5008bfe3f..6cdec49ea 100644 --- a/_docs_use-cases/use-case-transport-cancel-identity-deletion-within-grace-period.md +++ b/_docs_use-cases/use-case-transport-cancel-identity-deletion-within-grace-period.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: - link: transport/cancel-identity-deletion-within-grace-period + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-transport-check-identity-by-address.md b/_docs_use-cases/use-case-transport-check-identity-by-address.md index 5ca2260f7..cc5ba438a 100644 --- a/_docs_use-cases/use-case-transport-check-identity-by-address.md +++ b/_docs_use-cases/use-case-transport-check-identity-by-address.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: transport/check-identity-by-address + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-transport-create-challenge.md b/_docs_use-cases/use-case-transport-create-challenge.md index 7ead555be..cf3b4ddfb 100644 --- a/_docs_use-cases/use-case-transport-create-challenge.md +++ b/_docs_use-cases/use-case-transport-create-challenge.md @@ -31,6 +31,7 @@ properties: - api_route_regex: POST /api/v2/Challenges - published: - link: transport/create-challenge + - redirect_from: require: required_by: api_route_regex: ^POST /api/v2/Challenges$ diff --git a/_docs_use-cases/use-case-transport-create-device.md b/_docs_use-cases/use-case-transport-create-device.md index 5d250ff47..376b05a18 100644 --- a/_docs_use-cases/use-case-transport-create-device.md +++ b/_docs_use-cases/use-case-transport-create-device.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: transport/create-device + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-transport-create-identity-recovery-data.md b/_docs_use-cases/use-case-transport-create-identity-recovery-data.md index 7346153d8..3055a0752 100644 --- a/_docs_use-cases/use-case-transport-create-identity-recovery-data.md +++ b/_docs_use-cases/use-case-transport-create-identity-recovery-data.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: - link: transport/create-identity-recovery-data + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-transport-create-own-relationshiptemplate.md b/_docs_use-cases/use-case-transport-create-own-relationshiptemplate.md index 76f35d8e6..bc5167395 100644 --- a/_docs_use-cases/use-case-transport-create-own-relationshiptemplate.md +++ b/_docs_use-cases/use-case-transport-create-own-relationshiptemplate.md @@ -31,6 +31,7 @@ properties: - api_route_regex: POST /api/v2/RelationshipTemplates/Own - published: default - link: transport/create-own-relationshiptemplate + - redirect_from: require: required_by: api_route_regex: ^POST /api/v2/RelationshipTemplates/Own$ diff --git a/_docs_use-cases/use-case-transport-create-own-token.md b/_docs_use-cases/use-case-transport-create-own-token.md index 374358db1..84d44a6aa 100644 --- a/_docs_use-cases/use-case-transport-create-own-token.md +++ b/_docs_use-cases/use-case-transport-create-own-token.md @@ -31,6 +31,7 @@ properties: - api_route_regex: POST /api/v2/Tokens/Own - published: default - link: transport/create-own-token + - redirect_from: require: required_by: api_route_regex: ^POST /api/v2/Tokens/Own$ diff --git a/_docs_use-cases/use-case-transport-create-qrcode-for-file.md b/_docs_use-cases/use-case-transport-create-qrcode-for-file.md index 01f764437..3cabde9af 100644 --- a/_docs_use-cases/use-case-transport-create-qrcode-for-file.md +++ b/_docs_use-cases/use-case-transport-create-qrcode-for-file.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: transport/create-qrcode-for-file + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-transport-create-qrcode-for-own-relationship-template.md b/_docs_use-cases/use-case-transport-create-qrcode-for-own-relationship-template.md index 815876000..731e25ae7 100644 --- a/_docs_use-cases/use-case-transport-create-qrcode-for-own-relationship-template.md +++ b/_docs_use-cases/use-case-transport-create-qrcode-for-own-relationship-template.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: transport/create-qrcode-for-own-relationship-template + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-transport-create-relationship-with-relationshiptemplate.md b/_docs_use-cases/use-case-transport-create-relationship-with-relationshiptemplate.md index ab62330c9..6a88de64f 100644 --- a/_docs_use-cases/use-case-transport-create-relationship-with-relationshiptemplate.md +++ b/_docs_use-cases/use-case-transport-create-relationship-with-relationshiptemplate.md @@ -31,6 +31,7 @@ properties: - api_route_regex: POST /api/v2/Relationships - published: default - link: transport/create-relationship-with-relationshiptemplate + - redirect_from: require: required_by: api_route_regex: ^POST /api/v2/Relationships$ 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 index 42e59535e..23ca13230 100644 --- a/_docs_use-cases/use-case-transport-create-token-for-file.md +++ b/_docs_use-cases/use-case-transport-create-token-for-file.md @@ -31,6 +31,7 @@ properties: - api_route_regex: POST /api/v2/Files/{id}/Token - published: default - link: transport/create-token-for-file + - redirect_from: require: required_by: api_route_regex: ^POST /api/v2/Files/{id}/Token$ diff --git a/_docs_use-cases/use-case-transport-create-token-for-own-relationship-template.md b/_docs_use-cases/use-case-transport-create-token-for-own-relationship-template.md index 0774d75ca..39aeb2cc3 100644 --- a/_docs_use-cases/use-case-transport-create-token-for-own-relationship-template.md +++ b/_docs_use-cases/use-case-transport-create-token-for-own-relationship-template.md @@ -31,6 +31,7 @@ properties: - api_route_regex: POST /api/v2/RelationshipTemplates/Own/{id}/Token - published: default - link: transport/create-token-for-own-relationship-template + - redirect_from: require: required_by: api_route_regex: ^POST /api/v2/RelationshipTemplates/Own/{id}/Token$ diff --git a/_docs_use-cases/use-case-transport-create-token-qrcode-for-file.md b/_docs_use-cases/use-case-transport-create-token-qrcode-for-file.md index 1da8ab63e..b56949bf6 100644 --- a/_docs_use-cases/use-case-transport-create-token-qrcode-for-file.md +++ b/_docs_use-cases/use-case-transport-create-token-qrcode-for-file.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: transport/create-token-qrcode-for-file + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-transport-create-token-qrcode-for-own-relationship-template.md b/_docs_use-cases/use-case-transport-create-token-qrcode-for-own-relationship-template.md index 7a95e8c75..040506c91 100644 --- a/_docs_use-cases/use-case-transport-create-token-qrcode-for-own-relationship-template.md +++ b/_docs_use-cases/use-case-transport-create-token-qrcode-for-own-relationship-template.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: transport/create-token-qrcode-for-own-relationship-template + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-transport-delete-device-which-is-not-onboarded-yet.md b/_docs_use-cases/use-case-transport-delete-device-which-is-not-onboarded-yet.md index d321e3473..72f28d02c 100644 --- a/_docs_use-cases/use-case-transport-delete-device-which-is-not-onboarded-yet.md +++ b/_docs_use-cases/use-case-transport-delete-device-which-is-not-onboarded-yet.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: transport/delete-device-which-is-not-onboarded-yet + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-transport-disable-automated-datawallet-synchronization-with-backbone.md b/_docs_use-cases/use-case-transport-disable-automated-datawallet-synchronization-with-backbone.md index 66ec8f916..2f174e564 100644 --- a/_docs_use-cases/use-case-transport-disable-automated-datawallet-synchronization-with-backbone.md +++ b/_docs_use-cases/use-case-transport-disable-automated-datawallet-synchronization-with-backbone.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: transport/disable-automated-datawallet-synchronization-with-backbone + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-transport-download-file-of-attachment.md b/_docs_use-cases/use-case-transport-download-file-of-attachment.md index 3d28e683d..1ae94acfa 100644 --- a/_docs_use-cases/use-case-transport-download-file-of-attachment.md +++ b/_docs_use-cases/use-case-transport-download-file-of-attachment.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: transport/download-file-of-attachment + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-transport-download-file.md b/_docs_use-cases/use-case-transport-download-file.md index fca75eb5c..e3db5da1c 100644 --- a/_docs_use-cases/use-case-transport-download-file.md +++ b/_docs_use-cases/use-case-transport-download-file.md @@ -31,6 +31,7 @@ properties: - api_route_regex: GET /api/v2/Files/{id}/Download - published: default - link: transport/download-file + - redirect_from: require: required_by: api_route_regex: ^GET /api/v2/Files/{id}/Download$ diff --git a/_docs_use-cases/use-case-transport-enable-automated-datawallet-synchronization-with-backbone.md b/_docs_use-cases/use-case-transport-enable-automated-datawallet-synchronization-with-backbone.md index e8f777f1b..8b9ea4bd7 100644 --- a/_docs_use-cases/use-case-transport-enable-automated-datawallet-synchronization-with-backbone.md +++ b/_docs_use-cases/use-case-transport-enable-automated-datawallet-synchronization-with-backbone.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: transport/enable-automated-datawallet-synchronization-with-backbone + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-transport-get-attributes-for-relationship.md b/_docs_use-cases/use-case-transport-get-attributes-for-relationship.md index 9225ed67f..dd44db5b0 100644 --- a/_docs_use-cases/use-case-transport-get-attributes-for-relationship.md +++ b/_docs_use-cases/use-case-transport-get-attributes-for-relationship.md @@ -31,6 +31,7 @@ properties: - api_route_regex: GET /api/v2/Relationships/{id}/Attributes - published: default - link: transport/get-attributes-for-relationship + - redirect_from: require: required_by: api_route_regex: ^GET /api/v2/Relationships/{id}/Attributes$ diff --git a/_docs_use-cases/use-case-transport-get-currently-used-device.md b/_docs_use-cases/use-case-transport-get-currently-used-device.md index f501ffabd..48d01bcc7 100644 --- a/_docs_use-cases/use-case-transport-get-currently-used-device.md +++ b/_docs_use-cases/use-case-transport-get-currently-used-device.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: transport/get-currently-used-device + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-transport-get-currently-used-identity.md b/_docs_use-cases/use-case-transport-get-currently-used-identity.md index 34f251a5a..b9191d94a 100644 --- a/_docs_use-cases/use-case-transport-get-currently-used-identity.md +++ b/_docs_use-cases/use-case-transport-get-currently-used-identity.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: transport/get-currently-used-identity + - redirect_from: require: required_by: --- 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 index 9030cb9fc..e0b514117 100644 --- a/_docs_use-cases/use-case-transport-get-device-onboarding-info.md +++ b/_docs_use-cases/use-case-transport-get-device-onboarding-info.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: transport/get-device-onboarding-info + - redirect_from: require: required_by: --- 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 index 52ab2e426..0e3650f77 100644 --- a/_docs_use-cases/use-case-transport-get-device-onboarding-token.md +++ b/_docs_use-cases/use-case-transport-get-device-onboarding-token.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: transport/get-device-onboarding-token + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-transport-get-device.md b/_docs_use-cases/use-case-transport-get-device.md index 0c84eeb33..61be45305 100644 --- a/_docs_use-cases/use-case-transport-get-device.md +++ b/_docs_use-cases/use-case-transport-get-device.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: transport/get-device + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-transport-get-file-metadata-of-attachment.md b/_docs_use-cases/use-case-transport-get-file-metadata-of-attachment.md index 5b9145f5b..8d8be53ce 100644 --- a/_docs_use-cases/use-case-transport-get-file-metadata-of-attachment.md +++ b/_docs_use-cases/use-case-transport-get-file-metadata-of-attachment.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: transport/get-file-metadata-of-attachment + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-transport-get-message-by-messageid.md b/_docs_use-cases/use-case-transport-get-message-by-messageid.md index 26f0e04bf..6f6e2e3e4 100644 --- a/_docs_use-cases/use-case-transport-get-message-by-messageid.md +++ b/_docs_use-cases/use-case-transport-get-message-by-messageid.md @@ -31,6 +31,7 @@ properties: - api_route_regex: GET /api/v2/Messages/{id} - published: default - link: transport/get-message-by-messageid + - redirect_from: require: required_by: api_route_regex: ^GET /api/v2/Messages/{id}$ 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 index a5bd7e98d..c5ec578d4 100644 --- a/_docs_use-cases/use-case-transport-get-or-load-file.md +++ b/_docs_use-cases/use-case-transport-get-or-load-file.md @@ -31,6 +31,7 @@ properties: - api_route_regex: GET /api/v2/Files/{idOrReference} - published: default - link: transport/get-or-load-file + - redirect_from: require: required_by: api_route_regex: ^GET /api/v2/Files/{idOrReference}$ diff --git a/_docs_use-cases/use-case-transport-get-own-file.md b/_docs_use-cases/use-case-transport-get-own-file.md index 4bb6272bc..13da112e7 100644 --- a/_docs_use-cases/use-case-transport-get-own-file.md +++ b/_docs_use-cases/use-case-transport-get-own-file.md @@ -31,6 +31,7 @@ properties: - api_route_regex: GET /api/v2/Files/Own - published: default - link: transport/get-own-file + - redirect_from: require: required_by: api_route_regex: ^GET /api/v2/Files/Own$ diff --git a/_docs_use-cases/use-case-transport-get-qrcode-for-single-token.md b/_docs_use-cases/use-case-transport-get-qrcode-for-single-token.md index 938354c75..39db01641 100644 --- a/_docs_use-cases/use-case-transport-get-qrcode-for-single-token.md +++ b/_docs_use-cases/use-case-transport-get-qrcode-for-single-token.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: transport/get-qrcode-for-single-token + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-transport-get-relationship-by-address.md b/_docs_use-cases/use-case-transport-get-relationship-by-address.md index ae6aad939..64f49b62f 100644 --- a/_docs_use-cases/use-case-transport-get-relationship-by-address.md +++ b/_docs_use-cases/use-case-transport-get-relationship-by-address.md @@ -31,6 +31,7 @@ properties: - api_route_regex: GET /api/v2/Relationships - published: default - link: transport/get-relationship-by-address + - redirect_from: require: required_by: api_route_regex: ^GET /api/v2/Relationships$ diff --git a/_docs_use-cases/use-case-transport-get-relationship-by-relationshipid.md b/_docs_use-cases/use-case-transport-get-relationship-by-relationshipid.md index ab4b85f48..4cdeecade 100644 --- a/_docs_use-cases/use-case-transport-get-relationship-by-relationshipid.md +++ b/_docs_use-cases/use-case-transport-get-relationship-by-relationshipid.md @@ -31,6 +31,7 @@ properties: - api_route_regex: GET /api/v2/Relationships/{id} - published: default - link: transport/get-relationship-by-relationshipid + - redirect_from: require: required_by: api_route_regex: ^GET /api/v2/Relationships/{id}$ diff --git a/_docs_use-cases/use-case-transport-get-relationship-template.md b/_docs_use-cases/use-case-transport-get-relationship-template.md index 1a794d613..f1919c1c1 100644 --- a/_docs_use-cases/use-case-transport-get-relationship-template.md +++ b/_docs_use-cases/use-case-transport-get-relationship-template.md @@ -31,6 +31,7 @@ properties: - api_route_regex: GET /api/v2/RelationshipTemplates/{id} - published: default - link: transport/get-relationship-template + - redirect_from: require: required_by: api_route_regex: ^GET /api/v2/RelationshipTemplates/{id}$ diff --git a/_docs_use-cases/use-case-transport-get-synchronization-status-with-backbone.md b/_docs_use-cases/use-case-transport-get-synchronization-status-with-backbone.md index 63a37dc8d..2e5cf57a6 100644 --- a/_docs_use-cases/use-case-transport-get-synchronization-status-with-backbone.md +++ b/_docs_use-cases/use-case-transport-get-synchronization-status-with-backbone.md @@ -31,6 +31,7 @@ properties: - api_route_regex: GET /api/v2/Account/getSyncInfo - published: default - link: transport/get-synchronization-status-with-backbone + - redirect_from: require: required_by: api_route_regex: ^GET /api/v2/Account/getSyncInfo$ diff --git a/_docs_use-cases/use-case-transport-get-token-by-tokenid.md b/_docs_use-cases/use-case-transport-get-token-by-tokenid.md index 1eb38c1fb..72d4965c4 100644 --- a/_docs_use-cases/use-case-transport-get-token-by-tokenid.md +++ b/_docs_use-cases/use-case-transport-get-token-by-tokenid.md @@ -31,6 +31,7 @@ properties: - api_route_regex: GET /api/v2/Tokens/{id} - published: default - link: transport/get-token-by-tokenid + - redirect_from: require: required_by: api_route_regex: ^GET /api/v2/Tokens/{id}$ diff --git a/_docs_use-cases/use-case-transport-load-item-from-truncated-reference.md b/_docs_use-cases/use-case-transport-load-item-from-truncated-reference.md index 6036c2924..0913f020d 100644 --- a/_docs_use-cases/use-case-transport-load-item-from-truncated-reference.md +++ b/_docs_use-cases/use-case-transport-load-item-from-truncated-reference.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: transport/load-item-from-truncated-reference + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-transport-load-relationship-template-created-by-others.md b/_docs_use-cases/use-case-transport-load-relationship-template-created-by-others.md index b0eca8ff2..b2c352e8e 100644 --- a/_docs_use-cases/use-case-transport-load-relationship-template-created-by-others.md +++ b/_docs_use-cases/use-case-transport-load-relationship-template-created-by-others.md @@ -31,6 +31,7 @@ properties: - api_route_regex: POST /api/v2/RelationshipTemplates/Peer - published: default - link: transport/load-relationship-template-created-by-others + - redirect_from: require: required_by: api_route_regex: ^POST /api/v2/RelationshipTemplates/Peer$ 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 index a31d4886b..faef70906 100644 --- 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 @@ -31,6 +31,7 @@ properties: - api_route_regex: POST /api/v2/Tokens/Peer - published: default - link: transport/load-token-created-by-others + - redirect_from: require: required_by: api_route_regex: ^POST /api/v2/Tokens/Peer$ diff --git a/_docs_use-cases/use-case-transport-notify-backbone-of-unauthorized-profile-access.md b/_docs_use-cases/use-case-transport-notify-backbone-of-unauthorized-profile-access.md index c3b20cedd..0b5268993 100644 --- a/_docs_use-cases/use-case-transport-notify-backbone-of-unauthorized-profile-access.md +++ b/_docs_use-cases/use-case-transport-notify-backbone-of-unauthorized-profile-access.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: - link: transport/notify-backbone-of-unauthorized-profile-access + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-transport-query-devices.md b/_docs_use-cases/use-case-transport-query-devices.md index 609f07b43..a80a38256 100644 --- a/_docs_use-cases/use-case-transport-query-devices.md +++ b/_docs_use-cases/use-case-transport-query-devices.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: transport/query-devices + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-transport-query-files.md b/_docs_use-cases/use-case-transport-query-files.md index 06cc404f5..8578f2871 100644 --- a/_docs_use-cases/use-case-transport-query-files.md +++ b/_docs_use-cases/use-case-transport-query-files.md @@ -31,6 +31,7 @@ properties: - api_route_regex: GET /api/v2/Files - published: default - link: transport/query-files + - redirect_from: require: required_by: api_route_regex: ^GET /api/v2/Files$ diff --git a/_docs_use-cases/use-case-transport-query-messages.md b/_docs_use-cases/use-case-transport-query-messages.md index 1842bc9d7..600995879 100644 --- a/_docs_use-cases/use-case-transport-query-messages.md +++ b/_docs_use-cases/use-case-transport-query-messages.md @@ -31,6 +31,7 @@ properties: - api_route_regex: GET /api/v2/Messages - published: default - link: transport/query-messages + - redirect_from: require: required_by: api_route_regex: ^GET /api/v2/Messages$ diff --git a/_docs_use-cases/use-case-transport-query-relationship-templates.md b/_docs_use-cases/use-case-transport-query-relationship-templates.md index d2e910e07..8a21d32c6 100644 --- a/_docs_use-cases/use-case-transport-query-relationship-templates.md +++ b/_docs_use-cases/use-case-transport-query-relationship-templates.md @@ -31,6 +31,7 @@ properties: - api_route_regex: GET /api/v2/RelationshipTemplates - published: default - link: transport/query-relationship-templates + - redirect_from: require: required_by: api_route_regex: ^GET /api/v2/RelationshipTemplates$ diff --git a/_docs_use-cases/use-case-transport-query-relationships.md b/_docs_use-cases/use-case-transport-query-relationships.md index 7f08da9b0..ebf99dde2 100644 --- a/_docs_use-cases/use-case-transport-query-relationships.md +++ b/_docs_use-cases/use-case-transport-query-relationships.md @@ -31,6 +31,7 @@ properties: - api_route_regex: GET /api/v2/Relationships - published: default - link: transport/query-relationships + - redirect_from: require: required_by: api_route_regex: ^GET /api/v2/Relationships$ diff --git a/_docs_use-cases/use-case-transport-query-tokens-by-parameters.md b/_docs_use-cases/use-case-transport-query-tokens-by-parameters.md index beb494c86..32eaa8242 100644 --- a/_docs_use-cases/use-case-transport-query-tokens-by-parameters.md +++ b/_docs_use-cases/use-case-transport-query-tokens-by-parameters.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: transport/query-tokens-by-parameters + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-transport-query-used-backbone-quota.md b/_docs_use-cases/use-case-transport-query-used-backbone-quota.md index 725a0622d..4f14e9f7f 100644 --- a/_docs_use-cases/use-case-transport-query-used-backbone-quota.md +++ b/_docs_use-cases/use-case-transport-query-used-backbone-quota.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: - link: transport/query-used-backbone-quota + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-transport-register-pushnotificationtoken-at-backbone.md b/_docs_use-cases/use-case-transport-register-pushnotificationtoken-at-backbone.md index 746ee6547..daf70195a 100644 --- a/_docs_use-cases/use-case-transport-register-pushnotificationtoken-at-backbone.md +++ b/_docs_use-cases/use-case-transport-register-pushnotificationtoken-at-backbone.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: transport/register-pushnotificationtoken-at-backbone + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-transport-reject-relationship-change.md b/_docs_use-cases/use-case-transport-reject-relationship-change.md index 8a5482962..24f8dee72 100644 --- a/_docs_use-cases/use-case-transport-reject-relationship-change.md +++ b/_docs_use-cases/use-case-transport-reject-relationship-change.md @@ -31,6 +31,7 @@ properties: - api_route_regex: PUT /api/v2/Relationships/{id}/Changes/{changeId}/Reject - published: default - link: transport/reject-relationship-change + - redirect_from: require: required_by: api_route_regex: ^PUT /api/v2/Relationships/{id}/Changes/{changeId}/Reject$ diff --git a/_docs_use-cases/use-case-transport-remove-profile-from-device.md b/_docs_use-cases/use-case-transport-remove-profile-from-device.md index 674ac3710..1131027b0 100644 --- a/_docs_use-cases/use-case-transport-remove-profile-from-device.md +++ b/_docs_use-cases/use-case-transport-remove-profile-from-device.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: - link: transport/remove-profile-from-device + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-transport-request-deletion-of-identity.md b/_docs_use-cases/use-case-transport-request-deletion-of-identity.md index 276d68e78..6531bdc12 100644 --- a/_docs_use-cases/use-case-transport-request-deletion-of-identity.md +++ b/_docs_use-cases/use-case-transport-request-deletion-of-identity.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: - link: transport/request-deletion-of-identity + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-transport-revoke-relationship-change.md b/_docs_use-cases/use-case-transport-revoke-relationship-change.md index 142831881..3b8bc3322 100644 --- a/_docs_use-cases/use-case-transport-revoke-relationship-change.md +++ b/_docs_use-cases/use-case-transport-revoke-relationship-change.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: transport/revoke-relationship-change + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-transport-send-message-to-recipients.md b/_docs_use-cases/use-case-transport-send-message-to-recipients.md index 776ead4b7..c3a9074f9 100644 --- a/_docs_use-cases/use-case-transport-send-message-to-recipients.md +++ b/_docs_use-cases/use-case-transport-send-message-to-recipients.md @@ -31,6 +31,7 @@ properties: - api_route_regex: POST /api/v2/Messages - published: default - link: transport/send-message-to-recipients + - redirect_from: require: required_by: api_route_regex: ^POST /api/v2/Messages$ diff --git a/_docs_use-cases/use-case-transport-synchronize-datawallet-updates-to-backbone.md b/_docs_use-cases/use-case-transport-synchronize-datawallet-updates-to-backbone.md index 7de784e48..5bd8a112a 100644 --- a/_docs_use-cases/use-case-transport-synchronize-datawallet-updates-to-backbone.md +++ b/_docs_use-cases/use-case-transport-synchronize-datawallet-updates-to-backbone.md @@ -31,6 +31,7 @@ properties: - api_route_regex: POST /api/v2/Account/Sync - published: default - link: transport/synchronize-datawallet-updates-to-backbone + - redirect_from: require: required_by: api_route_regex: ^POST /api/v2/Account/Sync$ diff --git a/_docs_use-cases/use-case-transport-synchronize-updates-of-backbone.md b/_docs_use-cases/use-case-transport-synchronize-updates-of-backbone.md index 2fd991fda..00821367e 100644 --- a/_docs_use-cases/use-case-transport-synchronize-updates-of-backbone.md +++ b/_docs_use-cases/use-case-transport-synchronize-updates-of-backbone.md @@ -31,6 +31,7 @@ properties: - api_route_regex: POST /api/v2/Account/Sync - published: default - link: transport/synchronize-updates-of-backbone + - redirect_from: require: required_by: api_route_regex: ^POST /api/v2/Account/Sync$ diff --git a/_docs_use-cases/use-case-transport-trigger-device-deletion-of-onboarded-device.md b/_docs_use-cases/use-case-transport-trigger-device-deletion-of-onboarded-device.md index 8b9c1b68b..5a9cd2c83 100644 --- a/_docs_use-cases/use-case-transport-trigger-device-deletion-of-onboarded-device.md +++ b/_docs_use-cases/use-case-transport-trigger-device-deletion-of-onboarded-device.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: - link: transport/trigger-device-deletion-of-onboarded-device + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-transport-update-device.md b/_docs_use-cases/use-case-transport-update-device.md index cec896711..6598926c8 100644 --- a/_docs_use-cases/use-case-transport-update-device.md +++ b/_docs_use-cases/use-case-transport-update-device.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: transport/update-device + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-transport-upload-own-file.md b/_docs_use-cases/use-case-transport-upload-own-file.md index cfa04da07..34c1d1a85 100644 --- a/_docs_use-cases/use-case-transport-upload-own-file.md +++ b/_docs_use-cases/use-case-transport-upload-own-file.md @@ -31,6 +31,7 @@ properties: - api_route_regex: POST /api/v2/Files/Own - published: default - link: transport/upload-own-file + - redirect_from: require: required_by: api_route_regex: ^POST /api/v2/Files/Own$ diff --git a/_docs_use-cases/use-case-transport-validate-challenge.md b/_docs_use-cases/use-case-transport-validate-challenge.md index ed5fa9c3c..b0a37e77e 100644 --- a/_docs_use-cases/use-case-transport-validate-challenge.md +++ b/_docs_use-cases/use-case-transport-validate-challenge.md @@ -31,6 +31,7 @@ properties: - api_route_regex: POST /api/v2/Challenges/Validate - published: - link: transport/validate-challenge + - redirect_from: require: required_by: api_route_regex: ^POST /api/v2/Challenges/Validate$ diff --git a/_docs_use-cases/use-case-user_interface-get-app-version-information.md b/_docs_use-cases/use-case-user_interface-get-app-version-information.md index b46a77d51..b819a2c25 100644 --- a/_docs_use-cases/use-case-user_interface-get-app-version-information.md +++ b/_docs_use-cases/use-case-user_interface-get-app-version-information.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: user interface/get-app-version-information + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-user_interface-refresh-screen-screen.md b/_docs_use-cases/use-case-user_interface-refresh-screen-screen.md index 1d00da4e9..d98bce42a 100644 --- a/_docs_use-cases/use-case-user_interface-refresh-screen-screen.md +++ b/_docs_use-cases/use-case-user_interface-refresh-screen-screen.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: user interface/refresh-screen-screen + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-user_interface-show-screen-screen.md b/_docs_use-cases/use-case-user_interface-show-screen-screen.md index 801808e4d..438f3cb8c 100644 --- a/_docs_use-cases/use-case-user_interface-show-screen-screen.md +++ b/_docs_use-cases/use-case-user_interface-show-screen-screen.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: user interface/show-screen-screen + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-user_interface-start-app-with-parameters-by-using-link.md b/_docs_use-cases/use-case-user_interface-start-app-with-parameters-by-using-link.md index 0abbfdd1d..2edbae33b 100644 --- a/_docs_use-cases/use-case-user_interface-start-app-with-parameters-by-using-link.md +++ b/_docs_use-cases/use-case-user_interface-start-app-with-parameters-by-using-link.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: user interface/start-app-with-parameters-by-using-link + - redirect_from: require: required_by: --- diff --git a/_docs_use-cases/use-case-user_interface-start-app-without-parameters.md b/_docs_use-cases/use-case-user_interface-start-app-without-parameters.md index fa6f16fed..9dd9c3295 100644 --- a/_docs_use-cases/use-case-user_interface-start-app-without-parameters.md +++ b/_docs_use-cases/use-case-user_interface-start-app-without-parameters.md @@ -31,6 +31,7 @@ properties: - api_route_regex: - published: default - link: user interface/start-app-without-parameters + - redirect_from: require: required_by: --- diff --git a/_docs_use/create-an-identity.md b/_docs_use/create-an-identity.md index 5c51c6bf5..0bd02fbc2 100644 --- a/_docs_use/create-an-identity.md +++ b/_docs_use/create-an-identity.md @@ -1,7 +1,7 @@ --- # !!! Warning: Do not edit this file; any changes must be replicated in Excel !!! permalink: use/create-an-identity -published: true +published: false title: "Create an Identity" type: scenario toc: true diff --git a/_docs_use/delete-identity-from-enmeshed.md b/_docs_use/delete-identity-from-enmeshed.md index 08c51a15a..1679b2712 100644 --- a/_docs_use/delete-identity-from-enmeshed.md +++ b/_docs_use/delete-identity-from-enmeshed.md @@ -1,7 +1,7 @@ --- # !!! Warning: Do not edit this file; any changes must be replicated in Excel !!! permalink: use/delete-identity-from-enmeshed -published: true +published: false title: "Delete Identity from enmeshed" type: scenario toc: true diff --git a/_docs_use/delete-profile-from-the-app.md b/_docs_use/delete-profile-from-the-app.md index b2bd0f8ac..800e03f4b 100644 --- a/_docs_use/delete-profile-from-the-app.md +++ b/_docs_use/delete-profile-from-the-app.md @@ -1,7 +1,7 @@ --- # !!! Warning: Do not edit this file; any changes must be replicated in Excel !!! permalink: use/delete-profile-from-the-app -published: true +published: false title: "Delete Profile from the App" type: scenario toc: true diff --git a/_docs_use/distinguish-personalized-and-non-personalized-codes.md b/_docs_use/distinguish-personalized-and-non-personalized-codes.md deleted file mode 100644 index 1f4b58283..000000000 --- a/_docs_use/distinguish-personalized-and-non-personalized-codes.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -# !!! Warning: Do not edit this file; any changes must be replicated in Excel !!! -permalink: use/distinguish-personalized-and-non-personalized-codes -published: false -title: "Distinguish personalized and non-personalized codes" -type: scenario -toc: true -properties: - - id: SC019 - - category: Get in touch with other Identities - - description: - - customer: All - - component: use - - level: Advanced - - implementation status: DOCS ONLY - - documentation status: OPEN - - published: - - link: use/distinguish-personalized-and-non-personalized-codes -require: -required_by: ---- - -{% include scenarios/use/distinguish-personalized-and-non-personalized-codes.md %} diff --git a/_docs_use/establish-a-new-digital-relationship-to-an-organization.md b/_docs_use/establish-a-new-digital-relationship-to-an-organization.md new file mode 100644 index 000000000..e7a9a3d0c --- /dev/null +++ b/_docs_use/establish-a-new-digital-relationship-to-an-organization.md @@ -0,0 +1,23 @@ +--- +# !!! Warning: Do not edit this file; any changes must be replicated in Excel !!! +permalink: use/establish-a-new-digital-relationship-to-an-organization +published: false +title: "establish a new digital relationship to an organization" +type: scenario +toc: true +properties: + - id: SC017 + - category: Get in touch with other Identities + - description: Nutzer möchte ohne einen Online Account einen neuen Vertrag mit einer Organisation eingehen + - customer: All + - component: use + - level: Beginner + - implementation status: DOCS ONLY + - documentation status: OPEN + - published: + - link: use/establish-a-new-digital-relationship-to-an-organization +require: +required_by: +--- + +{% include scenarios/use/establish-a-new-digital-relationship-to-an-organization.md %} diff --git a/_docs_use/create-own-enmeshed-codes-to-share-with-your-peers.md b/_docs_use/establish-a-new-digital-relationship-to-another-user.md similarity index 52% rename from _docs_use/create-own-enmeshed-codes-to-share-with-your-peers.md rename to _docs_use/establish-a-new-digital-relationship-to-another-user.md index 2ccae873e..758137e5e 100644 --- a/_docs_use/create-own-enmeshed-codes-to-share-with-your-peers.md +++ b/_docs_use/establish-a-new-digital-relationship-to-another-user.md @@ -1,23 +1,23 @@ --- # !!! Warning: Do not edit this file; any changes must be replicated in Excel !!! -permalink: use/create-own-enmeshed-codes-to-share-with-your-peers +permalink: use/establish-a-new-digital-relationship-to-another-user published: false -title: "Create own enmeshed codes to share with your peers" +title: "establish a new digital relationship to another user" type: scenario toc: true properties: - id: SC018 - category: Get in touch with other Identities - - description: + - description: Nutzer möchte mit anderem Nutzer reden - customer: All - component: use - level: Advanced - implementation status: DISABLED - documentation status: OPEN - published: - - link: use/create-own-enmeshed-codes-to-share-with-your-peers + - link: use/establish-a-new-digital-relationship-to-another-user require: required_by: --- -{% include scenarios/use/create-own-enmeshed-codes-to-share-with-your-peers.md %} +{% include scenarios/use/establish-a-new-digital-relationship-to-another-user.md %} diff --git a/_docs_use/get-overview-of-your-data.md b/_docs_use/get-overview-of-your-data.md index df3100882..3d910ccda 100644 --- a/_docs_use/get-overview-of-your-data.md +++ b/_docs_use/get-overview-of-your-data.md @@ -1,7 +1,7 @@ --- # !!! Warning: Do not edit this file; any changes must be replicated in Excel !!! permalink: use/get-overview-of-your-data -published: true +published: false title: "Get overview of your data" type: scenario toc: true diff --git a/_docs_use/install-the-app.md b/_docs_use/install-the-app.md index 2bc2e4687..25865afe7 100644 --- a/_docs_use/install-the-app.md +++ b/_docs_use/install-the-app.md @@ -15,7 +15,7 @@ properties: - component: use - level: Beginner - implementation status: - - documentation status: + - documentation status: OLD - published: true - link: use/install-the-app require: diff --git a/_docs_use/manually-fill-attributes-of-your-identity.md b/_docs_use/manually-fill-attributes-of-your-identity.md index 570f2c354..7c3e717f8 100644 --- a/_docs_use/manually-fill-attributes-of-your-identity.md +++ b/_docs_use/manually-fill-attributes-of-your-identity.md @@ -1,7 +1,7 @@ --- # !!! Warning: Do not edit this file; any changes must be replicated in Excel !!! permalink: use/manually-fill-attributes-of-your-identity -published: true +published: false title: "Manually fill Attributes of your Identity" type: scenario toc: true diff --git a/_docs_use/process-received-enmeshed-onboarding-package-and-create-relationship.md b/_docs_use/process-received-enmeshed-onboarding-package-and-create-relationship.md deleted file mode 100644 index 2446c8249..000000000 --- a/_docs_use/process-received-enmeshed-onboarding-package-and-create-relationship.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -# !!! Warning: Do not edit this file; any changes must be replicated in Excel !!! -permalink: use/process-received-enmeshed-onboarding-package-and-create-relationship -published: true -title: "Process received enmeshed onboarding package and create relationship" -type: scenario -toc: true -properties: - - id: SC071 - - category: Get in touch with other Identities - - description: - - customer: All - - component: use - - level: Beginner - - implementation status: DONE - - documentation status: OPEN - - published: - - link: use/process-received-enmeshed-onboarding-package-and-create-relationship -require: -required_by: ---- - -{% include scenarios/use/process-received-enmeshed-onboarding-package-and-create-relationship.md %} diff --git a/_docs_use/process-requests-of-contact.md b/_docs_use/process-requests-of-contact.md index 312fe3a3f..a1fbb2afe 100644 --- a/_docs_use/process-requests-of-contact.md +++ b/_docs_use/process-requests-of-contact.md @@ -1,7 +1,7 @@ --- # !!! Warning: Do not edit this file; any changes must be replicated in Excel !!! permalink: use/process-requests-of-contact -published: true +published: false title: "Process requests of contact" type: scenario toc: true diff --git a/_docs_use/register-a-new-online-account-with-an-organization.md b/_docs_use/register-a-new-online-account-with-an-organization.md new file mode 100644 index 000000000..3f92e985c --- /dev/null +++ b/_docs_use/register-a-new-online-account-with-an-organization.md @@ -0,0 +1,23 @@ +--- +# !!! Warning: Do not edit this file; any changes must be replicated in Excel !!! +permalink: use/register-a-new-online-account-with-an-organization +published: false +title: "register a new online account with an organization" +type: scenario +toc: true +properties: + - id: SC015 + - category: Get in touch with other Identities + - description: Nutzer möchte sich mit enmeshed einen neuen Online Account anlegen QRCode einscannen, Daten eingeben, abschicken, Website ist angemeldet + - customer: All + - component: use + - level: Beginner + - implementation status: DOCS ONLY + - documentation status: OPEN + - published: + - link: use/register-a-new-online-account-with-an-organization +require: +required_by: +--- + +{% include scenarios/use/register-a-new-online-account-with-an-organization.md %} diff --git a/_docs_use/register-new-online-account-with-enmeshed.md b/_docs_use/register-new-online-account-with-enmeshed.md deleted file mode 100644 index 712c26576..000000000 --- a/_docs_use/register-new-online-account-with-enmeshed.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -# !!! Warning: Do not edit this file; any changes must be replicated in Excel !!! -permalink: use/register-new-online-account-with-enmeshed -published: false -title: "Register new online account with enmeshed" -type: scenario -toc: true -properties: - - id: SC015 - - category: Get in touch with other Identities - - description: - - customer: All - - component: use - - level: Beginner - - implementation status: DOCS ONLY - - documentation status: OPEN - - published: - - link: use/register-new-online-account-with-enmeshed -require: -required_by: ---- - -{% include scenarios/use/register-new-online-account-with-enmeshed.md %} diff --git a/_docs_use/rename-profile-to-distinguish-multiple-profiles.md b/_docs_use/rename-profile-to-distinguish-multiple-profiles.md index cce9fe9dc..9b3f580eb 100644 --- a/_docs_use/rename-profile-to-distinguish-multiple-profiles.md +++ b/_docs_use/rename-profile-to-distinguish-multiple-profiles.md @@ -1,7 +1,7 @@ --- # !!! Warning: Do not edit this file; any changes must be replicated in Excel !!! permalink: use/rename-profile-to-distinguish-multiple-profiles -published: true +published: false title: "Rename Profile to distinguish multiple Profiles" type: scenario toc: true diff --git a/_docs_use/scan-qr-codes-to-set-up-digital-communication-by-printouts.md b/_docs_use/scan-qr-codes-to-set-up-digital-communication-by-printouts.md deleted file mode 100644 index 62737bc4c..000000000 --- a/_docs_use/scan-qr-codes-to-set-up-digital-communication-by-printouts.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -# !!! Warning: Do not edit this file; any changes must be replicated in Excel !!! -permalink: use/scan-qr-codes-to-set-up-digital-communication-by-printouts -published: false -title: "Scan QR Codes to set up digital communication by printouts" -type: scenario -toc: true -properties: - - id: SC016 - - category: Get in touch with other Identities - - description: - - customer: All - - component: use - - level: Beginner - - implementation status: DOCS ONLY - - documentation status: OPEN - - published: - - link: use/scan-qr-codes-to-set-up-digital-communication-by-printouts -require: -required_by: ---- - -{% include scenarios/use/scan-qr-codes-to-set-up-digital-communication-by-printouts.md %} diff --git a/_docs_use/send-prefabricated-request-to-contact.md b/_docs_use/send-prefabricated-request-to-contact.md index 0a83d255a..0812329c7 100644 --- a/_docs_use/send-prefabricated-request-to-contact.md +++ b/_docs_use/send-prefabricated-request-to-contact.md @@ -1,7 +1,7 @@ --- # !!! Warning: Do not edit this file; any changes must be replicated in Excel !!! permalink: use/send-prefabricated-request-to-contact -published: true +published: false title: "Send prefabricated request to contact" type: scenario toc: true diff --git a/_docs_use/upgrade-an-existing-online-account-at-an-organization.md b/_docs_use/upgrade-an-existing-online-account-at-an-organization.md new file mode 100644 index 000000000..827ef63f9 --- /dev/null +++ b/_docs_use/upgrade-an-existing-online-account-at-an-organization.md @@ -0,0 +1,23 @@ +--- +# !!! Warning: Do not edit this file; any changes must be replicated in Excel !!! +permalink: use/upgrade-an-existing-online-account-at-an-organization +published: false +title: "upgrade an existing online account at an organization" +type: scenario +toc: true +properties: + - id: SC014 + - category: Get in touch with other Identities + - description: Nutzer möchte vorhanden Online Account/Login auf enmeshed heben Bei bestimmten Service Providern Einloggen, QR Code einscannen, Kontakt eingehen, Website wird neu geladen, Nutzer ist mit enmeshed verbunden + - customer: All + - component: use + - level: Beginner + - implementation status: DOCS ONLY + - documentation status: OPEN + - published: + - link: use/upgrade-an-existing-online-account-at-an-organization +require: +required_by: +--- + +{% include scenarios/use/upgrade-an-existing-online-account-at-an-organization.md %} diff --git a/_docs_use/upgrade-existing-online-account-to-enmeshed.md b/_docs_use/upgrade-existing-online-account-to-enmeshed.md deleted file mode 100644 index ba31a221b..000000000 --- a/_docs_use/upgrade-existing-online-account-to-enmeshed.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -# !!! Warning: Do not edit this file; any changes must be replicated in Excel !!! -permalink: use/upgrade-existing-online-account-to-enmeshed -published: false -title: "Upgrade existing online account to enmeshed" -type: scenario -toc: true -properties: - - id: SC014 - - category: Get in touch with other Identities - - description: - - customer: All - - component: use - - level: Beginner - - implementation status: DOCS ONLY - - documentation status: OPEN - - published: - - link: use/upgrade-existing-online-account-to-enmeshed -require: -required_by: ---- - -{% include scenarios/use/upgrade-existing-online-account-to-enmeshed.md %} diff --git a/_docs_use/use-nmshd-links-to-trigger-enmeshed-on-the-same-device.md b/_docs_use/use-nmshd-links-to-trigger-enmeshed-on-the-same-device.md deleted file mode 100644 index 682fc802e..000000000 --- a/_docs_use/use-nmshd-links-to-trigger-enmeshed-on-the-same-device.md +++ /dev/null @@ -1,23 +0,0 @@ ---- -# !!! Warning: Do not edit this file; any changes must be replicated in Excel !!! -permalink: use/use-nmshd-links-to-trigger-enmeshed-on-the-same-device -published: false -title: "Use nmshd links to trigger enmeshed on the same device" -type: scenario -toc: true -properties: - - id: SC017 - - category: Get in touch with other Identities - - description: - - customer: All - - component: use - - level: Beginner - - implementation status: DOCS ONLY - - documentation status: OPEN - - published: - - link: use/use-nmshd-links-to-trigger-enmeshed-on-the-same-device -require: -required_by: ---- - -{% include scenarios/use/use-nmshd-links-to-trigger-enmeshed-on-the-same-device.md %} diff --git a/_includes/scenarios/integrate/data-model-overview.md b/_includes/scenarios/integrate/data-model-overview.md index 4e150f738..f59114702 100644 --- a/_includes/scenarios/integrate/data-model-overview.md +++ b/_includes/scenarios/integrate/data-model-overview.md @@ -285,11 +285,17 @@ With the information in this type you can clearly identify the Transport object ## LocalAttribute -A LocalAttribute contains the local metadata for an [Attribute](#attributes). There are three situations a LocalAttribute is created in the database: +A LocalAttribute contains the local metadata for an [Attribute](#attributes). In the context of [IdentityAttributes](#identityattribute), there are three situations a LocalAttribute is created in the database: -- The Identity maintains an Attribute about itself (e.g. sets its first name). We call such a LocalAttribute "RepositoryAttribute". -- The Identity shares an Attribute of itself with another Identity (e.g. sends it in a Request). In that case, a _copy of the original LocalAttribute_ is created, where the `shareInfo` property is set. -- The Identity receives an Attribute from another Identity (e.g. receives it in a Request). In that case a _new LocalAttribute_ is created, where the `shareInfo` is set. +- The Identity maintains an Attribute about itself (e.g. sets its first name). We call such an unshared LocalAttribute "RepositoryAttribute". Its `shareInfo` property is undefined. +- The Identity shares an Attribute of itself with another Identity (e.g. sends it in a Request). In that case, a _copy of the original LocalAttribute_ is created, where the `shareInfo` property is set. We call this LocalAttribute an "own shared IdentityAttribute". +- The Identity receives an Attribute from another Identity (e.g. receives it in a Request). In that case a _new LocalAttribute_ is created, where the `shareInfo` is set. We call this LocalAttribute a "peer shared IdentityAttribute". + +In contrast, [RelationshipAttributes](#relationshipattribute) always exist in the context of a [Relationship](#relationship). +Thus, it is not possible for an Identity to have an unshared RelationshipAttribute. + +- We refer to the LocalAttribute of the owner as "own shared RelationshipAttribute". +- The peer’s LocalAttribute we referred to as "peer shared RelationshipAttribute". | Name | Type | Description | | ----------- | ---------------------------------------------------------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | diff --git a/_includes/scenarios/integrate/succeeding-attributes-to-update-their-values.md b/_includes/scenarios/integrate/succeeding-attributes-to-update-their-values.md new file mode 100644 index 000000000..f60aeb3db --- /dev/null +++ b/_includes/scenarios/integrate/succeeding-attributes-to-update-their-values.md @@ -0,0 +1,84 @@ +The way enmeshed handles updates to your personal data is by succeeding old [Attributes]({% link _docs_integrate/data-model-overview.md %}#attributes) with new ones. +Instead of simply replacing old data, a completely new Attribute is created which succeeds its predecessor. +Thus, you and your peers are provided with a coherent history of all past versions. +How the Attribute succession works in detail depends on the type of Attribute. + +## Succeeding own IdentityAttributes + +When talking about [IdentityAttributes]({% link _docs_integrate/data-model-overview.md %}#identityattribute), we need to distinguish three cases: + +- The Identity maintains an unshared Attribute about itself. This IdentityAttribute is stored in the `content` field of a [LocalAttribute]({% link _docs_integrate/data-model-overview.md %}#localattribute), whose `shareInfo` is undefined. Since this LocalAttribute is created for the Identity's private repository of Attributes, it is referred to as **RepositoryAttribute**. +- When sharing a RepositoryAttribute with a peer, a copy of the IdentityAttribute is created for the Sender and stored in the `content` field of a LocalAttribute with a defined `shareInfo`. We call this LocalAttribute an **own shared IdentityAttribute**. +- Receiving a shared IdentityAttribute from a peer leads to the creation of a LocalAttribute with according `content` and a defined `shareInfo` for the Recipient. We call this LocalAttribute a **peer shared IdentityAttribute**. + +Discussing the succession of IdentityAttributes requires some background knowledge about this differentiation and the behavior of shared Attributes. +Hence, we will look at the process of creating, sharing and succeeding an IdentityAttribute step by step. + +### Creating a RepositoryAttribute + +Enmeshed allows you to store data about yourself in the form of IdentityAttributes. +When [creating an IdentityAttribute]({% link _docs_use-cases/use-case-consumption-create-a-repositoryattribute.md %}), it is not necessary to share it immediately with a peer. +Instead, it will be stored in the `content` property of a LocalAttribute with an undefined `shareInfo`. +We refer to these unshared LocalAttributes as RepositoryAttributes, since they make up your private repository of Attributes. + +In the following examples, the `createdAt` property all occuring LocalAttribute is omitted, since it isn't required for the explanation. +{: .notice--info} + +
+ +### Sharing a RepositoryAttribute + +Now, in order to [share a RepositoryAttribute]({% link _docs_integrate/share-own-attribute-to-peer.md %}), you need to send an according [Request]({% link _docs_integrate/data-model-overview.md %}#request) to the peer you want to share it with. +If they [accept your Request]({% link _docs_use-cases/use-case-consumption-accept-incoming-request.md %}), a new LocalAttribute will be created at the peer's side. +This peer shared IdentityAttribute has the same `content` like your RepositoryAttribute and, in addition, a defined `shareInfo` property. +It stores the Address of the `peer` who shared the Attribute with them, i.e. your Address, and a reference to the Request that was used to share the Attribute. +Receiving the [Response]({% link _docs_integrate/data-model-overview.md %}#response), an own shared IdentityAttribute with equal `content` will be created at your side. +Its `shareInfo` stores the same `requestReference` and the peer's Address, as well as the `id` of the RepositoryAttribute, whose `content` was copied, in the field `sourceAttribute`. + +Concluding, sharing an IdentityAttribute will create an own shared IdentityAttribute copy for every peer you shared the Attribute with at your side and a peer shared IdentityAttribute copy for each peer at their side. + +
+ +### Succeeding a RepositoryAttribute + +Next, let's consider the case that the `value` of your [IdentityAttribute]({% link _docs_integrate/data-model-overview.md %}#identityattribute) changes and you want to update it. +To [succeed the RepositoryAttribute]({% link _docs_use-cases/use-case-consumption-succeed-a-repositoryattribute.md %}), a new [LocalAttribute]({% link _docs_integrate/data-model-overview.md %}#localattribute) with the updated `content` will be created. +This successor stores the `id` of the old version, the predecessor, in its `succeeds` property. +The predecessor is updated, too, such that its `succeededBy` property links to the successor. +Consequently, the different versions of a LocalAttribute created by Attribute successions make up a doubly linked list. + +
+ +### Notifying a peer about a RepositoryAttribute succession + +After succeeding a RepositoryAttribute, you can check [with which of your peers you have previously shared the succeeded Attribute]({% link _docs_use-cases/use-case-consumption-get-shared-versions-of-a-repositoryattribute.md %}) to choose those, you'd like to [notify about the succession]({% link _docs_use-cases/use-case-consumption-notify-peer-about-repositoryattribute-succession.md %}). +Your own shared IdentityAttributes associated with the peers chosen will be succeeded in the same manner as your RepositoryAttribute before. +Then, a [Notification]({% link _docs_integrate/data-model-overview.md %}#notification) is sent to the peers, containing a [PeerSharedAttributeSucceededNotificationItem]({% link _docs_integrate/data-model-overview.md %}#peersharedattributesucceedednotificationitem). +In the `successorContent` property of the latter the updated IdentityAttribute is transmitted and automatically a likewise succession at the peers' side will be triggered, such that their LocalAttribute versions replicate the succession chain at your side. + +
+ +## Succeeding own RelationshipAttributes + +[RelationshipAttributes]({% link _docs_integrate/data-model-overview.md %}#relationshipattribute) are, as the name suggests, always associated with a [Relationship]({% link _docs_integrate/data-model-overview.md %}#relationship). +Thus, it is not possible to have unshared instances of them. +Instead, you and your peer will always each have a LocalAttribute with the same RelationshipAttribute as `content`. +We refer to the LocalAttribute of the `owner` as **own shared RelationshipAttribute** and to the peer's LocalAttribute as **peer shared RelationshipAttribute**. + +### Creating and sharing a RelationshipAttribute + +Wanting to [create a RelationshipAttribute]({% link _docs_use-cases/use-case-consumption-create-and-share-a-relationshipattribute.md %}) always involves sharing it directly with a peer. +To this end, a Request containing a [CreateAttributeRequestItem]({% link _docs_integrate/data-model-overview.md %}#createattributerequestitem) with the RelationshipAttribute will be created and will be sent to the peer. +Only if the peer accepts this Request will a LocalAttribute with the RelationshipAttribute as `content` be created at their side and after you receive their Response, at your side, too. +Hence, you and your peer will always have an identical shared RelationshipAttribute, only differing in the LocalAttribute's `shareInfo.peer` property. + +
+ +### Succeeding a RelationshipAttribute and notifying the peer + +Equally to IdentityAttributes, again only the `owner` can [succeed a RelationshipAttribute]({% link _docs_use-cases/use-case-consumption-succeed-a-relationshipattribute-and-notify-peer.md %}) to update its `value`. +Doing so, a new version of the own shared RelationshipAttribute will be created at your side. +The `succeeds` property of this LocalAttribute links to the old version, whose `succeededBy` property in turn is updated to the `id` of the newly created successor. +Then, a Notification is sent automatically to the peer, which triggers the creation of a new peer shared RelationshipAttribute at their side, such that their LocalAttribute versions replicate the succession chain at your side. + +
diff --git a/_includes/scenarios/integrate/updating-identityattributes-of-yourself.md b/_includes/scenarios/integrate/updating-identityattributes-of-yourself.md deleted file mode 100644 index 7fb94ef39..000000000 --- a/_includes/scenarios/integrate/updating-identityattributes-of-yourself.md +++ /dev/null @@ -1,17 +0,0 @@ -{% include warnings/feature-work-in-progress %} - -# Flow - -Attributes as such cannot be updated, but can be succeeded by a new Attribute. Thus, the value of an Attribute cannot be changed but overwritten by a new Attribute. We ensure that a coherent history of Attributes are available at all times on different parties. - -Consider an IdentityA which shared its DisplayName to IdentityB, IdentityC, and IdentityD. IdentityA now would like to change the DisplayName and has to execute the following steps: - -- Succeed the LocalAttribute of the current DisplayName with the new DisplayName -- Notify each peer individually that the DisplayName changed (this is optional, for every peer it can be decided if the peer receives the new Attribute or not) - -Each peer would receive a Notification containing an AttributeSucceededNotificationItem which is automatically processed by each Identity. Thus, succeeding Attribute does not result into decidable Requests for the peer. They are only informed about the change. - -# Examples - -- Changing IdentityAttributes because of name changes, a move to a new address or change of communication details -- An Identity receiving a new telephone number but does not want to share this new telephone number to every peer diff --git a/_includes/use-cases/use-case-consumption-create-a-repositoryattribute.md b/_includes/use-cases/use-case-consumption-create-a-repositoryattribute.md new file mode 100644 index 000000000..4a3778eb3 --- /dev/null +++ b/_includes/use-cases/use-case-consumption-create-a-repositoryattribute.md @@ -0,0 +1,19 @@ +{{properties.description}} + +{% include properties_list.html %} + +This use-case is intended to create a RepositoryAttribute, i.e. an unshared [LocalAttribute]({% link _docs_integrate/data-model-overview.md %}#localattribute) +based on a given [IdentityAttribute]({% link _docs_integrate/data-model-overview.md %}#identityattribute). + +## Parameters + +- The `content` for the LocalAttribute that ought to be created as IdentityAttribute without the `owner` + property, since it is automatically set to your Address + +## On Success + +- A LocalAttribute is created according to the parameters and returned with an undefined `shareInfo`. + +## On Failure + +- The LocalAttribute cannot be created if the parameter is malformed. diff --git a/_includes/use-cases/use-case-consumption-create-an-attribute.md b/_includes/use-cases/use-case-consumption-create-an-attribute.md deleted file mode 100644 index 1800abe0c..000000000 --- a/_includes/use-cases/use-case-consumption-create-an-attribute.md +++ /dev/null @@ -1,18 +0,0 @@ -{{properties.description}} - -{% include properties_list.html %} - -This use-case is intended to create a [LocalAttribute]({% link _docs_integrate/data-model-overview.md %}#localattribute) -based on a given [Attribute]({% link _docs_integrate/data-model-overview.md %}#attributes). - -## Parameters - -- The `content` for the to be created LocalAttribute as [Attribute]({% link _docs_integrate/data-model-overview.md %}#attributes) - -## On Success - -- A [LocalAttribute]({% link _docs_integrate/data-model-overview.md %}#localattribute) is created according to the parameters and returned. - -## On Failure - -- The Attribute cannot be created if the parameter is malformed. diff --git a/_includes/use-cases/use-case-consumption-create-and-share-a-relationshipattribute.md b/_includes/use-cases/use-case-consumption-create-and-share-a-relationshipattribute.md new file mode 100644 index 000000000..c8c810ecf --- /dev/null +++ b/_includes/use-cases/use-case-consumption-create-and-share-a-relationshipattribute.md @@ -0,0 +1,25 @@ +{{properties.description}} + +{% include properties_list.html %} + +[RelationshipAttributes]({% link _docs_integrate/data-model-overview.md %}#relationshipattribute) are always associated with a [Relationship]({% link _docs_integrate/data-model-overview.md %}#relationship) between two Identities. +Consequently, in contrast to [IdentityAttributes]({% link _docs_integrate/data-model-overview.md %}#identityattribute), there cannot be unshared RelationshipAttributes. +Instead, you and your peer will always each have a [LocalAttribute]({% link _docs_integrate/data-model-overview.md %}#localattribute) with the same RelationshipAttribute as `content` and which only differs in the `shareInfo.peer` property. +Thus, wanting to create a new RelationshipAttribute, a [Request]({% link _docs_integrate/data-model-overview.md %}#request) is sent to the peer via [Message]({% link _docs_integrate/data-model-overview.md %}#message). +Only if the peer accepts this Request, the RelationshipAttribute will be created at their side. +Once you receive the [Response]({% link _docs_integrate/data-model-overview.md %}#response), a LocalAttribute with the same `content` will be created at your side. + +## Parameters + +- The `content` of the RelationshipAttribute you want to create, following the description from the [data model]({% link _docs_integrate/data-model-overview.md %}#relationshipattribute), except for the `owner`, which is automatically set to your Address +- The Address of the `peer` +- Optionally `requestMetadata` as described in the [data model]({% link _docs_integrate/data-model-overview.md %}#request), except for the `id` and `items`, which are handled automatically. + +## On Success + +- A Request is sent via Message to the peer, containing a [CreateAttributeRequestItem]({% link _docs_integrate/data-model-overview.md %}#createattributerequestitem) with the RelationshipAttribute you want to create and share with the peer. Furthermore, the Request is returned. + +## On Failure + +- The Request cannot be created, if the `peer` is unknown. +- The Request cannot be created, if the parameters are malformed. diff --git a/_includes/use-cases/use-case-consumption-get-shared-versions-of-a-repositoryattribute.md b/_includes/use-cases/use-case-consumption-get-shared-versions-of-a-repositoryattribute.md new file mode 100644 index 000000000..7a8d704af --- /dev/null +++ b/_includes/use-cases/use-case-consumption-get-shared-versions-of-a-repositoryattribute.md @@ -0,0 +1,25 @@ +{{properties.description}} + +{% include properties_list.html %} + +This use-case allows you to retrieve a list of own shared [IdentityAttributes]({% link _docs_integrate/data-model-overview.md %}#identityattribute) for a specified RepositoryAttribute. + +## Parameters + +- The `attributeId` belonging to a RepositoryAttribute you would like to know all shared versions of +- Optionally the returned [LocalAttributes]({% link _docs_integrate/data-model-overview.md %}#localattribute) can be limited to those shared with specific `peers`. +- `onlyLatestVersions` omits succeeded versions; by default this is set to be `true`. + +## On Success + +- A list of own shared IdentityAttribute versions of the RepositoryAttribute given as input will be returned. +- If `peers` were speficied, the list is limited to the entries shared with those peers. +- If `onlyLatestVersions` is disabled, all versions will be returned, even if they already have successors. + +## On Failure + +- No LocalAttributes can be returned, if the `attributeId` correlates to a RelationshipAttribute. +- No LocalAttributes can be returned, if the `attributeId` correlates to an IdentityAttribute with a `shareInfo`. +- No LocalAttributes can be returned, if the an empty list is provided for `peers`. +- No LocalAttributes can be returned, if the `peers` are unknown. +- No LocalAttributes can be returned, if the parameters are malformed. diff --git a/_includes/use-cases/use-case-consumption-get-versions-of-an-attribute.md b/_includes/use-cases/use-case-consumption-get-versions-of-an-attribute.md new file mode 100644 index 000000000..c7309c59a --- /dev/null +++ b/_includes/use-cases/use-case-consumption-get-versions-of-an-attribute.md @@ -0,0 +1,21 @@ +{{properties.description}} + +{% include properties_list.html %} + +[Succeeding an Attribute]({% link _docs_integrate/succeeding-attributes-to-update-their-values.md %}) allows you to update its `content`, while keeping all versions for a coherent history. +This use-case allows you to retrieve a list of all those versions of the succession chain for a specified [LocalAttribute]({% link _docs_integrate/data-model-overview.md %}#localattribute). + +## Parameters + +- The `attributeId` belonging to a LocalAttribute you would like to know all versions of + +## On Success + +- If the `attributeId` refers to a RepositoryAttribute, a list of all versions of this RepositoryAttribute will be returned. +- If the `attributeId` refers to an own shared IdentityAttribute, a list of all versions of that Attribute shared with the same peer will be returned. +- If the `attributeId` refers to a peer shared IdentityAttribute, a list of all versions of that Attribute received from the peer will be returned. +- If the `attributeId` refers to a [RelationshipAttribute]({% link _docs_integrate/data-model-overview.md %}#relationshipattribute), a list of all versions of that RelationshipAttribute will be returned. + +## On Failure + +- No Attributes can be returned, if the `attributeId` doesn't belong to a valid LocalAttribute. diff --git a/_includes/use-cases/use-case-consumption-notify-peer-about-repositoryattribute-succession.md b/_includes/use-cases/use-case-consumption-notify-peer-about-repositoryattribute-succession.md new file mode 100644 index 000000000..55cbb4610 --- /dev/null +++ b/_includes/use-cases/use-case-consumption-notify-peer-about-repositoryattribute-succession.md @@ -0,0 +1,30 @@ +{{properties.description}} + +{% include properties_list.html %} + +If you [succeeded a RepositoryAttribute]({% link _docs_use-cases/use-case-consumption-succeed-a-repositoryattribute.md %}), whose previous version you [shared with a peer]({% link _docs_use-cases/use-case-consumption-share-a-repositoryattribute.md %}), you can decide to inform the peer about the succession. +If you do so, the peer will receive a [Notification]({% link _docs_integrate/data-model-overview.md %}#notification) via [Message]({% link _docs_integrate/data-model-overview.md %}#message), which handles the succession of their peer shared [IdentityAttribute]({% link _docs_integrate/data-model-overview.md %}#identityattribute). +Also, the associated own shared IdentityAttribute at your side will be succeeded, i.e. a new version of the [LocalAttribute]({% link _docs_integrate/data-model-overview.md %}#localattribute) will be created and the predecessor will be updated to link to this successor in its `succeededBy` property. +Note that it is possible to notify a peer about the succession of an IdentityAttribute you already shared with them, even if you didn't inform them about every previous version. +In this case the `succeeds` field of the newly created LocalAttribute will link to the latest shared version. +Moreover, it is also possible to notify a peer about the succession of an IdentityAttribute, if this in turn is already succeeded again, in case you didn't notify the peer about a newer version, yet. + +## Parameters + +- `attributeId` of the succeeded RepositoryAttribute +- The Address of the `peer` + +## On Success + +- The response returns a `predecessor` and a `successor` LocalAttribute, as well as the `notificationId` of the Notification sent to the peer. +- The `predecessor` is an updated version of the own shared IdentityAttribute that was shared with the peer most recently. It has the `succeededBy` field set to the `successor`'s `id`. +- The `successor` is a new own shared IdentityAttribute version with the `content` of the succeeded RepositoryAttribute. Its `succeeds` property links to the `predecessor`. + +## On Failure + +- The response cannot be created, if the `peer` is unknown. +- The response cannot be created, if the `attributeId` belongs to a [RelationshipAttribute]({% link _docs_integrate/data-model-overview.md %}#relationshipattribute). +- The response cannot be created, if the `attributeId` belongs to an IdentityAttribute with a `shareInfo`. +- The response cannot be created, if you already notified the peer about the succession of the Attribute. +- The response cannot be created, if you haven't shared a version of the Attribute with the peer before. To initially share an IdentityAttribute, use the [ShareIdentityAttribute use-case]({% link _docs_use-cases/use-case-consumption-share-a-repositoryattribute.md %}). +- The response cannot be created, if the parameters are malformed. diff --git a/_includes/use-cases/use-case-consumption-share-a-repositoryattribute.md b/_includes/use-cases/use-case-consumption-share-a-repositoryattribute.md new file mode 100644 index 000000000..cf8afd903 --- /dev/null +++ b/_includes/use-cases/use-case-consumption-share-a-repositoryattribute.md @@ -0,0 +1,32 @@ +{{properties.description}} + +{% include properties_list.html %} + +If you wish to share one of your private [IdentityAttributes]({% link _docs_integrate/data-model-overview.md %}#identityattribute), called RepositoryAttributes, with a peer, this use-case allows you to do so. +Internally, a [Request]({% link _docs_integrate/data-model-overview.md %}#request) with a [ShareAttributeRequestItem]({% link _docs_integrate/requests-and-requestitems.md %}#shareattributerequestitem) will be created and will be sent via [Message]({% link _docs_integrate/data-model-overview.md %}#message) to the peer. +Assuming your peer accepts the Request, at their side a peer shared IdentityAttribute will be created. +The corresponding [Response]({% link _docs_integrate/data-model-overview.md %}#response) informs you about their acceptance and creates a [LocalAttribute]({% link _docs_integrate/data-model-overview.md %}#localattribute) with a copy of the RepositoryAttribute's `content` you shared. +This own shared IdentityAttribute copy, however, in addition has a defined `shareInfo` property. +It stores information about the `peer` you shared the attribute with, the `id` of the original RepositoryAttribute in the field `sourceAttribute`, and a reference to the Request used to share the Attribute. +Note that the own shared IdentityAttribute at your side and the peer shared IdentityAttribute at your peer's side are identical, except for the value in the `shareInfo.peer` field: on your side it will have the peer's Address and on the peer's side it will have your Address. +Please note further, that this use case is meant to be used to share a version of a RepositoryAttribute for the first time. +If you have already shared another version of a succeeded Attribute with the peer and you want to let them know about the changes to its `value`, use the [NotifyPeerAboutIdentityAttributeSuccession use-case]({% link _docs_use-cases/use-case-consumption-notify-peer-about-repositoryattribute-succession.md %}). + +## Parameters + +- The `attributeId` of your RepositoryAttribute +- The address of the `peer` +- Optionally `requestMetadata` as described in the [data model]({% link _docs_integrate/data-model-overview.md %}#request), except for the `id` and `items`, which are handled automatically + +## On Success + +- The [LocalRequest]({% link _docs_integrate/data-model-overview.md %}#localrequest) is returned, that is associated with the Request which was sent to the peer. + +## On Failure + +- The Request cannot be created, if the `peer` is unknown. +- The Request cannot be created, if the `attributeId` belongs to a RelationshipAttribute. +- The Request cannot be created, if the `attributeId` belongs to an IdentityAttribute with a `shareInfo`. +- The Request cannot be created, if the Attribute has already been shared with the peer. +- The Request cannot be created, if another version of the Attribute regarding succession has already been shared with the peer. +- The Request cannot be created, if the parameters are malformed. diff --git a/_includes/use-cases/use-case-consumption-share-attribute.md b/_includes/use-cases/use-case-consumption-share-attribute.md deleted file mode 100644 index e69de29bb..000000000 diff --git a/_includes/use-cases/use-case-consumption-succeed-a-relationshipattribute-and-notify-peer.md b/_includes/use-cases/use-case-consumption-succeed-a-relationshipattribute-and-notify-peer.md new file mode 100644 index 000000000..ad25bad1f --- /dev/null +++ b/_includes/use-cases/use-case-consumption-succeed-a-relationshipattribute-and-notify-peer.md @@ -0,0 +1,27 @@ +{{properties.description}} + +{% include properties_list.html %} + +This use-case allows the owner to update a [RelationshipAttribute]({% link _docs_integrate/data-model-overview.md %}#relationshipattribute), while automatically handling the coherent versioning at both your and your peer's side. +[Succeeding an own RelationshipAttribute]({% link _docs_integrate/succeeding-attributes-to-update-their-values.md %}#succeeding-own-relationshipattributes), a new [LocalAttribute]({% link _docs_integrate/data-model-overview.md %}#localattribute) with the updated `content` will be created at your side. +In its `succeeds` property it links to the predecessing version, which in turn is also updated and links to the newly created version in its `succeededBy` property. +Thus, a doubly linked list is established, ensuring every version to have not more that one predecessor or successor. +Once the succession at your side is completed, a [Notification]({% link _docs_integrate/data-model-overview.md %}#notification) is sent automatically to your peer. +It triggers the succession of their peer shared RelationshipAttribute in the same manner as described above, such that both your succession chains match. + +## Parameters + +- `predecessorId`: the `id` of the LocalAttribute with the RelationshipAttribute `content` you want to succeed +- The updated `successorContent` limited to the `value`, `validFrom` and `validTo` properties of a [RelationshipAttribute]({% link _docs_integrate/data-model-overview.md %}#relationshipattribute) that may be changed by a succession + +## On Success + +- The response returns a `predecessor` and a `successor` LocalAttribute, as well as the `notificationId` of the Notification sent to the peer. +- The `predecessor` is an updated version of the own shared RelationshipAttribute, having the `succeededBy` field set to the `successor`'s `id`. +- The `successor` is a new own shared RelationshipAttribute version with the specified `successorContent`. Its `succeeds` property links to the `predecessor`. + +## On Failure + +- The response cannot be created, if the `predecessorId` doesn't belong to a valid own LocalAttribute with RelationshipAttribute `content`. +- The response cannot be created, if the LocalAttribute belonging to the `predecessorId` already has a successor. +- The response cannot be created, if the parameters are malformed. diff --git a/_includes/use-cases/use-case-consumption-succeed-a-repositoryattribute.md b/_includes/use-cases/use-case-consumption-succeed-a-repositoryattribute.md new file mode 100644 index 000000000..22073c94e --- /dev/null +++ b/_includes/use-cases/use-case-consumption-succeed-a-repositoryattribute.md @@ -0,0 +1,27 @@ +{{properties.description}} + +{% include properties_list.html %} + +If the `value` of a [RepositoryAttribute]({% link _docs_integrate/data-model-overview.md %}#identityattribute) changes, this can be replicated in enmeshed with this use-case. +It allows you to [update the `content`]({% link _docs_integrate/succeeding-attributes-to-update-their-values.md %}) and keeps a coherent history of all versions by establishing a doubly linked list, using the [LocalAttribute's]({% link _docs_integrate/data-model-overview.md %}#localattribute) parameters `succeeds` and `succeededBy`. +Hence, every LocalAttribute may have exactly one predecessor and one successor. +In case you shared the preceeding version of the RepositoryAttribute, the corresponding own shared IdentityAttribute copy will only be succeeded, if you decide to [notify the peer]({% link _docs_use-cases/use-case-consumption-notify-peer-about-repositoryattribute-succession.md %}) of the respective shared IdentityAttribute about the succession. + +## Parameters + +- `predecessorId`: the `id` of the RepositoryAttribute you want to succeed +- The `successorContent` according to the parameters of an IdentityAttribute as described in the [data model]({% link _docs_integrate/data-model-overview.md %}#identityattribute), except for the `owner`, which is automatically set to your Address + +## On Success + +- The response returns a `predecessor` and a `successor` LocalAttribute. +- The `predecessor` is an updated version of the RepositoryAttribute belonging to `predecessorId`, having the `succeededBy` field set to the `successor`'s `id`. +- The `successor` is a new RepositoryAttribute with the updated `successorContent`. Its `succeeds` property links to the `predecessor`. + +## On Failure + +- The response cannot be created, if the `predecessorId` belongs to a [RelationshipAttribute]({% link _docs_integrate/data-model-overview.md %}#relationshipattribute). +- The response cannot be created, if the `predecessorId` belongs to an IdentityAttribute with a `shareInfo`. +- The response cannot be created, if the LocalAttribute already has a successor. +- The response cannot be created, if the `successorContent` contains invalid changes, e.g. of the value type. +- The response cannot be created, if the parameters are malformed. diff --git a/_includes/use-cases/use-case-consumption-succeed-attribute.md b/_includes/use-cases/use-case-consumption-succeed-attribute.md deleted file mode 100644 index e69de29bb..000000000 diff --git a/_includes/use-cases/use-case-consumption-update-attribute.md b/_includes/use-cases/use-case-consumption-update-attribute.md deleted file mode 100644 index e69de29bb..000000000