diff --git a/_config.yml b/_config.yml index 130f72398..5bdeff345 100644 --- a/_config.yml +++ b/_config.yml @@ -186,7 +186,7 @@ defaults: path: "" type: docs_use-cases values: - layout: single + layout: usecase author_profile: false sidebar: - title: "Use-Cases enmeshed" diff --git a/_includes/use-cases/use-case-consumption-create-outgoing-request.md b/_includes/use-cases/use-case-consumption-create-outgoing-request.md index 2599a3850..9a8f06a5d 100644 --- a/_includes/use-cases/use-case-consumption-create-outgoing-request.md +++ b/_includes/use-cases/use-case-consumption-create-outgoing-request.md @@ -2,22 +2,19 @@ {% include properties_list.html %} -This use-case is intended to create one request for a single peer. One should [check if outgoing request can be created](use-case-consumption-check-if-outgoing-request-can-be-created) before creating the request with this use-case. +This use-case is intended to create an actionable [LocalRequest](integrate/data-model-overview#localrequest) based on a given `request` (as a [Request](integrate/data-model-overview#localrequest) datastructure) for a given `peer`. One can (and should) [check if the outgoing request can be created](use-case-consumption-check-if-outgoing-request-can-be-created) before creating the request with this use-case. ## Parameters -- The content for the to be created request is described in the [data model](/integrate/data-model-overview#request). -- The peer is the address of the recipient of this request. There can only be one peer per request. +- The `content` for the to be created request is described in the [data model](integrate/data-model-overview#request). +- The `peer` is the address of the recipient of this request. There can only be one peer per request. ## On Success -- The [LocalRequest](http://localhost:4000/integrate/data-model-overview#localrequest) is created but so far not sent to the peer. It needs to be manually submitted to the peer, e.g. [by sending a message](http://localhost:4000/integrate/requests-over-messages). +- A [LocalRequest](integrate/data-model-overview#localrequest) for the given parameters is created in status `Draft` but so far not sent to the given peer. +- It needs to be manually submitted to the peer, e.g. [by sending a message](integrate/requests-over-messages). ## On Failure - The request cannot be created if the peer is unknown. - The request cannot be created if the request content is malformed. Please [check if the outgoing request can be created](use-case-consumption-check-if-outgoing-request-can-be-created) for more details. - -{% include usecase_connector_intro %} - -{% include rapidoc %} diff --git a/_includes/usecase_connector_intro b/_includes/usecase_connector_intro index e59befe08..82910ff66 100644 --- a/_includes/usecase_connector_intro +++ b/_includes/usecase_connector_intro @@ -1,4 +1,4 @@ -## How to execute this use-case with the Connector? +

How to execute this use-case with the Connector?

The Connector is our first-class citizen, thus we provide you with a detailed API description for every use-case. -This use-case can be executed with the REST API of the Connector which you can [Access the Connector](/integrate/access-the-connector). +This use-case can be executed with the REST API of the Connector which you can Access the Connector. diff --git a/_layouts/usecase.html b/_layouts/usecase.html new file mode 100644 index 000000000..7130ba5fb --- /dev/null +++ b/_layouts/usecase.html @@ -0,0 +1,14 @@ +--- +layout: single +--- + +{{ content }} + + +{% if page.api_route_regex != "" %} + + {% include usecase_connector_intro %} + + {% include rapidoc %} + +{% endif %} \ No newline at end of file