Changed prefix of Connector routes

_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,17 +148,17 @@ 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}
 
 ### 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=<id>` 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=<id>` 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.
 

_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.

_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 <a href="{% link _docs_operate/configuration.md %}#corehttpapi"><i class="fas fa-fw fa-cog"/></a> {#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) <a href="{% link _docs_operate/configuration.md %}#sse"><i class="fas fa-fw fa-cog"/></a> {#sse}
 

_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
 ---
 

_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
 ---
 

_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
 ---
 

_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
 ---
 

_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
 ---
 

_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
 ---
 

_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
 ---
 

_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
 ---
 

_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
 ---
 

_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
 ---
 

_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
 ---
 

_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
 ---
 

_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
 ---
 

_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
 ---
 

_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
 ---
 

_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
 ---
 

_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
 ---