Skip to content

Commit

Permalink
feat: update naming
Browse files Browse the repository at this point in the history
  • Loading branch information
vinzlange committed Sep 22, 2023
1 parent 0f45f4d commit 742da66
Show file tree
Hide file tree
Showing 20 changed files with 68 additions and 584 deletions.
22 changes: 11 additions & 11 deletions _data/navigation.yml
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,9 @@ main:
- title: "Explore"
url: /explore
- title: "Integrate"
url: /integrate/connector-tutorial
url: /integrate/connector-integration-tutorial
- title: "Operate"
url: /operate/get-in-touch-with-enmeshed-data-concepts
url: /operate/get-an-overview-of-connector
- title: "Contribute"
url: /contribute
- title: "Blog"
Expand Down Expand Up @@ -81,8 +81,12 @@ docs_use:
docs_integrate:
- title: Getting Started
children:
- title: "Get in touch with Connector REST API"
url: /integrate/get-in-touch-with-connector-rest-api
- title: "Connector Integration Tutorial"
url: /integrate/connector-tutorial
url: /integrate/connector-integration-tutorial
- title: "Use Cases"
url: /integrate/use-cases
- title: Data Model
children:
- title: "Error Codes"
Expand Down Expand Up @@ -111,6 +115,10 @@ docs_integrate:
children:
- title: "Sending Messages"
url: /integrate/sending-messages
- title: Programming
children:
- title: "Working with the Connector SDKs"
url: /integrate/working-with-the-connector-sdks
- title: Requesting consent of users
children:
- title: "Requesting one-time consents"
Expand All @@ -119,14 +127,10 @@ docs_integrate:
docs_operate:
- title: Getting Started
children:
- title: "Get in touch with Connector REST API"
url: /operate/get-in-touch-with-connector-rest-api
- title: "Get an overview of Connector"
url: /operate/get-an-overview-of-connector
- title: "Set-up Connector for development use (with Docker compose)"
url: /operate/set-up-connector-for-development-use-with-docker-compose
- title: "Get in touch with enmeshed data concepts"
url: /operate/get-in-touch-with-enmeshed-data-concepts
- title: Operations
children:
- title: "Customizing Connector by config"
Expand All @@ -145,7 +149,3 @@ docs_operate:
url: /operate/privacy-considerations
- title: "Performance Considerations"
url: /operate/performance-considerations
- title: Programming
children:
- title: "Working with the Connector SDKs"
url: /operate/working-with-the-connector-sdks
2 changes: 1 addition & 1 deletion _docs_explore/52-connector.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,4 +31,4 @@ The Connector uses a MongoDB database to store its data. You can read more about

## Connector SDK

Read more about the [Connector SDKs]({% link _docs_operate/working-with-the-connector-sdks.md %}).
Read more about the [Connector SDKs]({% link _docs_integrate/working-with-the-connector-sdks.md %}).
Original file line number Diff line number Diff line change
@@ -1,23 +1,23 @@
---
permalink: integrate/connector-tutorial
permalink: integrate/connector-integration-tutorial
redirect_from: /integrate/connector-tutorial
published: true
title: "Connector Integration Tutorial"
type: scenario
toc: true
properties:
- id: SC95
- category: Getting Started
- category: 1Getting Started
- description: https//enmeshed.eu/integrate/connector-tutorial
- customer:
- component: integrate
- level:
- implementation status:
- documentation status:
- published: true
- link: integrate/connector-tutorial
- link: integrate/connector-integration-tutorial
require:
required_by:
---

{% include scenarios/integrate/connector-tutorial.md %}
{% include scenarios/integrate/connector-integration-tutorial.md %}
Original file line number Diff line number Diff line change
@@ -1,24 +1,23 @@
---
permalink: operate/get-in-touch-with-connector-rest-api
redirect_from:
- /integrate/connector-api
permalink: integrate/get-in-touch-with-connector-rest-api
redirect_from: /integrate/connector-api
published: true
title: "Get in touch with Connector REST API"
type: scenario
toc: true
properties:
- id: SC75
- category: Getting Started
- category: 1Getting Started
- description: https//enmeshed.eu/integrate/connector-api
- customer:
- component: operate
- component: integrate
- level:
- implementation status: DOCS ONLY
- documentation status:
- published: true
- link: operate/get-in-touch-with-connector-rest-api
- link: integrate/get-in-touch-with-connector-rest-api
require:
required_by:
---

{% include scenarios/operate/get-in-touch-with-connector-rest-api.md %}
{% include scenarios/integrate/get-in-touch-with-connector-rest-api.md %}
2 changes: 1 addition & 1 deletion _docs_integrate/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ type: scenario
toc: true
properties:
- id: SC96
- category: Getting Started
- category: 1Getting Started
- description:
- customer:
- component: integrate
Expand Down
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
permalink: integrate/requesting-authentication
permalink: integrate/requesting-authentication-
published: false
title: "Requesting authentication "
type: scenario
Expand All @@ -14,11 +14,11 @@ properties:
- implementation status: DONE
- documentation status: OPEN
- published:
- link: integrate/requesting-authentication
- link: integrate/requesting-authentication-
require:
- integrate/requests-over-templates
- integrate/requests-over-messages
required_by:
---

{% include scenarios/integrate/requesting-authentication.md %}
{% include scenarios/integrate/requesting-authentication-.md %}
23 changes: 23 additions & 0 deletions _docs_integrate/use-cases.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,23 @@
---
permalink: integrate/use-cases
redirect_from: /explore/use-cases
published: true
title: "Use Cases"
type: scenario
toc: true
properties:
- id: SC78
- category: 1Getting Started
- description:
- customer:
- component: integrate
- level:
- implementation status: DONE
- documentation status: DONE
- published: true
- link: integrate/use-cases
require:
required_by:
---

