From af8cbecb7fb210e7bd72747d8dd010bb1307d4ab Mon Sep 17 00:00:00 2001 From: Britta Stallknecht Date: Tue, 19 Aug 2025 12:22:03 +0000 Subject: [PATCH 1/3] refactor: changed prefix of Connector routes --- _docs_integrate/integration-example.md | 34 ++++++++-------- _docs_integrate/migration-from-v4-to-v5.md | 40 +++++++++---------- _docs_integrate/migration-from-v5-to-v6.md | 2 +- _docs_integrate/migration-from-v6-to-v7.md | 2 +- _docs_operate/modules.md | 4 +- ...ase-consumption-accept-incoming-request.md | 4 +- ...eck-if-incoming-request-can-be-accepted.md | 4 +- ...eck-if-incoming-request-can-be-rejected.md | 4 +- ...heck-if-outgoing-request-can-be-created.md | 4 +- ...k-if-repositoryattribute-can-be-created.md | 4 +- ...onsumption-create-a-repositoryattribute.md | 4 +- ...ase-consumption-create-outgoing-request.md | 4 +- ...a-peer-shared-attribute-and-notify-peer.md | 4 +- ...onsumption-delete-a-repositoryattribute.md | 4 +- ...tyrelationshipattribute-and-notify-peer.md | 4 +- ...an-own-shared-attribute-and-notify-peer.md | 4 +- ...ase-consumption-delete-identitymetadata.md | 4 +- ...on-execute-a-relationshipattributequery.md | 4 +- ...-a-thirdpartyrelationshipattributequery.md | 4 +- ...ption-execute-an-identityattributequery.md | 4 +- ...se-case-consumption-execute-an-iqlquery.md | 4 +- .../use-case-consumption-get-attribute.md | 4 +- .../use-case-consumption-get-attributes.md | 4 +- ...-consumption-get-attributetagcollection.md | 4 +- ...e-case-consumption-get-identitymetadata.md | 4 +- ...e-case-consumption-get-incoming-request.md | 4 +- ...e-case-consumption-get-outgoing-request.md | 4 +- ...e-consumption-get-own-shared-attributes.md | 4 +- ...-consumption-get-peer-shared-attributes.md | 4 +- ...se-consumption-get-repositoryattributes.md | 4 +- ...ion-get-shared-versions-of-an-attribute.md | 4 +- ...onsumption-get-versions-of-an-attribute.md | 4 +- ...er-about-repositoryattribute-succession.md | 4 +- ...ase-consumption-query-incoming-requests.md | 4 +- ...ase-consumption-query-outgoing-requests.md | 4 +- ...ase-consumption-reject-incoming-request.md | 4 +- ...a-relationshipattribute-and-notify-peer.md | 4 +- ...nsumption-succeed-a-repositoryattribute.md | 4 +- ...ase-consumption-upsert-identitymetadata.md | 4 +- ...e-case-consumption-validate-an-iqlquery.md | 4 +- ...use-case-device-create-qr-code-for-file.md | 4 +- ...se-device-create-token-qr-code-for-file.md | 4 +- ...en-qr-code-for-own-relationshiptemplate.md | 4 +- ...nsport-accept-relationship-reactivation.md | 4 +- .../use-case-transport-accept-relationship.md | 4 +- ...rt-check-if-relationship-can-be-created.md | 4 +- .../use-case-transport-create-challenge.md | 4 +- ...ansport-create-own-relationshiptemplate.md | 4 +- .../use-case-transport-create-own-token.md | 4 +- ...-relationship-with-relationshiptemplate.md | 4 +- ...se-case-transport-create-token-for-file.md | 4 +- ...eate-token-for-own-relationshiptemplate.md | 4 +- ...e-case-transport-decompose-relationship.md | 4 +- .../use-case-transport-delete-file.md | 4 +- .../use-case-transport-download-file.md | 4 +- ...ansport-get-attributes-for-relationship.md | 4 +- ...e-transport-get-currently-used-identity.md | 4 +- .../use-case-transport-get-file-metadata.md | 4 +- ...case-transport-get-message-by-messageid.md | 4 +- ...e-transport-get-relationship-by-address.md | 4 +- ...port-get-relationship-by-relationshipid.md | 4 +- ...case-transport-get-relationshiptemplate.md | 4 +- ...et-synchronization-status-with-backbone.md | 4 +- ...use-case-transport-get-token-by-tokenid.md | 4 +- .../use-case-transport-load-file.md | 4 +- ...-relationshiptemplate-created-by-others.md | 4 +- ...-transport-load-token-created-by-others.md | 4 +- .../use-case-transport-query-messages.md | 4 +- ...-case-transport-query-metadata-of-files.md | 4 +- ...e-transport-query-metadata-of-own-files.md | 4 +- ...-transport-query-metadata-of-peer-files.md | 4 +- .../use-case-transport-query-relationships.md | 4 +- ...e-transport-query-relationshiptemplates.md | 4 +- ...ansport-regenerate-file-ownership-token.md | 4 +- ...nsport-reject-relationship-reactivation.md | 4 +- .../use-case-transport-reject-relationship.md | 4 +- ...sport-request-relationship-reactivation.md | 4 +- ...nsport-revoke-relationship-reactivation.md | 4 +- .../use-case-transport-revoke-relationship.md | 4 +- ...se-transport-send-message-to-recipients.md | 4 +- ...chronize-datawallet-updates-to-backbone.md | 4 +- ...ansport-synchronize-updates-of-backbone.md | 4 +- ...e-case-transport-terminate-relationship.md | 4 +- .../use-case-transport-upload-own-file.md | 4 +- .../use-case-transport-validate-challenge.md | 4 +- 85 files changed, 201 insertions(+), 201 deletions(-) diff --git a/_docs_integrate/integration-example.md b/_docs_integrate/integration-example.md index 5b4ebecd8..98b519567 100644 --- a/_docs_integrate/integration-example.md +++ b/_docs_integrate/integration-example.md @@ -64,7 +64,7 @@ It in turn accepts the Relationship, which results in an active Relationship. Firstly, let's create a display name for our Connector. While communicating with the other Identity in the subsequent steps, we will choose to share this display name. Technically, for this we need to create an [IdentityAttribute]({% link _docs_integrate/data-model-overview.md %}#identityattribute) with a value of type [DisplayName]({% link _docs_integrate/attribute-values.md %}#displayname) for our Connector. -To do so, execute `POST /api/v2/Attributes` with the following payload: +To do so, execute `POST /api/core/v1/Attributes` with the following payload: ```json { @@ -77,7 +77,7 @@ To do so, execute `POST /api/v2/Attributes` with the following payload: } ``` -{% include rapidoc api_route_regex="^post /api/v2/Attributes$" %} +{% include rapidoc api_route_regex="^post /api/core/v1/Attributes$" %} {% include copy-notice description="Save the `id` and the `owner` of the Attribute that you can find in the response. You will need it in the next step." %} @@ -148,9 +148,9 @@ Let's assume the Connector needs to know the given name and surname of its conta } ``` -Before we actually create the RelationshipTemplate, we want to ensure the validity of the Request and its items. To do so, execute `POST /api/v2/Requests/Outgoing/Validate` with the Request. +Before we actually create the RelationshipTemplate, we want to ensure the validity of the Request and its items. To do so, execute `POST /api/core/v1/Requests/Outgoing/Validate` with the Request. -{% include rapidoc api_route_regex="^post /api/v2/Requests/Outgoing/Validate$" %} +{% include rapidoc api_route_regex="^post /api/core/v1/Requests/Outgoing/Validate$" %} Even though the Requests are validated during the RelationshipTemplate creation, you should not skip this step, as it gives you additional information in case of validation errors. {: .notice--info} @@ -158,7 +158,7 @@ Even though the Requests are validated during the RelationshipTemplate creation, ### Connector: Create a RelationshipTemplate If the Connector states your Request as valid, we can create the RelationshipTemplate. -To do so, we use the `content` we just validated in `POST /api/v2/RelationshipTemplates/Own`. +To do so, we use the `content` we just validated in `POST /api/core/v1/RelationshipTemplates/Own`. Furthermore, we specify an expiration date, which is located in the future, and restrict the access to a single allocation. ```jsonc @@ -175,16 +175,16 @@ Furthermore, we specify an expiration date, which is located in the future, and } ``` -{% include rapidoc api_route_regex="^post /api/v2/RelationshipTemplates/Own$" %} +{% include rapidoc api_route_regex="^post /api/core/v1/RelationshipTemplates/Own$" %} {% include copy-notice description="Save the `id` of the RelationshipTemplate that you can find in the Response. You will need it in the next step." %} ### Connector: Create a QR code for the RelationshipTemplate Now, to allow the App to retrieve the RelationshipTemplate, we create a QR code, that can be scanned by the App. -For this, execute the `GET /api/v2/RelationshipTemplates/{id}` route (Accept Header: `image/png`) and use the `id` of the RelationshipTemplate from the previous step as the value for `id`. +For this, execute the `GET /api/core/v1/RelationshipTemplates/{id}` route (Accept Header: `image/png`) and use the `id` of the RelationshipTemplate from the previous step as the value for `id`. -{% include rapidoc api_route_regex="^get /api/v2/RelationshipTemplates/{id}$" %} +{% include rapidoc api_route_regex="^get /api/core/v1/RelationshipTemplates/{id}$" %} ### App: Initiate a Relationship @@ -201,12 +201,12 @@ Finally, fill out the required fields and click on "Add contact" to send the Rel In order to move the Relationship into the `Active` state, we now need to [accept the Relationship]({% link _docs_use-cases/use-case-transport-accept-relationship.md %}) with the Connector. To do so, we [synchronize updates of the Backbone]({% link _docs_use-cases/use-case-transport-synchronize-updates-of-backbone.md %}), which will fetch all changes that occurred since the last time this endpoint was executed. -{% include rapidoc api_route_regex="^post /api/v2/Account/Sync$" %} +{% include rapidoc api_route_regex="^post /api/core/v1/Account/Sync$" %} The synchronization causes the `transport.relationshipChanged` [Connector event]({% link _docs_integrate/connector-events.md %}) to be triggered, which should be listened to in order to get the Relationship in status `Pending`. -We can also [get the Relationship]({% link _docs_use-cases/use-case-transport-query-relationships.md %}) via `GET /api/v2/Relationships`. Should you be repeating this tutorial, you could e.g. filter by the `id` of the RelationshipTemplate from earlier via `GET /api/v2/Relationships?templateId=` if you use a different RelationshipTemplate. +We can also [get the Relationship]({% link _docs_use-cases/use-case-transport-query-relationships.md %}) via `GET /api/core/v1/Relationships`. Should you be repeating this tutorial, you could e.g. filter by the `id` of the RelationshipTemplate from earlier via `GET /api/core/v1/Relationships?templateId=` if you use a different RelationshipTemplate. -{% include rapidoc api_route_regex="^get /api/v2/Relationships$" %} +{% include rapidoc api_route_regex="^get /api/core/v1/Relationships$" %} Example: @@ -223,9 +223,9 @@ Example: } ``` -{% include copy-notice description="Save the `id` of the Relationship (`REL_________________`) and use it as input to the `PUT /api/v2/Relationships/{id}/Accept` route. You can leave that Request body as it is." %} +{% include copy-notice description="Save the `id` of the Relationship (`REL_________________`) and use it as input to the `PUT /api/core/v1/Relationships/{id}/Accept` route. You can leave that Request body as it is." %} -{% include rapidoc api_route_regex="^put /api/v2/Relationships/{id}/Accept$" %} +{% include rapidoc api_route_regex="^put /api/core/v1/Relationships/{id}/Accept$" %} Now the Relationship is in the `Active` state, so we can start to communicate with the opposite Identity, which we will do in the next part of this tutorial. For this, we will need the `address` of that [Identity]({% link _docs_integrate/data-model-overview.md %}#identity). @@ -257,7 +257,7 @@ Further, the `subject` and `body` properties can be modified with some custom `c } ``` -{% include rapidoc api_route_regex="^post /api/v2/Messages$" %} +{% include rapidoc api_route_regex="^post /api/core/v1/Messages$" %} After having sent the Message, you should receive a push notification on your phone. Open the enmeshed App, navigate to "Contacts" and select the Relationship. @@ -272,11 +272,11 @@ Then, tap on "New Message", enter a subject and body and tap on "Send". In order to fetch the Message, we need to synchronize the Connector with the Backbone again. -{% include rapidoc api_route_regex="^post /api/v2/Account/Sync$" %} +{% include rapidoc api_route_regex="^post /api/core/v1/Account/Sync$" %} -After syncing, all Messages can be displayed with the `GET /api/v2/Messages` route. Additionally, the [Event]({% link _docs_integrate/connector-events.md %}) `transport.messageReceived` is triggered after a Message is received. If you use the [Message Broker Publisher Module]({% link _docs_operate/modules.md %}#messagebrokerpublisher) or the [Webhooks Module]({% link _docs_operate/modules.md %}#webhooks) to subscribe to this event, you will receive the information whenever a new Message arrives. +After syncing, all Messages can be displayed with the `GET /api/core/v1/Messages` route. Additionally, the [Event]({% link _docs_integrate/connector-events.md %}) `transport.messageReceived` is triggered after a Message is received. If you use the [Message Broker Publisher Module]({% link _docs_operate/modules.md %}#messagebrokerpublisher) or the [Webhooks Module]({% link _docs_operate/modules.md %}#webhooks) to subscribe to this event, you will receive the information whenever a new Message arrives. -{% include rapidoc api_route_regex="^get /api/v2/Messages$" %} +{% include rapidoc api_route_regex="^get /api/core/v1/Messages$" %} The response should contain a Message with the `content` you entered in the App. diff --git a/_docs_integrate/migration-from-v4-to-v5.md b/_docs_integrate/migration-from-v4-to-v5.md index 5df8be42b..86fc0d17c 100644 --- a/_docs_integrate/migration-from-v4-to-v5.md +++ b/_docs_integrate/migration-from-v4-to-v5.md @@ -47,14 +47,14 @@ More [detailed explanations]({% link _docs_integrate/migration-from-v4-to-v5.md - The [RelationshipChanges have been removed]({% link _docs_integrate/migration-from-v4-to-v5.md %}#removal-of-relationshipchanges). - This has led to the removal of the `changes` property of the [Relationship]({% link _docs_integrate/data-model-overview.md %}#relationship) and the addition of the `creationContent` and `auditLog` properties to the Relationship. - In particular, the use cases for accepting and rejecting RelationshipChanges had to be removed. With the use cases [Accept Relationship]({% link _docs_use-cases/use-case-transport-accept-relationship.md %}) and [Reject Relationship]({% link _docs_use-cases/use-case-transport-reject-relationship.md %}), two [new use cases]({% link _docs_integrate/migration-from-v4-to-v5.md %}#removal-of-relationshipchanges-1) have been added that now provide these functionalities. - - For this reason, the route `PUT /api/v2/Relationships/{id}/Accept` must be executed instead of the route `PUT /api/v2/Relationships/{id}/Changes/{changeId}/Accept` and the route `PUT /api/v2/Relationships/{id}/Reject` must be executed instead of the route `PUT /api/v2/Relationships/{id}/Changes/{changeId}/Reject` when using the Connector. In contrast to the old Connector routes, a request body no longer needs to be provided when using the new Connector routes. + - For this reason, the route `PUT /api/core/v1/Relationships/{id}/Accept` must be executed instead of the route `PUT /api/core/v1/Relationships/{id}/Changes/{changeId}/Accept` and the route `PUT /api/core/v1/Relationships/{id}/Reject` must be executed instead of the route `PUT /api/core/v1/Relationships/{id}/Changes/{changeId}/Reject` when using the Connector. In contrast to the old Connector routes, a request body no longer needs to be provided when using the new Connector routes. - Non-standard `content` of a [Message]({% link _docs_integrate/data-model-overview.md %}#message), non-standard `content` of a [RelationshipTemplate]({% link _docs_integrate/data-model-overview.md %}#relationshiptemplate) and non-standard `creationContent` of a [Relationship]({% link _docs_integrate/data-model-overview.md %}#relationship) is now typed. The [new mandatory wrappers]({% link _docs_integrate/migration-from-v4-to-v5.md %}#new-mandatory-wrappers-for-non-standard-content-of-messages-relationshiptemplates-and-relationships) are [ArbitraryMessageContent]({% link _docs_integrate/data-model-overview.md %}#arbitrarymessagecontent), [ArbitraryRelationshipTemplateContent]({% link _docs_integrate/data-model-overview.md %}#arbitraryrelationshiptemplatecontent) and [ArbitraryRelationshipCreationContent]({% link _docs_integrate/data-model-overview.md %}#arbitraryrelationshipcreationcontent), respectively, which must now be used. - The `mustBeAccepted` property of the [RequestItemGroup]({% link _docs_integrate/data-model-overview.md %}#requestitemgroup) has been removed, which is why this [property must be removed if RequestItemGroups were used]({% link _docs_integrate/migration-from-v4-to-v5.md %}#removal-of-the-mustbeaccepted-property-of-the-requestitemgroup). - The type of the `owner` property of the [ThirdPartyRelationshipAttributeQuery]({% link _docs_integrate/data-model-overview.md %}#thirdpartyrelationshipattributequery) has changed. The [values specified for this property must therefore be adjusted if ThirdPartyRelationshipAttributeQueries were used]({% link _docs_integrate/migration-from-v4-to-v5.md %}#changed-type-of-the-owner-property-of-the-thirdpartyrelationshipattributequery). ### Changed Behavior of Known Features -- The [Synchronize updates of Backbone]({% link _docs_use-cases/use-case-transport-synchronize-updates-of-backbone.md %}) use case, which corresponds to the Connector route `POST /api/v2/Account/Sync`, no longer returns any content. Previously, new Messages or changes to Relationships were shown in the response after the use case was executed. As the [synchronization with the Backbone no longer returns anything]({% link _docs_integrate/migration-from-v4-to-v5.md %}#synchronization-with-backbone-returns-no-content-anymore), the corresponding [events]({% link _docs_integrate/connector-events.md %}) must be listened to instead in order to be informed about new Messages or changes to Relationships. +- The [Synchronize updates of Backbone]({% link _docs_use-cases/use-case-transport-synchronize-updates-of-backbone.md %}) use case, which corresponds to the Connector route `POST /api/core/v1/Account/Sync`, no longer returns any content. Previously, new Messages or changes to Relationships were shown in the response after the use case was executed. As the [synchronization with the Backbone no longer returns anything]({% link _docs_integrate/migration-from-v4-to-v5.md %}#synchronization-with-backbone-returns-no-content-anymore), the corresponding [events]({% link _docs_integrate/connector-events.md %}) must be listened to instead in order to be informed about new Messages or changes to Relationships. - Stricter [validation of Requests]({% link _docs_integrate/migration-from-v4-to-v5.md %}#validation-of-requests) has been added. Therefore, changes will probably have to be made to existing Request flows. Both [sending Requests]({% link _docs_integrate/migration-from-v4-to-v5.md %}#sending-of-requests) and [responding to Requests]({% link _docs_integrate/migration-from-v4-to-v5.md %}#responding-to-requests) are affected. ### Changes to Error Codes, Connector Routes and Events @@ -63,8 +63,8 @@ Changes have been made to the [error codes]({% link _docs_integrate/error-codes. - An overview of the [removed and changed error codes]({% link _docs_integrate/migration-from-v4-to-v5.md %}#removed-and-changed-error-codes) can be found below. - An overview of the [removed, changed and added use cases]({% link _docs_integrate/migration-from-v4-to-v5.md %}#removed-changed-and-added-use-cases) with regard to their impact on the Connector routes can be found below. - - In particular, it must be noted that the [use case of getting shared versions of a RepositoryAttribute has been renamed]({% link _docs_integrate/migration-from-v4-to-v5.md %}#renaming-of-the-use-case-getsharedversionsofrepositoryattribute-to-getsharedversionsofattribute). The [Get shared versions of an Attribute]({% link _docs_use-cases/use-case-consumption-get-shared-versions-of-an-attribute.md %}) use case must now be executed instead. Please note, however, that the associated Connector route `GET /api/v2/Attributes/{id}/Versions/Shared` has not changed. - - With the execution of the Connector route `POST /api/v2/Attributes`, which corresponds to the execution of the associated [Create a RepositoryAttribute]({% link _docs_use-cases/use-case-consumption-create-a-repositoryattribute.md %}) use case, an [IdentityAttribute]({% link _docs_integrate/data-model-overview.md %}#identityattribute) can be created for yourself. When executing this Connector route, the fields `content.@type` and `content.owner` may no longer be specified as input. This is due to the fact that previously only the IdentityAttribute as `@type` and the own address as the value of the `owner` property of the [Attribute]({% link _docs_integrate/data-model-overview.md %}#attributes) to be created for yourself came into question anyway. Therefore, [less input needs to be provided when executing the use case to create a RepositoryAttribute]({% link _docs_integrate/migration-from-v4-to-v5.md %}#less-input-needed-for-the-use-case-createrepositoryattribute). + - In particular, it must be noted that the [use case of getting shared versions of a RepositoryAttribute has been renamed]({% link _docs_integrate/migration-from-v4-to-v5.md %}#renaming-of-the-use-case-getsharedversionsofrepositoryattribute-to-getsharedversionsofattribute). The [Get shared versions of an Attribute]({% link _docs_use-cases/use-case-consumption-get-shared-versions-of-an-attribute.md %}) use case must now be executed instead. Please note, however, that the associated Connector route `GET /api/core/v1/Attributes/{id}/Versions/Shared` has not changed. + - With the execution of the Connector route `POST /api/core/v1/Attributes`, which corresponds to the execution of the associated [Create a RepositoryAttribute]({% link _docs_use-cases/use-case-consumption-create-a-repositoryattribute.md %}) use case, an [IdentityAttribute]({% link _docs_integrate/data-model-overview.md %}#identityattribute) can be created for yourself. When executing this Connector route, the fields `content.@type` and `content.owner` may no longer be specified as input. This is due to the fact that previously only the IdentityAttribute as `@type` and the own address as the value of the `owner` property of the [Attribute]({% link _docs_integrate/data-model-overview.md %}#attributes) to be created for yourself came into question anyway. Therefore, [less input needs to be provided when executing the use case to create a RepositoryAttribute]({% link _docs_integrate/migration-from-v4-to-v5.md %}#less-input-needed-for-the-use-case-createrepositoryattribute). - An overview of the [renamed and added events]({% link _docs_integrate/migration-from-v4-to-v5.md %}#renamed-and-added-events) can be found below. ## Detailed Explanations @@ -98,10 +98,10 @@ The functionalities of the old two use cases of accepting and rejecting Relation This means that no `content` must be sent with any of these operations anymore. The former, more generic Connector routes using RelationshipChanges could also have been used to accept or reject changes to a Relationship other than the establishment of an active Relationship, which might have required the transmission of additional data. -| Old Connector route | New Connector route | -| ---------------------------------------------------------------------------------- | ------------------------------------------------------------- | -| `PUT /api/v2/Relationships/{relationshipId}/Changes/{changeId}/Accept` (with body) | `PUT /api/v2/Relationships/{relationshipId}/Accept` (no body) | -| `PUT /api/v2/Relationships/{relationshipId}/Changes/{changeId}/Reject` (with body) | `PUT /api/v2/Relationships/{relationshipId}/Reject` (no body) | +| Old Connector route | New Connector route | +| --------------------------------------------------------------------------------------- | ------------------------------------------------------------------ | +| `PUT /api/core/v1/Relationships/{relationshipId}/Changes/{changeId}/Accept` (with body) | `PUT /api/core/v1/Relationships/{relationshipId}/Accept` (no body) | +| `PUT /api/core/v1/Relationships/{relationshipId}/Changes/{changeId}/Reject` (with body) | `PUT /api/core/v1/Relationships/{relationshipId}/Reject` (no body) | #### Modifications to Relationship @@ -131,7 +131,7 @@ These new wrappers are all of the following form, whereby the `<...>` notation i } ``` -Thus, when [sending a Message]({% link _docs_use-cases/use-case-transport-send-message-to-recipients.md %}) with non-standard `content` via `POST /api/v2/Messages`, instead of using the parameter `content : `, it must be used: +Thus, when [sending a Message]({% link _docs_use-cases/use-case-transport-send-message-to-recipients.md %}) with non-standard `content` via `POST /api/core/v1/Messages`, instead of using the parameter `content : `, it must be used: ```jsonc "content": { @@ -140,7 +140,7 @@ Thus, when [sending a Message]({% link _docs_use-cases/use-case-transport-send-m } ``` -Similarly, when [creating an own RelationshipTemplate]({% link _docs_use-cases/use-case-transport-create-own-relationshiptemplate.md %}) with non-standard `content` via the Connector route `POST /api/v2/RelationshipTemplates/Own`, it must be provided: +Similarly, when [creating an own RelationshipTemplate]({% link _docs_use-cases/use-case-transport-create-own-relationshiptemplate.md %}) with non-standard `content` via the Connector route `POST /api/core/v1/RelationshipTemplates/Own`, it must be provided: ```jsonc "content": { @@ -149,7 +149,7 @@ Similarly, when [creating an own RelationshipTemplate]({% link _docs_use-cases/u } ``` -Last but not least, when [creating a Relationship]({% link _docs_use-cases/use-case-transport-create-relationship-with-relationshiptemplate.md %}) with non-standard `creationContent` via the Connector route `POST /api/v2/Relationships`, it must be utilized: +Last but not least, when [creating a Relationship]({% link _docs_use-cases/use-case-transport-create-relationship-with-relationshiptemplate.md %}) with non-standard `creationContent` via the Connector route `POST /api/core/v1/Relationships`, it must be utilized: ```jsonc "creationContent": { @@ -190,7 +190,7 @@ This change enables the Sender of the Request to specify more precisely which Id ### Synchronization With Backbone Returns No Content Anymore -Previously, the [synchronization with the Backbone]({% link _docs_use-cases/use-case-transport-synchronize-updates-of-backbone.md %}) via the route `POST /api/v2/Account/Sync` returned a list of Relationships and Messages with the HTTP code 201. This has been changed to the sync returning nothing with the HTTP code 204. This removes the support for the workflow of regularly calling the sync and checking the response since unexpected response values happen if syncs are executed from different spots. We recommend working event-based with the [Message Broker Publisher Module]({% link _docs_operate/modules.md %}#messagebrokerpublisher), which sends events to a message broker you have set up. We send a variety of events like `consumption.incomingRequestReceived` or `consumption.incomingRequestStatusChanged`, each of them containing the relevant changed object. See [Connector Events]({% link _docs_integrate/connector-events.md %}) for the full list. Slightly related, we also recommend using the recently published [Server-Sent Events Module]({% link _docs_operate/modules.md %}#sse), which listens to events emitted from the Backbone and syncs with the Backbone when an event is received. +Previously, the [synchronization with the Backbone]({% link _docs_use-cases/use-case-transport-synchronize-updates-of-backbone.md %}) via the route `POST /api/core/v1/Account/Sync` returned a list of Relationships and Messages with the HTTP code 201. This has been changed to the sync returning nothing with the HTTP code 204. This removes the support for the workflow of regularly calling the sync and checking the response since unexpected response values happen if syncs are executed from different spots. We recommend working event-based with the [Message Broker Publisher Module]({% link _docs_operate/modules.md %}#messagebrokerpublisher), which sends events to a message broker you have set up. We send a variety of events like `consumption.incomingRequestReceived` or `consumption.incomingRequestStatusChanged`, each of them containing the relevant changed object. See [Connector Events]({% link _docs_integrate/connector-events.md %}) for the full list. Slightly related, we also recommend using the recently published [Server-Sent Events Module]({% link _docs_operate/modules.md %}#sse), which listens to events emitted from the Backbone and syncs with the Backbone when an event is received. ### Validation of Requests @@ -229,19 +229,19 @@ An overview of the [Use Cases]({% link _docs_integrate/use-cases.md %}) that may #### Revocation of Relationships The [Revoke Relationship]({% link _docs_use-cases/use-case-transport-revoke-relationship.md %}) use case has been added. -It is now possible to revoke a [Relationship]({% link _docs_integrate/data-model-overview.md %}#relationship) with `"Pending"` as `status` if it was created by yourself. To execute this use case, the Connector route `PUT /api/v2/Relationships/{id}/Revoke` can be used. +It is now possible to revoke a [Relationship]({% link _docs_integrate/data-model-overview.md %}#relationship) with `"Pending"` as `status` if it was created by yourself. To execute this use case, the Connector route `PUT /api/core/v1/Relationships/{id}/Revoke` can be used. #### Removal of RelationshipChanges The [removal of RelationshipChanges](#removal-of-relationshipchanges) is the reason why the following use cases are removed: -- The use case for accepting RelationshipChanges along with the associated Connector route `PUT /api/v2/Relationships/{id}/Changes/{changeId}/Accept`. -- The use case for rejecting RelationshipChanges along with the associated Connector route `PUT /api/v2/Relationships/{id}/Changes/{changeId}/Reject`. +- The use case for accepting RelationshipChanges along with the associated Connector route `PUT /api/core/v1/Relationships/{id}/Changes/{changeId}/Accept`. +- The use case for rejecting RelationshipChanges along with the associated Connector route `PUT /api/core/v1/Relationships/{id}/Changes/{changeId}/Reject`. Therefore, the following new use cases had to be added, which now provide these functionalities: -- The [Accept Relationship]({% link _docs_use-cases/use-case-transport-accept-relationship.md %}) use case along with the `PUT /api/v2/Relationships/{id}/Accept` Connector route. -- The [Reject Relationship]({% link _docs_use-cases/use-case-transport-reject-relationship.md %}) use case along with the `PUT /api/v2/Relationships/{id}/Reject` Connector route. +- The [Accept Relationship]({% link _docs_use-cases/use-case-transport-accept-relationship.md %}) use case along with the `PUT /api/core/v1/Relationships/{id}/Accept` Connector route. +- The [Reject Relationship]({% link _docs_use-cases/use-case-transport-reject-relationship.md %}) use case along with the `PUT /api/core/v1/Relationships/{id}/Reject` Connector route. #### Termination of Relationships @@ -261,18 +261,18 @@ Taking [ThirdPartyRelationshipAttributes]({% link _docs_integrate/data-model-ove For this reason, the [Get shared versions of an Attribute]({% link _docs_use-cases/use-case-consumption-get-shared-versions-of-an-attribute.md %}) use case was already added in version 4 and the use case of getting shared versions of a RepositoryAttribute was marked as deprecated. It has now been deleted with the update to version 5. -Please note, however, that the Connector route `GET /api/v2/Attributes/{id}/Versions/Shared` that belonged to the use case of getting shared versions of a RepositoryAttribute can still be used. If the Connector route `GET /api/v2/Attributes/{id}/Versions/Shared` is executed, the [Get shared versions of an Attribute]({% link _docs_use-cases/use-case-consumption-get-shared-versions-of-an-attribute.md %}) use case is now executed instead. +Please note, however, that the Connector route `GET /api/core/v1/Attributes/{id}/Versions/Shared` that belonged to the use case of getting shared versions of a RepositoryAttribute can still be used. If the Connector route `GET /api/core/v1/Attributes/{id}/Versions/Shared` is executed, the [Get shared versions of an Attribute]({% link _docs_use-cases/use-case-consumption-get-shared-versions-of-an-attribute.md %}) use case is now executed instead. As the functionality has only been extended, there is no breaking change with regard to the Connector route. #### Less Input Needed for the Use Case CreateRepositoryAttribute -In version 4, there was already a use case for creating Attributes for yourself that could be executed by Connector route `POST /api/v2/Attributes`. +In version 4, there was already a use case for creating Attributes for yourself that could be executed by Connector route `POST /api/core/v1/Attributes`. An Attribute created for yourself is automatically an [IdentityAttribute]({% link _docs_integrate/data-model-overview.md %}#identityattribute) which is owned by yourself. Technically, this corresponds exactly to the creation of a [RepositoryAttribute]({% link _docs_integrate/data-model-overview.md %}#localattribute). Therefore, the use case for creating Attributes for yourself is named the [Create a RepositoryAttribute]({% link _docs_use-cases/use-case-consumption-create-a-repositoryattribute.md %}) use case. When [creating Attributes for yourself]({% link _docs_integrate/create-attributes-for-yourself.md %}), it is therefore apparently not valuable to have to explicitly specify that an IdentityAttribute should be created instead of a RelationshipAttribute and that the IdentityAttribute should be owned by yourself instead of another Identity. -For this reason, when executing the Connector route `POST /api/v2/Attributes`, which corresponds to the execution of the associated [Create a RepositoryAttribute]({% link _docs_use-cases/use-case-consumption-create-a-repositoryattribute.md %}) use case, less input must now be provided, since the `@type` and the `owner` of the [Attribute]({% link _docs_integrate/data-model-overview.md %}#attributes) to be created may no longer be specified. +For this reason, when executing the Connector route `POST /api/core/v1/Attributes`, which corresponds to the execution of the associated [Create a RepositoryAttribute]({% link _docs_use-cases/use-case-consumption-create-a-repositoryattribute.md %}) use case, less input must now be provided, since the `@type` and the `owner` of the [Attribute]({% link _docs_integrate/data-model-overview.md %}#attributes) to be created may no longer be specified. ### Renamed and Added Events diff --git a/_docs_integrate/migration-from-v5-to-v6.md b/_docs_integrate/migration-from-v5-to-v6.md index 4a064e780..5081ff29d 100644 --- a/_docs_integrate/migration-from-v5-to-v6.md +++ b/_docs_integrate/migration-from-v5-to-v6.md @@ -30,7 +30,7 @@ To support the migration of existing systems to the new version, the breaking ch ## Removal of Routes for loading peer objects by id and key -The routes `POST /api/v2/Files/Peer`, `POST /api/v2/RelationshipTemplates/Peer`, `POST /api/v2/Tokens/Peer` all had the possibility to load peer objects with two different payloads: +The routes `POST /api/core/v1/Files/Peer`, `POST /api/core/v1/RelationshipTemplates/Peer`, `POST /api/core/v1/Tokens/Peer` all had the possibility to load peer objects with two different payloads: ```json { diff --git a/_docs_integrate/migration-from-v6-to-v7.md b/_docs_integrate/migration-from-v6-to-v7.md index cd196610e..52870a24c 100644 --- a/_docs_integrate/migration-from-v6-to-v7.md +++ b/_docs_integrate/migration-from-v6-to-v7.md @@ -70,7 +70,7 @@ The step-by-step instructions can be consulted to start the migration to version ### Removed and Changed Connector Routes -- The `GET /api/v2/Attributes/Valid` Connector route and its underlying [use case]({% link _docs_integrate/use-cases.md %}) for getting valid [Attributes]({% link _docs_integrate/data-model-overview.md %}#attributes) were removed, because the properties `validFrom` and `validTo` have been removed from the Attributes. +- The `GET /api/core/v1/Attributes/Valid` Connector route and its underlying [use case]({% link _docs_integrate/use-cases.md %}) for getting valid [Attributes]({% link _docs_integrate/data-model-overview.md %}#attributes) were removed, because the properties `validFrom` and `validTo` have been removed from the Attributes. - For the same reason, the `onlyValid` parameter was removed from the use cases [Get Attributes]({% link _docs_use-cases/use-case-consumption-get-attributes.md %}), [Get own shared Attributes]({% link _docs_use-cases/use-case-consumption-get-own-shared-attributes.md %}) and [Get peer shared Attributes]({% link _docs_use-cases/use-case-consumption-get-peer-shared-attributes.md %}). Accordingly, it was removed from the associated Connector routes as well. diff --git a/_docs_operate/modules.md b/_docs_operate/modules.md index 740be42a2..35ff906c2 100644 --- a/_docs_operate/modules.md +++ b/_docs_operate/modules.md @@ -36,7 +36,7 @@ It is not recommended to use this Module for production scenarios. The `autoAcceptPendingRelationships` Module listens to the [events]({% link _docs_integrate/connector-events.md %}) about changed Relationships. It immediately accepts pending Relationships. -Keep in mind that you need to synchronize the state of the Connector with the Backbone in order to receive changed Relationships. The `sync` Module automates this, but you can also do this manually by calling the `/api/v2/Account/Sync` route. +Keep in mind that you need to synchronize the state of the Connector with the Backbone in order to receive changed Relationships. The `sync` Module automates this, but you can also do this manually by calling the `/api/core/v1/Account/Sync` route. ### Core HTTP API {#corehttpapi} @@ -64,7 +64,7 @@ With the REST API, pull mechanisms are supported. However, as there are many bid For this, the Connector supports the configuration of webhooks which are called every time a specific [Connector Event]({% link _docs_integrate/connector-events.md %}) is triggered (e.g. a new Message has been received => `transport.messageReceived`). -Keep in mind that you need to synchronize the state of the Connector with the Backbone in order to receive events. The `sync` Module automates this, but you can also do this manually by calling the `/api/v2/Account/Sync` route. +Keep in mind that you need to synchronize the state of the Connector with the Backbone in order to receive events. The `sync` Module automates this, but you can also do this manually by calling the `/api/core/v1/Account/Sync` route. ### sse (Server-Sent Events) {#sse} 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 509e11cf8..2cea9aaa2 100644 --- a/_docs_use-cases/use-case-consumption-accept-incoming-request.md +++ b/_docs_use-cases/use-case-consumption-accept-incoming-request.md @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: PUT /api/v2/Requests/Incoming/{id}/Accept + - api_route_regex: PUT /api/core/v1/Requests/Incoming/{id}/Accept - published: default - link: use-case-consumption-accept-incoming-request require: required_by: -api_route_regex: ^PUT /api/v2/Requests/Incoming/{id}/Accept$ +api_route_regex: ^PUT /api/core/v1/Requests/Incoming/{id}/Accept$ # End automatic generation --- 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 54d01f6c4..94bded44e 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 @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: PUT /api/v2/Requests/Incoming/{id}/CanAccept + - api_route_regex: PUT /api/core/v1/Requests/Incoming/{id}/CanAccept - published: default - link: use-case-consumption-check-if-incoming-request-can-be-accepted require: required_by: -api_route_regex: ^PUT /api/v2/Requests/Incoming/{id}/CanAccept$ +api_route_regex: ^PUT /api/core/v1/Requests/Incoming/{id}/CanAccept$ # End automatic generation --- 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 2c683ba1e..f93985e4a 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 @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: PUT /api/v2/Requests/Incoming/{id}/CanReject + - api_route_regex: PUT /api/core/v1/Requests/Incoming/{id}/CanReject - published: default - link: use-case-consumption-check-if-incoming-request-can-be-rejected require: required_by: -api_route_regex: ^PUT /api/v2/Requests/Incoming/{id}/CanReject$ +api_route_regex: ^PUT /api/core/v1/Requests/Incoming/{id}/CanReject$ # End automatic generation --- 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 180a5ff0c..286928e5d 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 @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: POST /api/v2/Requests/Outgoing/Validate + - api_route_regex: POST /api/core/v1/Requests/Outgoing/Validate - published: default - link: use-case-consumption-check-if-outgoing-request-can-be-created require: required_by: -api_route_regex: ^POST /api/v2/Requests/Outgoing/Validate$ +api_route_regex: ^POST /api/core/v1/Requests/Outgoing/Validate$ # End automatic generation --- diff --git a/_docs_use-cases/use-case-consumption-check-if-repositoryattribute-can-be-created.md b/_docs_use-cases/use-case-consumption-check-if-repositoryattribute-can-be-created.md index a3ca21125..340e9fdb9 100644 --- a/_docs_use-cases/use-case-consumption-check-if-repositoryattribute-can-be-created.md +++ b/_docs_use-cases/use-case-consumption-check-if-repositoryattribute-can-be-created.md @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: PUT /api/v2/Attributes/CanCreate + - api_route_regex: PUT /api/core/v1/Attributes/CanCreate - published: default - link: use-case-consumption-check-if-repositoryattribute-can-be-created require: required_by: -api_route_regex: ^PUT /api/v2/Attributes/CanCreate$ +api_route_regex: ^PUT /api/core/v1/Attributes/CanCreate$ # End automatic generation --- diff --git a/_docs_use-cases/use-case-consumption-create-a-repositoryattribute.md b/_docs_use-cases/use-case-consumption-create-a-repositoryattribute.md index c1436cac7..52ed90486 100644 --- a/_docs_use-cases/use-case-consumption-create-a-repositoryattribute.md +++ b/_docs_use-cases/use-case-consumption-create-a-repositoryattribute.md @@ -31,12 +31,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: POST /api/v2/Attributes + - api_route_regex: POST /api/core/v1/Attributes - published: default - link: use-case-consumption-create-a-repositoryattribute require: required_by: -api_route_regex: ^POST /api/v2/Attributes$ +api_route_regex: ^POST /api/core/v1/Attributes$ # End automatic generation --- 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 42df79f5e..38a5140bd 100644 --- a/_docs_use-cases/use-case-consumption-create-outgoing-request.md +++ b/_docs_use-cases/use-case-consumption-create-outgoing-request.md @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: POST /api/v2/Requests/Outgoing + - api_route_regex: POST /api/core/v1/Requests/Outgoing - published: default - link: use-case-consumption-create-outgoing-request require: required_by: -api_route_regex: ^POST /api/v2/Requests/Outgoing$ +api_route_regex: ^POST /api/core/v1/Requests/Outgoing$ # End automatic generation --- diff --git a/_docs_use-cases/use-case-consumption-delete-a-peer-shared-attribute-and-notify-peer.md b/_docs_use-cases/use-case-consumption-delete-a-peer-shared-attribute-and-notify-peer.md index 70b759af8..1b0da23ee 100644 --- a/_docs_use-cases/use-case-consumption-delete-a-peer-shared-attribute-and-notify-peer.md +++ b/_docs_use-cases/use-case-consumption-delete-a-peer-shared-attribute-and-notify-peer.md @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: DELETE /api/v2/Attributes/Peer/Shared/{id} + - api_route_regex: DELETE /api/core/v1/Attributes/Peer/Shared/{id} - published: default - link: use-case-consumption-delete-a-peer-shared-attribute-and-notify-peer require: required_by: -api_route_regex: ^DELETE /api/v2/Attributes/Peer/Shared/{id}$ +api_route_regex: ^DELETE /api/core/v1/Attributes/Peer/Shared/{id}$ # End automatic generation --- diff --git a/_docs_use-cases/use-case-consumption-delete-a-repositoryattribute.md b/_docs_use-cases/use-case-consumption-delete-a-repositoryattribute.md index 2136ba296..d815cdda9 100644 --- a/_docs_use-cases/use-case-consumption-delete-a-repositoryattribute.md +++ b/_docs_use-cases/use-case-consumption-delete-a-repositoryattribute.md @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: DELETE /api/v2/Attributes/{id} + - api_route_regex: DELETE /api/core/v1/Attributes/{id} - published: default - link: use-case-consumption-delete-a-repositoryattribute require: required_by: -api_route_regex: ^DELETE /api/v2/Attributes/{id}$ +api_route_regex: ^DELETE /api/core/v1/Attributes/{id}$ # End automatic generation --- diff --git a/_docs_use-cases/use-case-consumption-delete-a-thirdpartyrelationshipattribute-and-notify-peer.md b/_docs_use-cases/use-case-consumption-delete-a-thirdpartyrelationshipattribute-and-notify-peer.md index 647109799..29aa046fa 100644 --- a/_docs_use-cases/use-case-consumption-delete-a-thirdpartyrelationshipattribute-and-notify-peer.md +++ b/_docs_use-cases/use-case-consumption-delete-a-thirdpartyrelationshipattribute-and-notify-peer.md @@ -31,12 +31,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: DELETE /api/v2/Attributes/ThirdParty/{id} + - api_route_regex: DELETE /api/core/v1/Attributes/ThirdParty/{id} - published: default - link: use-case-consumption-delete-a-thirdpartyrelationshipattribute-and-notify-peer require: required_by: -api_route_regex: ^DELETE /api/v2/Attributes/ThirdParty/{id}$ +api_route_regex: ^DELETE /api/core/v1/Attributes/ThirdParty/{id}$ # End automatic generation --- diff --git a/_docs_use-cases/use-case-consumption-delete-an-own-shared-attribute-and-notify-peer.md b/_docs_use-cases/use-case-consumption-delete-an-own-shared-attribute-and-notify-peer.md index 191f6ff2b..0d9186335 100644 --- a/_docs_use-cases/use-case-consumption-delete-an-own-shared-attribute-and-notify-peer.md +++ b/_docs_use-cases/use-case-consumption-delete-an-own-shared-attribute-and-notify-peer.md @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: DELETE /api/v2/Attributes/Own/Shared/{id} + - api_route_regex: DELETE /api/core/v1/Attributes/Own/Shared/{id} - published: default - link: use-case-consumption-delete-an-own-shared-attribute-and-notify-peer require: required_by: -api_route_regex: ^DELETE /api/v2/Attributes/Own/Shared/{id}$ +api_route_regex: ^DELETE /api/core/v1/Attributes/Own/Shared/{id}$ # End automatic generation --- diff --git a/_docs_use-cases/use-case-consumption-delete-identitymetadata.md b/_docs_use-cases/use-case-consumption-delete-identitymetadata.md index 9055ac577..eee924e3a 100644 --- a/_docs_use-cases/use-case-consumption-delete-identitymetadata.md +++ b/_docs_use-cases/use-case-consumption-delete-identitymetadata.md @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: DELETE /api/v2/IdentityMetadata + - api_route_regex: DELETE /api/core/v1/IdentityMetadata - published: default - link: use-case-consumption-delete-identitymetadata require: required_by: -api_route_regex: ^DELETE /api/v2/IdentityMetadata$ +api_route_regex: ^DELETE /api/core/v1/IdentityMetadata$ # End automatic generation --- 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 ae28d1682..2707e6a5f 100644 --- a/_docs_use-cases/use-case-consumption-execute-a-relationshipattributequery.md +++ b/_docs_use-cases/use-case-consumption-execute-a-relationshipattributequery.md @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: POST /api/v2/Attributes/ExecuteRelationshipAttributeQuery + - api_route_regex: POST /api/core/v1/Attributes/ExecuteRelationshipAttributeQuery - published: default - link: use-case-consumption-execute-a-relationshipattributequery require: required_by: -api_route_regex: ^POST /api/v2/Attributes/ExecuteRelationshipAttributeQuery$ +api_route_regex: ^POST /api/core/v1/Attributes/ExecuteRelationshipAttributeQuery$ # End automatic generation --- diff --git a/_docs_use-cases/use-case-consumption-execute-a-thirdpartyrelationshipattributequery.md b/_docs_use-cases/use-case-consumption-execute-a-thirdpartyrelationshipattributequery.md index c15dc31d8..53daf0e80 100644 --- a/_docs_use-cases/use-case-consumption-execute-a-thirdpartyrelationshipattributequery.md +++ b/_docs_use-cases/use-case-consumption-execute-a-thirdpartyrelationshipattributequery.md @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: POST /api/v2/Attributes/ExecuteThirdPartyRelationshipAttributeQuery + - api_route_regex: POST /api/core/v1/Attributes/ExecuteThirdPartyRelationshipAttributeQuery - published: default - link: use-case-consumption-execute-a-thirdpartyrelationshipattributequery require: required_by: -api_route_regex: ^POST /api/v2/Attributes/ExecuteThirdPartyRelationshipAttributeQuery$ +api_route_regex: ^POST /api/core/v1/Attributes/ExecuteThirdPartyRelationshipAttributeQuery$ # End automatic generation --- 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 c4033a102..ba5a19a0e 100644 --- a/_docs_use-cases/use-case-consumption-execute-an-identityattributequery.md +++ b/_docs_use-cases/use-case-consumption-execute-an-identityattributequery.md @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: POST /api/v2/Attributes/ExecuteIdentityAttributeQuery + - api_route_regex: POST /api/core/v1/Attributes/ExecuteIdentityAttributeQuery - published: default - link: use-case-consumption-execute-an-identityattributequery require: required_by: -api_route_regex: ^POST /api/v2/Attributes/ExecuteIdentityAttributeQuery$ +api_route_regex: ^POST /api/core/v1/Attributes/ExecuteIdentityAttributeQuery$ # End automatic generation --- 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 8624e684c..f4e54e6d9 100644 --- a/_docs_use-cases/use-case-consumption-execute-an-iqlquery.md +++ b/_docs_use-cases/use-case-consumption-execute-an-iqlquery.md @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: POST /api/v2/Attributes/ExecuteIQLQuery + - api_route_regex: POST /api/core/v1/Attributes/ExecuteIQLQuery - published: default - link: use-case-consumption-execute-an-iqlquery require: required_by: -api_route_regex: ^POST /api/v2/Attributes/ExecuteIQLQuery$ +api_route_regex: ^POST /api/core/v1/Attributes/ExecuteIQLQuery$ # End automatic generation --- diff --git a/_docs_use-cases/use-case-consumption-get-attribute.md b/_docs_use-cases/use-case-consumption-get-attribute.md index b4e8b5f66..d00882cc6 100644 --- a/_docs_use-cases/use-case-consumption-get-attribute.md +++ b/_docs_use-cases/use-case-consumption-get-attribute.md @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: GET /api/v2/Attributes/{id} + - api_route_regex: GET /api/core/v1/Attributes/{id} - published: default - link: use-case-consumption-get-attribute require: required_by: -api_route_regex: ^GET /api/v2/Attributes/{id}$ +api_route_regex: ^GET /api/core/v1/Attributes/{id}$ # End automatic generation --- diff --git a/_docs_use-cases/use-case-consumption-get-attributes.md b/_docs_use-cases/use-case-consumption-get-attributes.md index 48fbbeb22..29cfcc064 100644 --- a/_docs_use-cases/use-case-consumption-get-attributes.md +++ b/_docs_use-cases/use-case-consumption-get-attributes.md @@ -31,12 +31,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: GET /api/v2/Attributes + - api_route_regex: GET /api/core/v1/Attributes - published: default - link: use-case-consumption-get-attributes require: required_by: -api_route_regex: ^GET /api/v2/Attributes$ +api_route_regex: ^GET /api/core/v1/Attributes$ # End automatic generation --- diff --git a/_docs_use-cases/use-case-consumption-get-attributetagcollection.md b/_docs_use-cases/use-case-consumption-get-attributetagcollection.md index 7b520d73d..921df0ff3 100644 --- a/_docs_use-cases/use-case-consumption-get-attributetagcollection.md +++ b/_docs_use-cases/use-case-consumption-get-attributetagcollection.md @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: GET /api/v2/Attributes/TagCollection + - api_route_regex: GET /api/core/v1/Attributes/TagCollection - published: default - link: use-case-consumption-get-attributetagcollection require: required_by: -api_route_regex: ^GET /api/v2/Attributes/TagCollection$ +api_route_regex: ^GET /api/core/v1/Attributes/TagCollection$ # End automatic generation --- diff --git a/_docs_use-cases/use-case-consumption-get-identitymetadata.md b/_docs_use-cases/use-case-consumption-get-identitymetadata.md index c9c393198..d3471b6c3 100644 --- a/_docs_use-cases/use-case-consumption-get-identitymetadata.md +++ b/_docs_use-cases/use-case-consumption-get-identitymetadata.md @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: GET /api/v2/IdentityMetadata + - api_route_regex: GET /api/core/v1/IdentityMetadata - published: default - link: use-case-consumption-get-identitymetadata require: required_by: -api_route_regex: ^GET /api/v2/IdentityMetadata$ +api_route_regex: ^GET /api/core/v1/IdentityMetadata$ # End automatic generation --- 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 f4a4877ee..a8e1da5b0 100644 --- a/_docs_use-cases/use-case-consumption-get-incoming-request.md +++ b/_docs_use-cases/use-case-consumption-get-incoming-request.md @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: GET /api/v2/Requests/Incoming/{id} + - api_route_regex: GET /api/core/v1/Requests/Incoming/{id} - published: default - link: use-case-consumption-get-incoming-request require: required_by: -api_route_regex: ^GET /api/v2/Requests/Incoming/{id}$ +api_route_regex: ^GET /api/core/v1/Requests/Incoming/{id}$ # End automatic generation --- 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 8ec6fcf0b..2d329e2f3 100644 --- a/_docs_use-cases/use-case-consumption-get-outgoing-request.md +++ b/_docs_use-cases/use-case-consumption-get-outgoing-request.md @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: GET /api/v2/Requests/Outgoing/{id} + - api_route_regex: GET /api/core/v1/Requests/Outgoing/{id} - published: default - link: use-case-consumption-get-outgoing-request require: required_by: -api_route_regex: ^GET /api/v2/Requests/Outgoing/{id}$ +api_route_regex: ^GET /api/core/v1/Requests/Outgoing/{id}$ # End automatic generation --- diff --git a/_docs_use-cases/use-case-consumption-get-own-shared-attributes.md b/_docs_use-cases/use-case-consumption-get-own-shared-attributes.md index b35d9d9a0..46e5faff5 100644 --- a/_docs_use-cases/use-case-consumption-get-own-shared-attributes.md +++ b/_docs_use-cases/use-case-consumption-get-own-shared-attributes.md @@ -31,12 +31,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: GET /api/v2/Attributes/Own/Shared/Identity + - api_route_regex: GET /api/core/v1/Attributes/Own/Shared/Identity - published: default - link: use-case-consumption-get-own-shared-attributes require: required_by: -api_route_regex: ^GET /api/v2/Attributes/Own/Shared/Identity$ +api_route_regex: ^GET /api/core/v1/Attributes/Own/Shared/Identity$ # End automatic generation --- diff --git a/_docs_use-cases/use-case-consumption-get-peer-shared-attributes.md b/_docs_use-cases/use-case-consumption-get-peer-shared-attributes.md index b69783067..9c2c73ef9 100644 --- a/_docs_use-cases/use-case-consumption-get-peer-shared-attributes.md +++ b/_docs_use-cases/use-case-consumption-get-peer-shared-attributes.md @@ -31,12 +31,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: GET /api/v2/Attributes/Peer/Shared/Identity + - api_route_regex: GET /api/core/v1/Attributes/Peer/Shared/Identity - published: default - link: use-case-consumption-get-peer-shared-attributes require: required_by: -api_route_regex: ^GET /api/v2/Attributes/Peer/Shared/Identity$ +api_route_regex: ^GET /api/core/v1/Attributes/Peer/Shared/Identity$ # End automatic generation --- diff --git a/_docs_use-cases/use-case-consumption-get-repositoryattributes.md b/_docs_use-cases/use-case-consumption-get-repositoryattributes.md index 793154c66..ba8b3e178 100644 --- a/_docs_use-cases/use-case-consumption-get-repositoryattributes.md +++ b/_docs_use-cases/use-case-consumption-get-repositoryattributes.md @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: GET /api/v2/Attributes/Own/Repository + - api_route_regex: GET /api/core/v1/Attributes/Own/Repository - published: default - link: use-case-consumption-get-repositoryattributes require: required_by: -api_route_regex: ^GET /api/v2/Attributes/Own/Repository$ +api_route_regex: ^GET /api/core/v1/Attributes/Own/Repository$ # End automatic generation --- diff --git a/_docs_use-cases/use-case-consumption-get-shared-versions-of-an-attribute.md b/_docs_use-cases/use-case-consumption-get-shared-versions-of-an-attribute.md index 478b8c58f..560ae32c1 100644 --- a/_docs_use-cases/use-case-consumption-get-shared-versions-of-an-attribute.md +++ b/_docs_use-cases/use-case-consumption-get-shared-versions-of-an-attribute.md @@ -31,12 +31,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: GET /api/v2/Attributes/{id}/Versions/Shared + - api_route_regex: GET /api/core/v1/Attributes/{id}/Versions/Shared - published: default - link: use-case-consumption-get-shared-versions-of-an-attribute require: required_by: -api_route_regex: ^GET /api/v2/Attributes/{id}/Versions/Shared$ +api_route_regex: ^GET /api/core/v1/Attributes/{id}/Versions/Shared$ # End automatic generation --- 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 index 96e5201ee..b79bd4f89 100644 --- 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 @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: GET /api/v2/Attributes/{id}/Versions + - api_route_regex: GET /api/core/v1/Attributes/{id}/Versions - published: default - link: use-case-consumption-get-versions-of-an-attribute require: required_by: -api_route_regex: ^GET /api/v2/Attributes/{id}/Versions$ +api_route_regex: ^GET /api/core/v1/Attributes/{id}/Versions$ # End automatic generation --- 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 index 8e8557531..0a616e1e5 100644 --- 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 @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: POST /api/v2/Attributes/{attributeId}/NotifyPeer + - api_route_regex: POST /api/core/v1/Attributes/{attributeId}/NotifyPeer - published: default - link: use-case-consumption-notify-peer-about-repositoryattribute-succession require: required_by: -api_route_regex: ^POST /api/v2/Attributes/{attributeId}/NotifyPeer$ +api_route_regex: ^POST /api/core/v1/Attributes/{attributeId}/NotifyPeer$ # End automatic generation --- 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 93b18b035..0be09f86d 100644 --- a/_docs_use-cases/use-case-consumption-query-incoming-requests.md +++ b/_docs_use-cases/use-case-consumption-query-incoming-requests.md @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: GET /api/v2/Requests/incoming + - api_route_regex: GET /api/core/v1/Requests/incoming - published: default - link: use-case-consumption-query-incoming-requests require: required_by: -api_route_regex: ^GET /api/v2/Requests/incoming$ +api_route_regex: ^GET /api/core/v1/Requests/incoming$ # End automatic generation --- 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 30a21beb1..90d079394 100644 --- a/_docs_use-cases/use-case-consumption-query-outgoing-requests.md +++ b/_docs_use-cases/use-case-consumption-query-outgoing-requests.md @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: GET /api/v2/Requests/Outgoing + - api_route_regex: GET /api/core/v1/Requests/Outgoing - published: default - link: use-case-consumption-query-outgoing-requests require: required_by: -api_route_regex: ^GET /api/v2/Requests/Outgoing$ +api_route_regex: ^GET /api/core/v1/Requests/Outgoing$ # End automatic generation --- 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 7bf5d5ff5..a00487e73 100644 --- a/_docs_use-cases/use-case-consumption-reject-incoming-request.md +++ b/_docs_use-cases/use-case-consumption-reject-incoming-request.md @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: PUT /api/v2/Requests/Incoming/{id}/Reject + - api_route_regex: PUT /api/core/v1/Requests/Incoming/{id}/Reject - published: default - link: use-case-consumption-reject-incoming-request require: required_by: -api_route_regex: ^PUT /api/v2/Requests/Incoming/{id}/Reject$ +api_route_regex: ^PUT /api/core/v1/Requests/Incoming/{id}/Reject$ # End automatic generation --- 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 index 89a885861..3ecf239cf 100644 --- 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 @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: POST /api/v2/Attributes/{predecessorId}/Succeed + - api_route_regex: POST /api/core/v1/Attributes/{predecessorId}/Succeed - published: default - link: use-case-consumption-succeed-a-relationshipattribute-and-notify-peer require: required_by: -api_route_regex: ^POST /api/v2/Attributes/{predecessorId}/Succeed$ +api_route_regex: ^POST /api/core/v1/Attributes/{predecessorId}/Succeed$ # End automatic generation --- diff --git a/_docs_use-cases/use-case-consumption-succeed-a-repositoryattribute.md b/_docs_use-cases/use-case-consumption-succeed-a-repositoryattribute.md index 300e3aac9..d60bc17ea 100644 --- a/_docs_use-cases/use-case-consumption-succeed-a-repositoryattribute.md +++ b/_docs_use-cases/use-case-consumption-succeed-a-repositoryattribute.md @@ -29,12 +29,12 @@ properties: - size: M - created_at: - changed_at: - - api_route_regex: POST /api/v2/Attributes/{predecessorId}/Succeed + - api_route_regex: POST /api/core/v1/Attributes/{predecessorId}/Succeed - published: default - link: use-case-consumption-succeed-a-repositoryattribute require: required_by: -api_route_regex: ^POST /api/v2/Attributes/{predecessorId}/Succeed$ +api_route_regex: ^POST /api/core/v1/Attributes/{predecessorId}/Succeed$ # End automatic generation --- diff --git a/_docs_use-cases/use-case-consumption-upsert-identitymetadata.md b/_docs_use-cases/use-case-consumption-upsert-identitymetadata.md index b36667ee2..ce68c1144 100644 --- a/_docs_use-cases/use-case-consumption-upsert-identitymetadata.md +++ b/_docs_use-cases/use-case-consumption-upsert-identitymetadata.md @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: PUT /api/v2/IdentityMetadata + - api_route_regex: PUT /api/core/v1/IdentityMetadata - published: default - link: use-case-consumption-upsert-identitymetadata require: required_by: -api_route_regex: ^PUT /api/v2/IdentityMetadata$ +api_route_regex: ^PUT /api/core/v1/IdentityMetadata$ # End automatic generation --- diff --git a/_docs_use-cases/use-case-consumption-validate-an-iqlquery.md b/_docs_use-cases/use-case-consumption-validate-an-iqlquery.md index d55dda596..1e547f1f0 100644 --- a/_docs_use-cases/use-case-consumption-validate-an-iqlquery.md +++ b/_docs_use-cases/use-case-consumption-validate-an-iqlquery.md @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: POST /api/v2/Attributes/ValidateIQLQuery + - api_route_regex: POST /api/core/v1/Attributes/ValidateIQLQuery - published: default - link: use-case-consumption-validate-an-iqlquery require: required_by: -api_route_regex: ^POST /api/v2/Attributes/ValidateIQLQuery$ +api_route_regex: ^POST /api/core/v1/Attributes/ValidateIQLQuery$ # End automatic generation --- diff --git a/_docs_use-cases/use-case-device-create-qr-code-for-file.md b/_docs_use-cases/use-case-device-create-qr-code-for-file.md index 7f860fe1a..d76d9f6ff 100644 --- a/_docs_use-cases/use-case-device-create-qr-code-for-file.md +++ b/_docs_use-cases/use-case-device-create-qr-code-for-file.md @@ -31,12 +31,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: GET /api/v2/Files/{idOrReference} + - api_route_regex: GET /api/core/v1/Files/{idOrReference} - published: default - link: use-case-device-create-qr-code-for-file require: required_by: -api_route_regex: ^GET /api/v2/Files/{idOrReference}$ +api_route_regex: ^GET /api/core/v1/Files/{idOrReference}$ # End automatic generation --- diff --git a/_docs_use-cases/use-case-device-create-token-qr-code-for-file.md b/_docs_use-cases/use-case-device-create-token-qr-code-for-file.md index fbddadc7c..b6515c763 100644 --- a/_docs_use-cases/use-case-device-create-token-qr-code-for-file.md +++ b/_docs_use-cases/use-case-device-create-token-qr-code-for-file.md @@ -31,12 +31,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: POST /api/v2/Files/{id}/Token + - api_route_regex: POST /api/core/v1/Files/{id}/Token - published: default - link: use-case-device-create-token-qr-code-for-file require: required_by: -api_route_regex: ^POST /api/v2/Files/{id}/Token$ +api_route_regex: ^POST /api/core/v1/Files/{id}/Token$ # End automatic generation --- diff --git a/_docs_use-cases/use-case-device-create-token-qr-code-for-own-relationshiptemplate.md b/_docs_use-cases/use-case-device-create-token-qr-code-for-own-relationshiptemplate.md index 49280382a..5402726fc 100644 --- a/_docs_use-cases/use-case-device-create-token-qr-code-for-own-relationshiptemplate.md +++ b/_docs_use-cases/use-case-device-create-token-qr-code-for-own-relationshiptemplate.md @@ -31,12 +31,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: POST /api/v2/RelationshipTemplates/Own/{id}/Token + - api_route_regex: POST /api/core/v1/RelationshipTemplates/Own/{id}/Token - published: default - link: use-case-device-create-token-qr-code-for-own-relationshiptemplate require: required_by: -api_route_regex: ^POST /api/v2/RelationshipTemplates/Own/{id}/Token$ +api_route_regex: ^POST /api/core/v1/RelationshipTemplates/Own/{id}/Token$ # End automatic generation --- diff --git a/_docs_use-cases/use-case-transport-accept-relationship-reactivation.md b/_docs_use-cases/use-case-transport-accept-relationship-reactivation.md index 02ec10da8..f21bb907e 100644 --- a/_docs_use-cases/use-case-transport-accept-relationship-reactivation.md +++ b/_docs_use-cases/use-case-transport-accept-relationship-reactivation.md @@ -29,12 +29,12 @@ properties: - size: - created_at: - changed_at: - - api_route_regex: PUT /api/v2/Relationships/{id}/Reactivate/Accept + - api_route_regex: PUT /api/core/v1/Relationships/{id}/Reactivate/Accept - published: default - link: use-case-transport-accept-relationship-reactivation require: required_by: -api_route_regex: ^PUT /api/v2/Relationships/{id}/Reactivate/Accept$ +api_route_regex: ^PUT /api/core/v1/Relationships/{id}/Reactivate/Accept$ # End automatic generation --- diff --git a/_docs_use-cases/use-case-transport-accept-relationship.md b/_docs_use-cases/use-case-transport-accept-relationship.md index dc6ad9472..4ba08ed0d 100644 --- a/_docs_use-cases/use-case-transport-accept-relationship.md +++ b/_docs_use-cases/use-case-transport-accept-relationship.md @@ -31,12 +31,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: PUT /api/v2/Relationships/{id}/Accept + - api_route_regex: PUT /api/core/v1/Relationships/{id}/Accept - published: default - link: use-case-transport-accept-relationship require: required_by: -api_route_regex: ^PUT /api/v2/Relationships/{id}/Accept$ +api_route_regex: ^PUT /api/core/v1/Relationships/{id}/Accept$ # End automatic generation --- diff --git a/_docs_use-cases/use-case-transport-check-if-relationship-can-be-created.md b/_docs_use-cases/use-case-transport-check-if-relationship-can-be-created.md index 663e93626..14c1a3c1b 100644 --- a/_docs_use-cases/use-case-transport-check-if-relationship-can-be-created.md +++ b/_docs_use-cases/use-case-transport-check-if-relationship-can-be-created.md @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: PUT /api/v2/Relationships/CanCreate + - api_route_regex: PUT /api/core/v1/Relationships/CanCreate - published: default - link: use-case-transport-check-if-relationship-can-be-created require: required_by: -api_route_regex: ^PUT /api/v2/Relationships/CanCreate$ +api_route_regex: ^PUT /api/core/v1/Relationships/CanCreate$ # End automatic generation --- diff --git a/_docs_use-cases/use-case-transport-create-challenge.md b/_docs_use-cases/use-case-transport-create-challenge.md index bf6aabe8f..4a793c6d2 100644 --- a/_docs_use-cases/use-case-transport-create-challenge.md +++ b/_docs_use-cases/use-case-transport-create-challenge.md @@ -29,11 +29,11 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: POST /api/v2/Challenges + - api_route_regex: POST /api/core/v1/Challenges - published: - link: use-case-transport-create-challenge require: required_by: -api_route_regex: ^POST /api/v2/Challenges$ +api_route_regex: ^POST /api/core/v1/Challenges$ # End automatic generation --- 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 1f8a96b39..d834c9078 100644 --- a/_docs_use-cases/use-case-transport-create-own-relationshiptemplate.md +++ b/_docs_use-cases/use-case-transport-create-own-relationshiptemplate.md @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: POST /api/v2/RelationshipTemplates/Own + - api_route_regex: POST /api/core/v1/RelationshipTemplates/Own - published: default - link: use-case-transport-create-own-relationshiptemplate require: required_by: -api_route_regex: ^POST /api/v2/RelationshipTemplates/Own$ +api_route_regex: ^POST /api/core/v1/RelationshipTemplates/Own$ # End automatic generation --- 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 06a3074b0..74a1ccd70 100644 --- a/_docs_use-cases/use-case-transport-create-own-token.md +++ b/_docs_use-cases/use-case-transport-create-own-token.md @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: POST /api/v2/Tokens/Own + - api_route_regex: POST /api/core/v1/Tokens/Own - published: default - link: use-case-transport-create-own-token require: required_by: -api_route_regex: ^POST /api/v2/Tokens/Own$ +api_route_regex: ^POST /api/core/v1/Tokens/Own$ # End automatic generation --- 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 ebd39cdb7..c61fabe4f 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 @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: POST /api/v2/Relationships + - api_route_regex: POST /api/core/v1/Relationships - published: default - link: use-case-transport-create-relationship-with-relationshiptemplate require: required_by: -api_route_regex: ^POST /api/v2/Relationships$ +api_route_regex: ^POST /api/core/v1/Relationships$ # End automatic generation --- 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 589cfcd08..1b096d1ac 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 @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: POST /api/v2/Files/{id}/Token + - api_route_regex: POST /api/core/v1/Files/{id}/Token - published: default - link: use-case-transport-create-token-for-file require: required_by: -api_route_regex: ^POST /api/v2/Files/{id}/Token$ +api_route_regex: ^POST /api/core/v1/Files/{id}/Token$ # End automatic generation --- diff --git a/_docs_use-cases/use-case-transport-create-token-for-own-relationshiptemplate.md b/_docs_use-cases/use-case-transport-create-token-for-own-relationshiptemplate.md index 23f1e4d4d..719f1579e 100644 --- a/_docs_use-cases/use-case-transport-create-token-for-own-relationshiptemplate.md +++ b/_docs_use-cases/use-case-transport-create-token-for-own-relationshiptemplate.md @@ -31,12 +31,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: POST /api/v2/RelationshipTemplates/Own/{id}/Token + - api_route_regex: POST /api/core/v1/RelationshipTemplates/Own/{id}/Token - published: default - link: use-case-transport-create-token-for-own-relationshiptemplate require: required_by: -api_route_regex: ^POST /api/v2/RelationshipTemplates/Own/{id}/Token$ +api_route_regex: ^POST /api/core/v1/RelationshipTemplates/Own/{id}/Token$ # End automatic generation --- diff --git a/_docs_use-cases/use-case-transport-decompose-relationship.md b/_docs_use-cases/use-case-transport-decompose-relationship.md index 180d920b3..7386712ce 100644 --- a/_docs_use-cases/use-case-transport-decompose-relationship.md +++ b/_docs_use-cases/use-case-transport-decompose-relationship.md @@ -29,12 +29,12 @@ properties: - size: - created_at: - changed_at: - - api_route_regex: DELETE /api/v2/Relationships/{id} + - api_route_regex: DELETE /api/core/v1/Relationships/{id} - published: default - link: use-case-transport-decompose-relationship require: required_by: -api_route_regex: ^DELETE /api/v2/Relationships/{id}$ +api_route_regex: ^DELETE /api/core/v1/Relationships/{id}$ # End automatic generation --- diff --git a/_docs_use-cases/use-case-transport-delete-file.md b/_docs_use-cases/use-case-transport-delete-file.md index a93bf3f1f..681e30aa7 100644 --- a/_docs_use-cases/use-case-transport-delete-file.md +++ b/_docs_use-cases/use-case-transport-delete-file.md @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: DELETE /api/v2/Files/{id} + - api_route_regex: DELETE /api/core/v1/Files/{id} - published: default - link: use-case-transport-delete-file require: required_by: -api_route_regex: ^DELETE /api/v2/Files/{id}$ +api_route_regex: ^DELETE /api/core/v1/Files/{id}$ # End automatic generation --- diff --git a/_docs_use-cases/use-case-transport-download-file.md b/_docs_use-cases/use-case-transport-download-file.md index dc820a5d5..6cf07bcf8 100644 --- a/_docs_use-cases/use-case-transport-download-file.md +++ b/_docs_use-cases/use-case-transport-download-file.md @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: GET /api/v2/Files/{id}/Download + - api_route_regex: GET /api/core/v1/Files/{id}/Download - published: default - link: use-case-transport-download-file require: required_by: -api_route_regex: ^GET /api/v2/Files/{id}/Download$ +api_route_regex: ^GET /api/core/v1/Files/{id}/Download$ # End automatic generation --- 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 a4851eee8..4d02e099d 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 @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: GET /api/v2/Relationships/{id}/Attributes + - api_route_regex: GET /api/core/v1/Relationships/{id}/Attributes - published: default - link: use-case-transport-get-attributes-for-relationship require: required_by: -api_route_regex: ^GET /api/v2/Relationships/{id}/Attributes$ +api_route_regex: ^GET /api/core/v1/Relationships/{id}/Attributes$ # End automatic generation --- 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 916ba0bd4..ecd73653b 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 @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: GET /api/v2/Account/IdentityInfo + - api_route_regex: GET /api/core/v1/Account/IdentityInfo - published: default - link: use-case-transport-get-currently-used-identity require: required_by: -api_route_regex: ^GET /api/v2/Account/IdentityInfo$ +api_route_regex: ^GET /api/core/v1/Account/IdentityInfo$ # End automatic generation --- diff --git a/_docs_use-cases/use-case-transport-get-file-metadata.md b/_docs_use-cases/use-case-transport-get-file-metadata.md index 86152ea7b..fd975f86f 100644 --- a/_docs_use-cases/use-case-transport-get-file-metadata.md +++ b/_docs_use-cases/use-case-transport-get-file-metadata.md @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: GET /api/v2/Files/{idOrReference} + - api_route_regex: GET /api/core/v1/Files/{idOrReference} - published: default - link: use-case-transport-get-file-metadata require: required_by: -api_route_regex: ^GET /api/v2/Files/{idOrReference}$ +api_route_regex: ^GET /api/core/v1/Files/{idOrReference}$ # End automatic generation --- 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 f18634938..4ce5525db 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 @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: GET /api/v2/Messages/{id} + - api_route_regex: GET /api/core/v1/Messages/{id} - published: default - link: use-case-transport-get-message-by-messageid require: required_by: -api_route_regex: ^GET /api/v2/Messages/{id}$ +api_route_regex: ^GET /api/core/v1/Messages/{id}$ # End automatic generation --- 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 22b8be62b..3ddb14330 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 @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: GET /api/v2/Relationships + - api_route_regex: GET /api/core/v1/Relationships - published: default - link: use-case-transport-get-relationship-by-address require: required_by: -api_route_regex: ^GET /api/v2/Relationships$ +api_route_regex: ^GET /api/core/v1/Relationships$ # End automatic generation --- 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 8e5737308..332771e5f 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 @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: GET /api/v2/Relationships/{id} + - api_route_regex: GET /api/core/v1/Relationships/{id} - published: default - link: use-case-transport-get-relationship-by-relationshipid require: required_by: -api_route_regex: ^GET /api/v2/Relationships/{id}$ +api_route_regex: ^GET /api/core/v1/Relationships/{id}$ # End automatic generation --- diff --git a/_docs_use-cases/use-case-transport-get-relationshiptemplate.md b/_docs_use-cases/use-case-transport-get-relationshiptemplate.md index 77ef2169c..41b0400c3 100644 --- a/_docs_use-cases/use-case-transport-get-relationshiptemplate.md +++ b/_docs_use-cases/use-case-transport-get-relationshiptemplate.md @@ -31,12 +31,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: GET /api/v2/RelationshipTemplates/{id} + - api_route_regex: GET /api/core/v1/RelationshipTemplates/{id} - published: default - link: use-case-transport-get-relationshiptemplate require: required_by: -api_route_regex: ^GET /api/v2/RelationshipTemplates/{id}$ +api_route_regex: ^GET /api/core/v1/RelationshipTemplates/{id}$ # End automatic generation --- 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 86f8bc2d3..44d59162d 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 @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: GET /api/v2/Account/SyncInfo + - api_route_regex: GET /api/core/v1/Account/SyncInfo - published: default - link: use-case-transport-get-synchronization-status-with-backbone require: required_by: -api_route_regex: ^GET /api/v2/Account/SyncInfo$ +api_route_regex: ^GET /api/core/v1/Account/SyncInfo$ # End automatic generation --- 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 e8567b42e..ab6327736 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 @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: GET /api/v2/Tokens/{id} + - api_route_regex: GET /api/core/v1/Tokens/{id} - published: default - link: use-case-transport-get-token-by-tokenid require: required_by: -api_route_regex: ^GET /api/v2/Tokens/{id}$ +api_route_regex: ^GET /api/core/v1/Tokens/{id}$ # End automatic generation --- diff --git a/_docs_use-cases/use-case-transport-load-file.md b/_docs_use-cases/use-case-transport-load-file.md index a167fff3e..666a58bc6 100644 --- a/_docs_use-cases/use-case-transport-load-file.md +++ b/_docs_use-cases/use-case-transport-load-file.md @@ -31,12 +31,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: POST /api/v2/Files/Peer + - api_route_regex: POST /api/core/v1/Files/Peer - published: default - link: use-case-transport-load-file require: required_by: -api_route_regex: ^POST /api/v2/Files/Peer$ +api_route_regex: ^POST /api/core/v1/Files/Peer$ # End automatic generation --- diff --git a/_docs_use-cases/use-case-transport-load-relationshiptemplate-created-by-others.md b/_docs_use-cases/use-case-transport-load-relationshiptemplate-created-by-others.md index b5625b485..6f3847bbe 100644 --- a/_docs_use-cases/use-case-transport-load-relationshiptemplate-created-by-others.md +++ b/_docs_use-cases/use-case-transport-load-relationshiptemplate-created-by-others.md @@ -31,12 +31,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: POST /api/v2/RelationshipTemplates/Peer + - api_route_regex: POST /api/core/v1/RelationshipTemplates/Peer - published: default - link: use-case-transport-load-relationshiptemplate-created-by-others require: required_by: -api_route_regex: ^POST /api/v2/RelationshipTemplates/Peer$ +api_route_regex: ^POST /api/core/v1/RelationshipTemplates/Peer$ # End automatic generation --- 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 49ecbebb0..5c2ba3ac1 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 @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: POST /api/v2/Tokens/Peer + - api_route_regex: POST /api/core/v1/Tokens/Peer - published: default - link: use-case-transport-load-token-created-by-others require: required_by: -api_route_regex: ^POST /api/v2/Tokens/Peer$ +api_route_regex: ^POST /api/core/v1/Tokens/Peer$ # End automatic generation --- diff --git a/_docs_use-cases/use-case-transport-query-messages.md b/_docs_use-cases/use-case-transport-query-messages.md index 627296c64..84ad504d6 100644 --- a/_docs_use-cases/use-case-transport-query-messages.md +++ b/_docs_use-cases/use-case-transport-query-messages.md @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: GET /api/v2/Messages + - api_route_regex: GET /api/core/v1/Messages - published: default - link: use-case-transport-query-messages require: required_by: -api_route_regex: ^GET /api/v2/Messages$ +api_route_regex: ^GET /api/core/v1/Messages$ # End automatic generation --- diff --git a/_docs_use-cases/use-case-transport-query-metadata-of-files.md b/_docs_use-cases/use-case-transport-query-metadata-of-files.md index 4ab8dd100..a4616ac71 100644 --- a/_docs_use-cases/use-case-transport-query-metadata-of-files.md +++ b/_docs_use-cases/use-case-transport-query-metadata-of-files.md @@ -31,12 +31,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: GET /api/v2/Files + - api_route_regex: GET /api/core/v1/Files - published: default - link: use-case-transport-query-metadata-of-files require: required_by: -api_route_regex: ^GET /api/v2/Files$ +api_route_regex: ^GET /api/core/v1/Files$ # End automatic generation --- diff --git a/_docs_use-cases/use-case-transport-query-metadata-of-own-files.md b/_docs_use-cases/use-case-transport-query-metadata-of-own-files.md index ab72f754f..39d5499b8 100644 --- a/_docs_use-cases/use-case-transport-query-metadata-of-own-files.md +++ b/_docs_use-cases/use-case-transport-query-metadata-of-own-files.md @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: GET /api/v2/Files/Own + - api_route_regex: GET /api/core/v1/Files/Own - published: default - link: use-case-transport-query-metadata-of-own-files require: required_by: -api_route_regex: ^GET /api/v2/Files/Own$ +api_route_regex: ^GET /api/core/v1/Files/Own$ # End automatic generation --- diff --git a/_docs_use-cases/use-case-transport-query-metadata-of-peer-files.md b/_docs_use-cases/use-case-transport-query-metadata-of-peer-files.md index 802224534..37224fd20 100644 --- a/_docs_use-cases/use-case-transport-query-metadata-of-peer-files.md +++ b/_docs_use-cases/use-case-transport-query-metadata-of-peer-files.md @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: GET /api/v2/Files/Peer + - api_route_regex: GET /api/core/v1/Files/Peer - published: default - link: use-case-transport-query-metadata-of-peer-files require: required_by: -api_route_regex: ^GET /api/v2/Files/Peer$ +api_route_regex: ^GET /api/core/v1/Files/Peer$ # End automatic generation --- diff --git a/_docs_use-cases/use-case-transport-query-relationships.md b/_docs_use-cases/use-case-transport-query-relationships.md index 43c234301..e60b59f48 100644 --- a/_docs_use-cases/use-case-transport-query-relationships.md +++ b/_docs_use-cases/use-case-transport-query-relationships.md @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: GET /api/v2/Relationships + - api_route_regex: GET /api/core/v1/Relationships - published: default - link: use-case-transport-query-relationships require: required_by: -api_route_regex: ^GET /api/v2/Relationships$ +api_route_regex: ^GET /api/core/v1/Relationships$ # End automatic generation --- diff --git a/_docs_use-cases/use-case-transport-query-relationshiptemplates.md b/_docs_use-cases/use-case-transport-query-relationshiptemplates.md index 0832ff445..c7ed08e6b 100644 --- a/_docs_use-cases/use-case-transport-query-relationshiptemplates.md +++ b/_docs_use-cases/use-case-transport-query-relationshiptemplates.md @@ -31,12 +31,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: GET /api/v2/RelationshipTemplates + - api_route_regex: GET /api/core/v1/RelationshipTemplates - published: default - link: use-case-transport-query-relationshiptemplates require: required_by: -api_route_regex: ^GET /api/v2/RelationshipTemplates$ +api_route_regex: ^GET /api/core/v1/RelationshipTemplates$ # End automatic generation --- diff --git a/_docs_use-cases/use-case-transport-regenerate-file-ownership-token.md b/_docs_use-cases/use-case-transport-regenerate-file-ownership-token.md index 23618e715..9c8c4cd6e 100644 --- a/_docs_use-cases/use-case-transport-regenerate-file-ownership-token.md +++ b/_docs_use-cases/use-case-transport-regenerate-file-ownership-token.md @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: PATCH /api/v2/Files/{id}/RegenerateOwnershipToken + - api_route_regex: PATCH /api/core/v1/Files/{id}/RegenerateOwnershipToken - published: default - link: use-case-transport-regenerate-file-ownership-token require: required_by: -api_route_regex: ^PATCH /api/v2/Files/{id}/RegenerateOwnershipToken$ +api_route_regex: ^PATCH /api/core/v1/Files/{id}/RegenerateOwnershipToken$ # End automatic generation --- diff --git a/_docs_use-cases/use-case-transport-reject-relationship-reactivation.md b/_docs_use-cases/use-case-transport-reject-relationship-reactivation.md index b604bf9c8..e67802aed 100644 --- a/_docs_use-cases/use-case-transport-reject-relationship-reactivation.md +++ b/_docs_use-cases/use-case-transport-reject-relationship-reactivation.md @@ -29,12 +29,12 @@ properties: - size: - created_at: - changed_at: - - api_route_regex: PUT /api/v2/Relationships/{id}/Reactivate/Reject + - api_route_regex: PUT /api/core/v1/Relationships/{id}/Reactivate/Reject - published: default - link: use-case-transport-reject-relationship-reactivation require: required_by: -api_route_regex: ^PUT /api/v2/Relationships/{id}/Reactivate/Reject$ +api_route_regex: ^PUT /api/core/v1/Relationships/{id}/Reactivate/Reject$ # End automatic generation --- diff --git a/_docs_use-cases/use-case-transport-reject-relationship.md b/_docs_use-cases/use-case-transport-reject-relationship.md index 171373bdb..d9ff2c5b9 100644 --- a/_docs_use-cases/use-case-transport-reject-relationship.md +++ b/_docs_use-cases/use-case-transport-reject-relationship.md @@ -31,12 +31,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: PUT /api/v2/Relationships/{id}/Reject + - api_route_regex: PUT /api/core/v1/Relationships/{id}/Reject - published: default - link: use-case-transport-reject-relationship require: required_by: -api_route_regex: ^PUT /api/v2/Relationships/{id}/Reject$ +api_route_regex: ^PUT /api/core/v1/Relationships/{id}/Reject$ # End automatic generation --- diff --git a/_docs_use-cases/use-case-transport-request-relationship-reactivation.md b/_docs_use-cases/use-case-transport-request-relationship-reactivation.md index f7497ef41..b6a5449e4 100644 --- a/_docs_use-cases/use-case-transport-request-relationship-reactivation.md +++ b/_docs_use-cases/use-case-transport-request-relationship-reactivation.md @@ -29,12 +29,12 @@ properties: - size: - created_at: - changed_at: - - api_route_regex: PUT /api/v2/Relationships/{id}/Reactivate + - api_route_regex: PUT /api/core/v1/Relationships/{id}/Reactivate - published: default - link: use-case-transport-request-relationship-reactivation require: required_by: -api_route_regex: ^PUT /api/v2/Relationships/{id}/Reactivate$ +api_route_regex: ^PUT /api/core/v1/Relationships/{id}/Reactivate$ # End automatic generation --- diff --git a/_docs_use-cases/use-case-transport-revoke-relationship-reactivation.md b/_docs_use-cases/use-case-transport-revoke-relationship-reactivation.md index 4fd3bbbef..9af02804c 100644 --- a/_docs_use-cases/use-case-transport-revoke-relationship-reactivation.md +++ b/_docs_use-cases/use-case-transport-revoke-relationship-reactivation.md @@ -29,12 +29,12 @@ properties: - size: - created_at: - changed_at: - - api_route_regex: PUT /api/v2/Relationships/{id}/Reactivate/Revoke + - api_route_regex: PUT /api/core/v1/Relationships/{id}/Reactivate/Revoke - published: default - link: use-case-transport-revoke-relationship-reactivation require: required_by: -api_route_regex: ^PUT /api/v2/Relationships/{id}/Reactivate/Revoke$ +api_route_regex: ^PUT /api/core/v1/Relationships/{id}/Reactivate/Revoke$ # End automatic generation --- diff --git a/_docs_use-cases/use-case-transport-revoke-relationship.md b/_docs_use-cases/use-case-transport-revoke-relationship.md index d4b40e444..7ac17a633 100644 --- a/_docs_use-cases/use-case-transport-revoke-relationship.md +++ b/_docs_use-cases/use-case-transport-revoke-relationship.md @@ -29,12 +29,12 @@ properties: - size: - created_at: - changed_at: - - api_route_regex: PUT /api/v2/Relationships/{id}/Revoke + - api_route_regex: PUT /api/core/v1/Relationships/{id}/Revoke - published: default - link: use-case-transport-revoke-relationship require: required_by: -api_route_regex: ^PUT /api/v2/Relationships/{id}/Revoke$ +api_route_regex: ^PUT /api/core/v1/Relationships/{id}/Revoke$ # End automatic generation --- 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 cd72e50c7..d46cfe498 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 @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: POST /api/v2/Messages + - api_route_regex: POST /api/core/v1/Messages - published: default - link: use-case-transport-send-message-to-recipients require: required_by: -api_route_regex: ^POST /api/v2/Messages$ +api_route_regex: ^POST /api/core/v1/Messages$ # End automatic generation --- 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 79dafbe4f..79b75c667 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 @@ -29,11 +29,11 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: POST /api/v2/Account/Sync + - api_route_regex: POST /api/core/v1/Account/Sync - published: default - link: use-case-transport-synchronize-datawallet-updates-to-backbone require: required_by: -api_route_regex: ^POST /api/v2/Account/Sync$ +api_route_regex: ^POST /api/core/v1/Account/Sync$ # End automatic generation --- 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 c71027ac3..bec5e0e5a 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 @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: POST /api/v2/Account/Sync + - api_route_regex: POST /api/core/v1/Account/Sync - published: default - link: use-case-transport-synchronize-updates-of-backbone require: required_by: -api_route_regex: ^POST /api/v2/Account/Sync$ +api_route_regex: ^POST /api/core/v1/Account/Sync$ # End automatic generation --- diff --git a/_docs_use-cases/use-case-transport-terminate-relationship.md b/_docs_use-cases/use-case-transport-terminate-relationship.md index 6a8c0220a..c2c8005c8 100644 --- a/_docs_use-cases/use-case-transport-terminate-relationship.md +++ b/_docs_use-cases/use-case-transport-terminate-relationship.md @@ -29,12 +29,12 @@ properties: - size: - created_at: - changed_at: - - api_route_regex: PUT /api/v2/Relationships/{id}/Terminate + - api_route_regex: PUT /api/core/v1/Relationships/{id}/Terminate - published: default - link: use-case-transport-terminate-relationship require: required_by: -api_route_regex: ^PUT /api/v2/Relationships/{id}/Terminate$ +api_route_regex: ^PUT /api/core/v1/Relationships/{id}/Terminate$ # End automatic generation --- 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 66082d612..aa6f99b52 100644 --- a/_docs_use-cases/use-case-transport-upload-own-file.md +++ b/_docs_use-cases/use-case-transport-upload-own-file.md @@ -29,12 +29,12 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: POST /api/v2/Files/Own + - api_route_regex: POST /api/core/v1/Files/Own - published: default - link: use-case-transport-upload-own-file require: required_by: -api_route_regex: ^POST /api/v2/Files/Own$ +api_route_regex: ^POST /api/core/v1/Files/Own$ # End automatic generation --- diff --git a/_docs_use-cases/use-case-transport-validate-challenge.md b/_docs_use-cases/use-case-transport-validate-challenge.md index dca1b7096..b40b89cbb 100644 --- a/_docs_use-cases/use-case-transport-validate-challenge.md +++ b/_docs_use-cases/use-case-transport-validate-challenge.md @@ -29,11 +29,11 @@ properties: - size: n/a - created_at: - changed_at: - - api_route_regex: POST /api/v2/Challenges/Validate + - api_route_regex: POST /api/core/v1/Challenges/Validate - published: - link: use-case-transport-validate-challenge require: required_by: -api_route_regex: ^POST /api/v2/Challenges/Validate$ +api_route_regex: ^POST /api/core/v1/Challenges/Validate$ # End automatic generation --- From d23fef447dcca073566fc34d0b0a77a4c5d2be6d Mon Sep 17 00:00:00 2001 From: Britta Stallknecht Date: Tue, 19 Aug 2025 12:31:51 +0000 Subject: [PATCH 2/3] fix: prefix of Connector routes changed in migration guides --- _docs_integrate/migration-from-v4-to-v5.md | 40 +++++++++++----------- _docs_integrate/migration-from-v5-to-v6.md | 2 +- _docs_integrate/migration-from-v6-to-v7.md | 2 +- 3 files changed, 22 insertions(+), 22 deletions(-) diff --git a/_docs_integrate/migration-from-v4-to-v5.md b/_docs_integrate/migration-from-v4-to-v5.md index 86fc0d17c..5df8be42b 100644 --- a/_docs_integrate/migration-from-v4-to-v5.md +++ b/_docs_integrate/migration-from-v4-to-v5.md @@ -47,14 +47,14 @@ More [detailed explanations]({% link _docs_integrate/migration-from-v4-to-v5.md - The [RelationshipChanges have been removed]({% link _docs_integrate/migration-from-v4-to-v5.md %}#removal-of-relationshipchanges). - This has led to the removal of the `changes` property of the [Relationship]({% link _docs_integrate/data-model-overview.md %}#relationship) and the addition of the `creationContent` and `auditLog` properties to the Relationship. - In particular, the use cases for accepting and rejecting RelationshipChanges had to be removed. With the use cases [Accept Relationship]({% link _docs_use-cases/use-case-transport-accept-relationship.md %}) and [Reject Relationship]({% link _docs_use-cases/use-case-transport-reject-relationship.md %}), two [new use cases]({% link _docs_integrate/migration-from-v4-to-v5.md %}#removal-of-relationshipchanges-1) have been added that now provide these functionalities. - - For this reason, the route `PUT /api/core/v1/Relationships/{id}/Accept` must be executed instead of the route `PUT /api/core/v1/Relationships/{id}/Changes/{changeId}/Accept` and the route `PUT /api/core/v1/Relationships/{id}/Reject` must be executed instead of the route `PUT /api/core/v1/Relationships/{id}/Changes/{changeId}/Reject` when using the Connector. In contrast to the old Connector routes, a request body no longer needs to be provided when using the new Connector routes. + - For this reason, the route `PUT /api/v2/Relationships/{id}/Accept` must be executed instead of the route `PUT /api/v2/Relationships/{id}/Changes/{changeId}/Accept` and the route `PUT /api/v2/Relationships/{id}/Reject` must be executed instead of the route `PUT /api/v2/Relationships/{id}/Changes/{changeId}/Reject` when using the Connector. In contrast to the old Connector routes, a request body no longer needs to be provided when using the new Connector routes. - Non-standard `content` of a [Message]({% link _docs_integrate/data-model-overview.md %}#message), non-standard `content` of a [RelationshipTemplate]({% link _docs_integrate/data-model-overview.md %}#relationshiptemplate) and non-standard `creationContent` of a [Relationship]({% link _docs_integrate/data-model-overview.md %}#relationship) is now typed. The [new mandatory wrappers]({% link _docs_integrate/migration-from-v4-to-v5.md %}#new-mandatory-wrappers-for-non-standard-content-of-messages-relationshiptemplates-and-relationships) are [ArbitraryMessageContent]({% link _docs_integrate/data-model-overview.md %}#arbitrarymessagecontent), [ArbitraryRelationshipTemplateContent]({% link _docs_integrate/data-model-overview.md %}#arbitraryrelationshiptemplatecontent) and [ArbitraryRelationshipCreationContent]({% link _docs_integrate/data-model-overview.md %}#arbitraryrelationshipcreationcontent), respectively, which must now be used. - The `mustBeAccepted` property of the [RequestItemGroup]({% link _docs_integrate/data-model-overview.md %}#requestitemgroup) has been removed, which is why this [property must be removed if RequestItemGroups were used]({% link _docs_integrate/migration-from-v4-to-v5.md %}#removal-of-the-mustbeaccepted-property-of-the-requestitemgroup). - The type of the `owner` property of the [ThirdPartyRelationshipAttributeQuery]({% link _docs_integrate/data-model-overview.md %}#thirdpartyrelationshipattributequery) has changed. The [values specified for this property must therefore be adjusted if ThirdPartyRelationshipAttributeQueries were used]({% link _docs_integrate/migration-from-v4-to-v5.md %}#changed-type-of-the-owner-property-of-the-thirdpartyrelationshipattributequery). ### Changed Behavior of Known Features -- The [Synchronize updates of Backbone]({% link _docs_use-cases/use-case-transport-synchronize-updates-of-backbone.md %}) use case, which corresponds to the Connector route `POST /api/core/v1/Account/Sync`, no longer returns any content. Previously, new Messages or changes to Relationships were shown in the response after the use case was executed. As the [synchronization with the Backbone no longer returns anything]({% link _docs_integrate/migration-from-v4-to-v5.md %}#synchronization-with-backbone-returns-no-content-anymore), the corresponding [events]({% link _docs_integrate/connector-events.md %}) must be listened to instead in order to be informed about new Messages or changes to Relationships. +- The [Synchronize updates of Backbone]({% link _docs_use-cases/use-case-transport-synchronize-updates-of-backbone.md %}) use case, which corresponds to the Connector route `POST /api/v2/Account/Sync`, no longer returns any content. Previously, new Messages or changes to Relationships were shown in the response after the use case was executed. As the [synchronization with the Backbone no longer returns anything]({% link _docs_integrate/migration-from-v4-to-v5.md %}#synchronization-with-backbone-returns-no-content-anymore), the corresponding [events]({% link _docs_integrate/connector-events.md %}) must be listened to instead in order to be informed about new Messages or changes to Relationships. - Stricter [validation of Requests]({% link _docs_integrate/migration-from-v4-to-v5.md %}#validation-of-requests) has been added. Therefore, changes will probably have to be made to existing Request flows. Both [sending Requests]({% link _docs_integrate/migration-from-v4-to-v5.md %}#sending-of-requests) and [responding to Requests]({% link _docs_integrate/migration-from-v4-to-v5.md %}#responding-to-requests) are affected. ### Changes to Error Codes, Connector Routes and Events @@ -63,8 +63,8 @@ Changes have been made to the [error codes]({% link _docs_integrate/error-codes. - An overview of the [removed and changed error codes]({% link _docs_integrate/migration-from-v4-to-v5.md %}#removed-and-changed-error-codes) can be found below. - An overview of the [removed, changed and added use cases]({% link _docs_integrate/migration-from-v4-to-v5.md %}#removed-changed-and-added-use-cases) with regard to their impact on the Connector routes can be found below. - - In particular, it must be noted that the [use case of getting shared versions of a RepositoryAttribute has been renamed]({% link _docs_integrate/migration-from-v4-to-v5.md %}#renaming-of-the-use-case-getsharedversionsofrepositoryattribute-to-getsharedversionsofattribute). The [Get shared versions of an Attribute]({% link _docs_use-cases/use-case-consumption-get-shared-versions-of-an-attribute.md %}) use case must now be executed instead. Please note, however, that the associated Connector route `GET /api/core/v1/Attributes/{id}/Versions/Shared` has not changed. - - With the execution of the Connector route `POST /api/core/v1/Attributes`, which corresponds to the execution of the associated [Create a RepositoryAttribute]({% link _docs_use-cases/use-case-consumption-create-a-repositoryattribute.md %}) use case, an [IdentityAttribute]({% link _docs_integrate/data-model-overview.md %}#identityattribute) can be created for yourself. When executing this Connector route, the fields `content.@type` and `content.owner` may no longer be specified as input. This is due to the fact that previously only the IdentityAttribute as `@type` and the own address as the value of the `owner` property of the [Attribute]({% link _docs_integrate/data-model-overview.md %}#attributes) to be created for yourself came into question anyway. Therefore, [less input needs to be provided when executing the use case to create a RepositoryAttribute]({% link _docs_integrate/migration-from-v4-to-v5.md %}#less-input-needed-for-the-use-case-createrepositoryattribute). + - In particular, it must be noted that the [use case of getting shared versions of a RepositoryAttribute has been renamed]({% link _docs_integrate/migration-from-v4-to-v5.md %}#renaming-of-the-use-case-getsharedversionsofrepositoryattribute-to-getsharedversionsofattribute). The [Get shared versions of an Attribute]({% link _docs_use-cases/use-case-consumption-get-shared-versions-of-an-attribute.md %}) use case must now be executed instead. Please note, however, that the associated Connector route `GET /api/v2/Attributes/{id}/Versions/Shared` has not changed. + - With the execution of the Connector route `POST /api/v2/Attributes`, which corresponds to the execution of the associated [Create a RepositoryAttribute]({% link _docs_use-cases/use-case-consumption-create-a-repositoryattribute.md %}) use case, an [IdentityAttribute]({% link _docs_integrate/data-model-overview.md %}#identityattribute) can be created for yourself. When executing this Connector route, the fields `content.@type` and `content.owner` may no longer be specified as input. This is due to the fact that previously only the IdentityAttribute as `@type` and the own address as the value of the `owner` property of the [Attribute]({% link _docs_integrate/data-model-overview.md %}#attributes) to be created for yourself came into question anyway. Therefore, [less input needs to be provided when executing the use case to create a RepositoryAttribute]({% link _docs_integrate/migration-from-v4-to-v5.md %}#less-input-needed-for-the-use-case-createrepositoryattribute). - An overview of the [renamed and added events]({% link _docs_integrate/migration-from-v4-to-v5.md %}#renamed-and-added-events) can be found below. ## Detailed Explanations @@ -98,10 +98,10 @@ The functionalities of the old two use cases of accepting and rejecting Relation This means that no `content` must be sent with any of these operations anymore. The former, more generic Connector routes using RelationshipChanges could also have been used to accept or reject changes to a Relationship other than the establishment of an active Relationship, which might have required the transmission of additional data. -| Old Connector route | New Connector route | -| --------------------------------------------------------------------------------------- | ------------------------------------------------------------------ | -| `PUT /api/core/v1/Relationships/{relationshipId}/Changes/{changeId}/Accept` (with body) | `PUT /api/core/v1/Relationships/{relationshipId}/Accept` (no body) | -| `PUT /api/core/v1/Relationships/{relationshipId}/Changes/{changeId}/Reject` (with body) | `PUT /api/core/v1/Relationships/{relationshipId}/Reject` (no body) | +| Old Connector route | New Connector route | +| ---------------------------------------------------------------------------------- | ------------------------------------------------------------- | +| `PUT /api/v2/Relationships/{relationshipId}/Changes/{changeId}/Accept` (with body) | `PUT /api/v2/Relationships/{relationshipId}/Accept` (no body) | +| `PUT /api/v2/Relationships/{relationshipId}/Changes/{changeId}/Reject` (with body) | `PUT /api/v2/Relationships/{relationshipId}/Reject` (no body) | #### Modifications to Relationship @@ -131,7 +131,7 @@ These new wrappers are all of the following form, whereby the `<...>` notation i } ``` -Thus, when [sending a Message]({% link _docs_use-cases/use-case-transport-send-message-to-recipients.md %}) with non-standard `content` via `POST /api/core/v1/Messages`, instead of using the parameter `content : `, it must be used: +Thus, when [sending a Message]({% link _docs_use-cases/use-case-transport-send-message-to-recipients.md %}) with non-standard `content` via `POST /api/v2/Messages`, instead of using the parameter `content : `, it must be used: ```jsonc "content": { @@ -140,7 +140,7 @@ Thus, when [sending a Message]({% link _docs_use-cases/use-case-transport-send-m } ``` -Similarly, when [creating an own RelationshipTemplate]({% link _docs_use-cases/use-case-transport-create-own-relationshiptemplate.md %}) with non-standard `content` via the Connector route `POST /api/core/v1/RelationshipTemplates/Own`, it must be provided: +Similarly, when [creating an own RelationshipTemplate]({% link _docs_use-cases/use-case-transport-create-own-relationshiptemplate.md %}) with non-standard `content` via the Connector route `POST /api/v2/RelationshipTemplates/Own`, it must be provided: ```jsonc "content": { @@ -149,7 +149,7 @@ Similarly, when [creating an own RelationshipTemplate]({% link _docs_use-cases/u } ``` -Last but not least, when [creating a Relationship]({% link _docs_use-cases/use-case-transport-create-relationship-with-relationshiptemplate.md %}) with non-standard `creationContent` via the Connector route `POST /api/core/v1/Relationships`, it must be utilized: +Last but not least, when [creating a Relationship]({% link _docs_use-cases/use-case-transport-create-relationship-with-relationshiptemplate.md %}) with non-standard `creationContent` via the Connector route `POST /api/v2/Relationships`, it must be utilized: ```jsonc "creationContent": { @@ -190,7 +190,7 @@ This change enables the Sender of the Request to specify more precisely which Id ### Synchronization With Backbone Returns No Content Anymore -Previously, the [synchronization with the Backbone]({% link _docs_use-cases/use-case-transport-synchronize-updates-of-backbone.md %}) via the route `POST /api/core/v1/Account/Sync` returned a list of Relationships and Messages with the HTTP code 201. This has been changed to the sync returning nothing with the HTTP code 204. This removes the support for the workflow of regularly calling the sync and checking the response since unexpected response values happen if syncs are executed from different spots. We recommend working event-based with the [Message Broker Publisher Module]({% link _docs_operate/modules.md %}#messagebrokerpublisher), which sends events to a message broker you have set up. We send a variety of events like `consumption.incomingRequestReceived` or `consumption.incomingRequestStatusChanged`, each of them containing the relevant changed object. See [Connector Events]({% link _docs_integrate/connector-events.md %}) for the full list. Slightly related, we also recommend using the recently published [Server-Sent Events Module]({% link _docs_operate/modules.md %}#sse), which listens to events emitted from the Backbone and syncs with the Backbone when an event is received. +Previously, the [synchronization with the Backbone]({% link _docs_use-cases/use-case-transport-synchronize-updates-of-backbone.md %}) via the route `POST /api/v2/Account/Sync` returned a list of Relationships and Messages with the HTTP code 201. This has been changed to the sync returning nothing with the HTTP code 204. This removes the support for the workflow of regularly calling the sync and checking the response since unexpected response values happen if syncs are executed from different spots. We recommend working event-based with the [Message Broker Publisher Module]({% link _docs_operate/modules.md %}#messagebrokerpublisher), which sends events to a message broker you have set up. We send a variety of events like `consumption.incomingRequestReceived` or `consumption.incomingRequestStatusChanged`, each of them containing the relevant changed object. See [Connector Events]({% link _docs_integrate/connector-events.md %}) for the full list. Slightly related, we also recommend using the recently published [Server-Sent Events Module]({% link _docs_operate/modules.md %}#sse), which listens to events emitted from the Backbone and syncs with the Backbone when an event is received. ### Validation of Requests @@ -229,19 +229,19 @@ An overview of the [Use Cases]({% link _docs_integrate/use-cases.md %}) that may #### Revocation of Relationships The [Revoke Relationship]({% link _docs_use-cases/use-case-transport-revoke-relationship.md %}) use case has been added. -It is now possible to revoke a [Relationship]({% link _docs_integrate/data-model-overview.md %}#relationship) with `"Pending"` as `status` if it was created by yourself. To execute this use case, the Connector route `PUT /api/core/v1/Relationships/{id}/Revoke` can be used. +It is now possible to revoke a [Relationship]({% link _docs_integrate/data-model-overview.md %}#relationship) with `"Pending"` as `status` if it was created by yourself. To execute this use case, the Connector route `PUT /api/v2/Relationships/{id}/Revoke` can be used. #### Removal of RelationshipChanges The [removal of RelationshipChanges](#removal-of-relationshipchanges) is the reason why the following use cases are removed: -- The use case for accepting RelationshipChanges along with the associated Connector route `PUT /api/core/v1/Relationships/{id}/Changes/{changeId}/Accept`. -- The use case for rejecting RelationshipChanges along with the associated Connector route `PUT /api/core/v1/Relationships/{id}/Changes/{changeId}/Reject`. +- The use case for accepting RelationshipChanges along with the associated Connector route `PUT /api/v2/Relationships/{id}/Changes/{changeId}/Accept`. +- The use case for rejecting RelationshipChanges along with the associated Connector route `PUT /api/v2/Relationships/{id}/Changes/{changeId}/Reject`. Therefore, the following new use cases had to be added, which now provide these functionalities: -- The [Accept Relationship]({% link _docs_use-cases/use-case-transport-accept-relationship.md %}) use case along with the `PUT /api/core/v1/Relationships/{id}/Accept` Connector route. -- The [Reject Relationship]({% link _docs_use-cases/use-case-transport-reject-relationship.md %}) use case along with the `PUT /api/core/v1/Relationships/{id}/Reject` Connector route. +- The [Accept Relationship]({% link _docs_use-cases/use-case-transport-accept-relationship.md %}) use case along with the `PUT /api/v2/Relationships/{id}/Accept` Connector route. +- The [Reject Relationship]({% link _docs_use-cases/use-case-transport-reject-relationship.md %}) use case along with the `PUT /api/v2/Relationships/{id}/Reject` Connector route. #### Termination of Relationships @@ -261,18 +261,18 @@ Taking [ThirdPartyRelationshipAttributes]({% link _docs_integrate/data-model-ove For this reason, the [Get shared versions of an Attribute]({% link _docs_use-cases/use-case-consumption-get-shared-versions-of-an-attribute.md %}) use case was already added in version 4 and the use case of getting shared versions of a RepositoryAttribute was marked as deprecated. It has now been deleted with the update to version 5. -Please note, however, that the Connector route `GET /api/core/v1/Attributes/{id}/Versions/Shared` that belonged to the use case of getting shared versions of a RepositoryAttribute can still be used. If the Connector route `GET /api/core/v1/Attributes/{id}/Versions/Shared` is executed, the [Get shared versions of an Attribute]({% link _docs_use-cases/use-case-consumption-get-shared-versions-of-an-attribute.md %}) use case is now executed instead. +Please note, however, that the Connector route `GET /api/v2/Attributes/{id}/Versions/Shared` that belonged to the use case of getting shared versions of a RepositoryAttribute can still be used. If the Connector route `GET /api/v2/Attributes/{id}/Versions/Shared` is executed, the [Get shared versions of an Attribute]({% link _docs_use-cases/use-case-consumption-get-shared-versions-of-an-attribute.md %}) use case is now executed instead. As the functionality has only been extended, there is no breaking change with regard to the Connector route. #### Less Input Needed for the Use Case CreateRepositoryAttribute -In version 4, there was already a use case for creating Attributes for yourself that could be executed by Connector route `POST /api/core/v1/Attributes`. +In version 4, there was already a use case for creating Attributes for yourself that could be executed by Connector route `POST /api/v2/Attributes`. An Attribute created for yourself is automatically an [IdentityAttribute]({% link _docs_integrate/data-model-overview.md %}#identityattribute) which is owned by yourself. Technically, this corresponds exactly to the creation of a [RepositoryAttribute]({% link _docs_integrate/data-model-overview.md %}#localattribute). Therefore, the use case for creating Attributes for yourself is named the [Create a RepositoryAttribute]({% link _docs_use-cases/use-case-consumption-create-a-repositoryattribute.md %}) use case. When [creating Attributes for yourself]({% link _docs_integrate/create-attributes-for-yourself.md %}), it is therefore apparently not valuable to have to explicitly specify that an IdentityAttribute should be created instead of a RelationshipAttribute and that the IdentityAttribute should be owned by yourself instead of another Identity. -For this reason, when executing the Connector route `POST /api/core/v1/Attributes`, which corresponds to the execution of the associated [Create a RepositoryAttribute]({% link _docs_use-cases/use-case-consumption-create-a-repositoryattribute.md %}) use case, less input must now be provided, since the `@type` and the `owner` of the [Attribute]({% link _docs_integrate/data-model-overview.md %}#attributes) to be created may no longer be specified. +For this reason, when executing the Connector route `POST /api/v2/Attributes`, which corresponds to the execution of the associated [Create a RepositoryAttribute]({% link _docs_use-cases/use-case-consumption-create-a-repositoryattribute.md %}) use case, less input must now be provided, since the `@type` and the `owner` of the [Attribute]({% link _docs_integrate/data-model-overview.md %}#attributes) to be created may no longer be specified. ### Renamed and Added Events diff --git a/_docs_integrate/migration-from-v5-to-v6.md b/_docs_integrate/migration-from-v5-to-v6.md index 5081ff29d..4a064e780 100644 --- a/_docs_integrate/migration-from-v5-to-v6.md +++ b/_docs_integrate/migration-from-v5-to-v6.md @@ -30,7 +30,7 @@ To support the migration of existing systems to the new version, the breaking ch ## Removal of Routes for loading peer objects by id and key -The routes `POST /api/core/v1/Files/Peer`, `POST /api/core/v1/RelationshipTemplates/Peer`, `POST /api/core/v1/Tokens/Peer` all had the possibility to load peer objects with two different payloads: +The routes `POST /api/v2/Files/Peer`, `POST /api/v2/RelationshipTemplates/Peer`, `POST /api/v2/Tokens/Peer` all had the possibility to load peer objects with two different payloads: ```json { diff --git a/_docs_integrate/migration-from-v6-to-v7.md b/_docs_integrate/migration-from-v6-to-v7.md index 52870a24c..cd196610e 100644 --- a/_docs_integrate/migration-from-v6-to-v7.md +++ b/_docs_integrate/migration-from-v6-to-v7.md @@ -70,7 +70,7 @@ The step-by-step instructions can be consulted to start the migration to version ### Removed and Changed Connector Routes -- The `GET /api/core/v1/Attributes/Valid` Connector route and its underlying [use case]({% link _docs_integrate/use-cases.md %}) for getting valid [Attributes]({% link _docs_integrate/data-model-overview.md %}#attributes) were removed, because the properties `validFrom` and `validTo` have been removed from the Attributes. +- The `GET /api/v2/Attributes/Valid` Connector route and its underlying [use case]({% link _docs_integrate/use-cases.md %}) for getting valid [Attributes]({% link _docs_integrate/data-model-overview.md %}#attributes) were removed, because the properties `validFrom` and `validTo` have been removed from the Attributes. - For the same reason, the `onlyValid` parameter was removed from the use cases [Get Attributes]({% link _docs_use-cases/use-case-consumption-get-attributes.md %}), [Get own shared Attributes]({% link _docs_use-cases/use-case-consumption-get-own-shared-attributes.md %}) and [Get peer shared Attributes]({% link _docs_use-cases/use-case-consumption-get-peer-shared-attributes.md %}). Accordingly, it was removed from the associated Connector routes as well. From b51b6fdb4046b126f34645227a176398644f9f5f Mon Sep 17 00:00:00 2001 From: Britta Stallknecht Date: Tue, 19 Aug 2025 13:42:28 +0000 Subject: [PATCH 3/3] feat: add changed Connector route prefix to migration guide for v7 --- _docs_integrate/migration-from-v6-to-v7.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/_docs_integrate/migration-from-v6-to-v7.md b/_docs_integrate/migration-from-v6-to-v7.md index cd196610e..ccf62e9d3 100644 --- a/_docs_integrate/migration-from-v6-to-v7.md +++ b/_docs_integrate/migration-from-v6-to-v7.md @@ -70,6 +70,8 @@ The step-by-step instructions can be consulted to start the migration to version ### Removed and Changed Connector Routes +- For every Connector route originating from the [Core HTTP API Module]({% link _docs_operate/modules.md %}#corehttpapi), the prefix has been changed from `/api/v2` to `/api/core/v1` to reflect its origin. + The prefix syntax change led to the version being reset. - The `GET /api/v2/Attributes/Valid` Connector route and its underlying [use case]({% link _docs_integrate/use-cases.md %}) for getting valid [Attributes]({% link _docs_integrate/data-model-overview.md %}#attributes) were removed, because the properties `validFrom` and `validTo` have been removed from the Attributes. - For the same reason, the `onlyValid` parameter was removed from the use cases [Get Attributes]({% link _docs_use-cases/use-case-consumption-get-attributes.md %}), [Get own shared Attributes]({% link _docs_use-cases/use-case-consumption-get-own-shared-attributes.md %}) and [Get peer shared Attributes]({% link _docs_use-cases/use-case-consumption-get-peer-shared-attributes.md %}). Accordingly, it was removed from the associated Connector routes as well.