Skip to content

Commit

Permalink
chore: run prettier
Browse files Browse the repository at this point in the history
  • Loading branch information
kojofl committed Oct 17, 2023
1 parent 53e1e82 commit 33ac3ee
Show file tree
Hide file tree
Showing 16 changed files with 22 additions and 37 deletions.
Original file line number Diff line number Diff line change
Expand Up @@ -2,20 +2,20 @@

{% include properties_list.html %}

This use-case attempts to accept an incomming [Request](/integrate/data-model-overview#request).
This use-case attempts to accept an incomming [Request](/integrate/data-model-overview#request).
It is advised to [check if incoming request can be accepted](/use-case-consumption-check-if-incoming-request-can-be-accepted)
in advance.

## Parameters

- The `id` of the incomming request.
- The decision for each individual [RequestItem](/integrate/data-model-overview#request)
expressed as the appropriate [Parameters defined in the Data Model](/integrate/requests-and-requestitems).
expressed as the appropriate [Parameters defined in the Data Model](/integrate/requests-and-requestitems).

## On Success

- The request is processed according to the decisions made.
- The sending peer is informed about your decisions.
- The request is processed according to the decisions made.
- The sending peer is informed about your decisions.

## On Failure

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ can be accepted with the given parameters without actually accepting it.

- The `id` of the incomming request.
- The decision for each individual [RequestItem](/integrate/data-model-overview#request)
expressed as the appropriate [Parameters defined in the Data Model](/integrate/requests-and-requestitems).
expressed as the appropriate [Parameters defined in the Data Model](/integrate/requests-and-requestitems).

## On Success
## On Success

- The request can be accepted with the given parameters.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -9,9 +9,9 @@ can be rejected with the given parameters without actually rejecting it.

- The `id` of the incomming request.
- The decision for each individual [RequestItem](/integrate/data-model-overview#request)
expressed as the appropriate [Parameters defined in the Data Model](/integrate/requests-and-requestitems).
expressed as the appropriate [Parameters defined in the Data Model](/integrate/requests-and-requestitems).

## On Success
## On Success

- The request can be requected with the given parameters.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,9 @@ based on a given `request` (as a [Request](integrate/data-model-overview#localre
- The `peer` is the address of the recipient of this request. There can only be one peer per request.

## On Success
Please [check if the outgoing request can be created](use-case-consumption-check-if-outgoing-request-can-be-created) for more details.

Please [check if the outgoing request can be created](use-case-consumption-check-if-outgoing-request-can-be-created) for more details.

- A [LocalRequest](integrate/data-model-overview#localrequest) for the given parameters can be created.

## On Failure
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,14 @@
This use-case is intended to create an [LocalAttribute](/integrate/data-model-overview#localattribute)
based on a given `attribute` (as a [Attribute](/integrate/data-model-overview#attributes) datastructure).

## Parameters
## Parameters

- The `content` for the to be created attribute is described in the [data model](/integrate/data-model-overview#attributes)

## On Success
## On Success

- A [LocalAttribute](/integrate/data-model-overview#localattribute) is created according to the paramter.

## On Failure

- The attribute cannot be created if the parameter is malformed.

Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@
This use-case is intended to search for a peer's relationship attribute that was created
in a relationship with a third party.

## Parameters
## Parameters

- The `query` for the to be searched attribute is described in the [data model](/integrate/data-model-overview#thirdpartyrelationshipattributequery).

## On Success
## On Success

- A list of attributes that conform to the query is returned.

Expand Down
4 changes: 2 additions & 2 deletions _includes/use-cases/use-case-consumption-get-attribute.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,11 @@
This use-case is intended to retrieve a [attribute](/integrate/data-model-overview#attributes)
by it's id.

## Parameters
## Parameters

- The `id` of the attribute.

## On Success
## On Success

- The attribute corresponding to the id.

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -12,4 +12,3 @@ refer to the interactive API docs bellow for reference.
```

{% include rapidoc api_route_regex="^get /api/v2/Attributes$" title="API docs" %}

Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
Retrieve support information.

{% include rapidoc api_route_regex="^get /monitoring/support$" title="API documentation" %}

Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
Retrieve service health information.

{% include rapidoc api_route_regex="^get /health$" %}

Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
Retrieve service version information.

{% include rapidoc api_route_regex="^get /monitoring/version$" %}

Original file line number Diff line number Diff line change
@@ -1,4 +1,3 @@
Retrieve number of requests and the status codes returned by the connector.

{% include rapidoc api_route_regex="^get /monitoring/requests$" %}

Original file line number Diff line number Diff line change
Expand Up @@ -20,4 +20,3 @@ Read [more](/integrate/data-model-overview#relationshiptemplate).
```

{% include rapidoc api_route_regex="^post /api/v2/RelationshipTemplates/Own$" title="API docs" %}

Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
Creates a [token](/integrate/data-model-overview#token) for a given file that
corresponds to the given id.

## Example Body
## Example Body

```json
{
"expiresAt": "2024-01-01T00:00:00.000Z"
"expiresAt": "2024-01-01T00:00:00.000Z"
}
```

Expand Down
Original file line number Diff line number Diff line change
@@ -1,13 +1,12 @@
Creates a [token](/integrate/data-model-overview#token) for a given [relationship template](/integrate/data-model-overview#relationshiptemplate)
that coresponds to the given id.

## Example Body
## Example Body

```json
{
"expiresAt": "2024-01-01T00:00:00.000Z"
"expiresAt": "2024-01-01T00:00:00.000Z"
}
```

{% include rapidoc api_route_regex="^post /api/v2/RelationshipTemplates/Own/{id}/Token$" title="API docs" %}

11 changes: 1 addition & 10 deletions _layouts/usecase.html
Original file line number Diff line number Diff line change
Expand Up @@ -2,13 +2,4 @@
layout: single
---

{{ content }}


{% if page.api_route_regex %}

{% include usecase_connector_intro %}

{% include rapidoc %}

{% endif %}
{{ content }} {% if page.api_route_regex %} {% include usecase_connector_intro %} {% include rapidoc %} {% endif %}

0 comments on commit 33ac3ee

Please sign in to comment.