{% include scenarios/integrate/use-cases.md %}
Original file line number Diff line number Diff line change
@@ -1,5 +1,5 @@
---
permalink: operate/working-with-the-connector-sdks
permalink: integrate/working-with-the-connector-sdks
redirect_from: /integrate/connector-sdks
published: true
title: "Working with the Connector SDKs"
Expand All @@ -10,14 +10,14 @@ properties:
- category: Programming
- description: https//enmeshed.eu/integrate/connector-sdks
- customer:
- component: operate
- component: integrate
- level:
- implementation status: DOCS ONLY
- documentation status:
- published: true
- link: operate/working-with-the-connector-sdks
- link: integrate/working-with-the-connector-sdks
require:
required_by:
---

{% include scenarios/operate/working-with-the-connector-sdks.md %}
{% include scenarios/integrate/working-with-the-connector-sdks.md %}
2 changes: 1 addition & 1 deletion _docs_operate/get-an-overview-of-connector.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ type: scenario
toc: true
properties:
- id: SC76
- category: Getting Started
- category: 1Getting Started
- description: https//enmeshed.eu/integrate/basics
- customer:
- component: operate
Expand Down
23 changes: 0 additions & 23 deletions _docs_operate/get-in-touch-with-enmeshed-data-concepts.md

This file was deleted.

Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ type: scenario
toc: true
properties:
- id: SC77
- category: Getting Started
- category: 1Getting Started
- description: #2 https//enmeshed.eu/integrate/connector-installation
- customer:
- component: operate
Expand Down
18 changes: 9 additions & 9 deletions _includes/scenarios/integrate/overview-of-attribute-values.md
Original file line number Diff line number Diff line change
Expand Up @@ -289,7 +289,7 @@ The telephone number which can be used to reach the Identity via fax systems.

## IdentityFileReference

A IdentityFileReference is a link to an Enmeshed [`File`]({% link _docs_operate/get-in-touch-with-enmeshed-data-concepts.md %}#files) and can be used to add a File as an Attribute of an Identity. One example for a use case is some kind of certificate.
A IdentityFileReference is a link to an Enmeshed [`File`]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#files) and can be used to add a File as an Attribute of an Identity. One example for a use case is some kind of certificate.

**Properties**

Expand Down Expand Up @@ -903,11 +903,11 @@ A XML.

**Properties**

| Name | Type | Required | Validation |
| -------------------- | --------------------------------------------------------------------------------------------------------------- | :------: | ---------------------------------------------------------- |
| `@type` | `"ProprietaryXML"` || |
| `title` | `string` || max. length: 100 |
| `description` | `string` || max. length: 1000 |
| `valueHintsOverride` | [`ValueHintsOverride`]({% link _docs_operate/get-in-touch-with-enmeshed-data-concepts.md %}#valuehintsoverride) || |
| `value` | `string` || max. length: 50000 <br>must be a valid XML encoded string |
| `schemaURL` | `string` || min. length: 3<br>max. length: 1024<br>must be a valid URL |
| Name | Type | Required | Validation |
| -------------------- | ------------------------------------------------------------------------------------------------------------ | :------: | ---------------------------------------------------------- |
| `@type` | `"ProprietaryXML"` || |
| `title` | `string` || max. length: 100 |
| `description` | `string` || max. length: 1000 |
| `valueHintsOverride` | [`ValueHintsOverride`]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#valuehintsoverride) || |
| `value` | `string` || max. length: 50000 <br>must be a valid XML encoded string |
| `schemaURL` | `string` || min. length: 3<br>max. length: 1024<br>must be a valid URL |
Original file line number Diff line number Diff line change
Expand Up @@ -139,8 +139,8 @@ With the FreeTextRequestItem it is possible to send a free text to the peer. The
| `@type` | `"FreeTextAcceptResponseItem"` | The type of the ResponseItem. |
| `freeText` | `string` | The free text that is used to answer the RequestItem. |

- To reject this RequestItem a [RejectResponseItem]({% link _docs_operate/get-in-touch-with-enmeshed-data-concepts.md %}#rejectresponseitem) will be transferred.
- In case of an error an [ErrorResponseItem]({% link _docs_operate/get-in-touch-with-enmeshed-data-concepts.md %}#errorresponseitem) will be transferred.
- To reject this RequestItem a [RejectResponseItem]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#rejectresponseitem) will be transferred.
- In case of an error an [ErrorResponseItem]({% link _docs_integrate/introducing-the-enmeshed-data-model.md %}#errorresponseitem) will be transferred.

#### Parameters {#freetextrequestitem-response-parameters}

Expand Down
2 changes: 1 addition & 1 deletion _includes/scenarios/integrate/requests-over-messages.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ This guide explains how to send and receive a Request over Enmeshed Messages usi

{% include properties_list.html %}

This guide assumes that you already have an active Relationship between two Connectors. If you don't, you should follow the [Requests over Templates]({% link _docs_integrate/requests-over-templates.md %}) guide first. If you created a Relationship during the [Connector Tutorial]({% link _docs_integrate/connector-tutorial.md %}) this will also work.
This guide assumes that you already have an active Relationship between two Connectors. If you don't, you should follow the [Requests over Templates]({% link _docs_integrate/requests-over-templates.md %}) guide first. If you created a Relationship during the [Connector Tutorial]({% link _docs_integrate/connector-integration-tutorial.md %}) this will also work.

In this guide, the first Connector will be called Sender and the second Connector will be called Recipient. The Sender will send a Request to the Recipient. For the next steps you will need the Enmeshed Address of the Recipient. You can find it out by calling the `GET /api/v2/Relationships` route on the Sender Connector.

Expand Down
File renamed without changes.
Loading

0 comments on commit 742da66

Please sign in to comment.