diff --git a/_docs_integrate/01-integrate-scenarios.md b/_docs_integrate/01-integrate-scenarios.md index f99308007..72f455216 100644 --- a/_docs_integrate/01-integrate-scenarios.md +++ b/_docs_integrate/01-integrate-scenarios.md @@ -17,9 +17,9 @@ Here you'll find everything you need to seamlessly dive into the world of enmesh Begin your integration journey by familiarizing yourself with the [Connector REST API]({% link _docs_integrate/access-the-connector.md %}) and exploring the fundamental steps for integration. Gain insights into effectively utilizing the [Connector SDKs]({% link _docs_integrate/access-the-connector.md %}#accessing-the-connector-by-software-development-kits-sdk) to streamline and optimize your integration. To get a first impression of certain integration processes, take a look at our [Integration example]({% link _docs_integrate/integration-example.md %}). Discover how events work and how you can leverage them in your application in the [Event introduction]({% link _docs_integrate/event-introduction.md %}). -## Relationships Between Identities +## Identities and Relationships -Learn how to [establish a Relationship]({% link _docs_integrate/establish-relationships.md %}) to another Identity in order to be able to communicate and exchange information with it. Furthermore, explore how to [exchange Messages]({% link _docs_integrate/exchange-messages.md %}) using enmeshed to communicate simply and securely with your peers. +Learn how to [establish a Relationship]({% link _docs_integrate/establish-relationships.md %}) to another Identity in order to be able to communicate and exchange information with it. Explore how to [exchange Messages]({% link _docs_integrate/exchange-messages.md %}) using enmeshed to communicate simply and securely with your peers. Furthermore, discover how to [terminate Relationships]({% link _docs_integrate/terminate-relationships.md %}) and [delete Identities]({% link _docs_integrate/delete-identities.md %}). ## Working With Requests diff --git a/_docs_integrate/connector-events.md b/_docs_integrate/connector-events.md index c1db52c2d..a876e3064 100644 --- a/_docs_integrate/connector-events.md +++ b/_docs_integrate/connector-events.md @@ -46,9 +46,9 @@ required_by: | transport.relationshipReactivationRequested | [Relationship]({% link _docs_integrate/data-model-overview.md %}#Relationship) | ... the reactivation of a terminated Relationship has been requested by you or the peer. | | transport.relationshipReactivationCompleted | [Relationship]({% link _docs_integrate/data-model-overview.md %}#Relationship) | ... the reactivation of a terminated Relationship has been accepted, rejected or revoked by you or the peer. | | transport.relationshipDecomposedBySelf | [Relationship]({% link _docs_integrate/data-model-overview.md %}#Relationship) | ... you have decomposed a terminated Relationship. | -| transport.peerToBeDeleted | [Relationship]({% link _docs_integrate/data-model-overview.md %}#Relationship) | ... your Relationship's peer triggered its deletion. | +| transport.peerToBeDeleted | [Relationship]({% link _docs_integrate/data-model-overview.md %}#Relationship) | ... your Relationship's peer triggered their deletion. | | transport.peerDeleted | [Relationship]({% link _docs_integrate/data-model-overview.md %}#Relationship) | ... your Relationship's peer was deleted. | -| transport.peerDeletionCancelledEvent | [Relationship]({% link _docs_integrate/data-model-overview.md %}#Relationship) | ... your Relationship's peer cancelled its deletion. | +| transport.peerDeletionCancelledEvent | [Relationship]({% link _docs_integrate/data-model-overview.md %}#Relationship) | ... your Relationship's peer cancelled their deletion. | ## Event structure diff --git a/_docs_integrate/error-codes.md b/_docs_integrate/error-codes.md index 64b4cfaa4..055c37f4b 100644 --- a/_docs_integrate/error-codes.md +++ b/_docs_integrate/error-codes.md @@ -116,7 +116,7 @@ Please find a list of enmeshed error codes below. Most often the errors occur on | {% include anchor a="error.runtime.identityDeletionProcess.noApprovedIdentityDeletionProcess" %} | [No approved IdentityDeletionProcess was found]({% link _docs_use-cases/use-case-transport-get-active-identitydeletionprocess.md %}). | | {% include anchor a="error.runtime.identityDeletionProcess.noWaitingForApprovalIdentityDeletionProcess" %} | No [IdentityDeletionProcess]({% link _docs_integrate/data-model-overview.md %}#identitydeletionprocess) waiting for decision was found. | | {% include anchor a="error.runtime.invalidTokenContent" %} | The given [Token]({% link _docs_integrate/data-model-overview.md %}#token) has an invalid `content` for this [route]({% link _docs_use-cases/use-case-transport-create-own-token.md %}). | -| {% include anchor a="error.runtime.messages.hasNoActiveRelationship" %} | The [Message]({% link _docs_integrate/data-model-overview.md %}#message) cannot be sent, because there is no active [Relationship]({% link _docs_integrate/data-model-overview.md %}#relationship) to one or more of its `recipients`. However, please note that Messages whose `content` is a [Notification]({% link _docs_integrate/data-model-overview.md %}#notification) can be sent on terminated Relationships as well. | +| {% include anchor a="error.runtime.messages.hasNoActiveRelationship" %} | The [Message]({% link _docs_integrate/data-model-overview.md %}#message) cannot be sent, because there is no active [Relationship]({% link _docs_integrate/data-model-overview.md %}#relationship) to one or more of its `recipients`. However, please note that Messages whose `content` is a [Notification]({% link _docs_integrate/data-model-overview.md %}#notification) can still be sent on terminated Relationships. | | {% include anchor a="error.runtime.messages.peerIsInDeletion" %} | The [Message]({% link _docs_integrate/data-model-overview.md %}#message) cannot be sent, because one or more of its `recipients` to which [Relationships]({% link _docs_integrate/data-model-overview.md %}#relationship) exist have `"ToBeDeleted"` as `peerDeletionInfo.deletionStatus` and the `content` of the Message is not a [Notification]({% link _docs_integrate/data-model-overview.md %}#notification). | | {% include anchor a="error.runtime.messages.fileNotFoundInMessage" %} | The requested [File]({% link _docs_integrate/data-model-overview.md %}#file) was not found in the given [Message]({% link _docs_integrate/data-model-overview.md %}#message). | | {% include anchor a="error.runtime.notifications.cannotReceiveNotificationFromOwnMessage" %} | It is not possible to receive a [Notification]({% link _docs_integrate/data-model-overview.md %}#notification) from an own [Message]({% link _docs_integrate/data-model-overview.md %}#message). | diff --git a/_docs_use-cases/use-case-transport-get-active-identitydeletionprocess.md b/_docs_use-cases/use-case-transport-get-active-identitydeletionprocess.md index fb82bbfba..3d2705113 100644 --- a/_docs_use-cases/use-case-transport-get-active-identitydeletionprocess.md +++ b/_docs_use-cases/use-case-transport-get-active-identitydeletionprocess.md @@ -43,7 +43,7 @@ required_by: From a technical perspective, the process of [Identity deletion]({% link _docs_integrate/delete-identities.md %}) is described by a data object of type [IdentityDeletionProcess]({% link _docs_integrate/data-model-overview.md %}#identitydeletionprocess). An IdentityDeletionProcess is active if it has `"WaitingForApproval"` or `"Approved"` as `status`. -This use case will return the active IdentityDeletionProcess for your [Identity]({% link _docs_integrate/data-model-overview.md %}#identity) if one exists. +This use case returns the active IdentityDeletionProcess for your [Identity]({% link _docs_integrate/data-model-overview.md %}#identity) if one exists. At all times, there can only be at most one active IdentityDeletionProcess per Identity. ## On Success