Skip to content

Commit

Permalink
add details on list_endpoints commands (#190)
Browse files Browse the repository at this point in the history
  • Loading branch information
oliverrahner authored Apr 17, 2024
1 parent ee57fd2 commit 4f12a1a
Show file tree
Hide file tree
Showing 2 changed files with 34 additions and 5 deletions.
31 changes: 26 additions & 5 deletions modules/ROOT/pages/commands/ecosystem.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,11 @@ To communicate with all the other endpoints in the eco system of the specific ag

=== Definition

Every App Instance can call for a list of endpoints that are capable of receiving or sending specific messages. This request does not filter for available routings.
Every App Instance can call for a list of endpoints that are capable of receiving or sending specific messages.
This command only takes into account *capabilities* of endpoints, but does not take into account any routes.

A complete list of endpoints in the connected agrirouter account is returned.
Only the `message_types` list will be filtered according to the parameters.

=== Command

Expand All @@ -28,8 +32,8 @@ Every App Instance can call for a list of endpoints that are capable of receivin
[cols="1,3,2,4",options="header",]
|================================================================================================
|# |Name |Type |Description
|1 |technical_message_type |String |The technical message type that should be part of the routing
|2 |direction |Direction |The direction, the routing shall support
|1 |technical_message_type |String |The technical message type *the remote endpoint* supports
|2 |direction |Direction | The direction *the remote endpoint* supports (e.g. "Can *the remote endpoint* SEND this message type?")
|================================================================================================

The direction describes if messages shall be sendable or receivable:
Expand Down Expand Up @@ -92,10 +96,11 @@ The Message object describes technical message type and direction.
[cols="1,3,2,4",options="header",]
|================================================================================================
|# |Name |Type |Description
|1 |technical_message_type |String |The technical message type that should be part of the routing
|2 |direction |Direction |The direction, the routing shall support
|1 |technical_message_type |String |The technical message type *the remote endpoint* supports
|2 |direction |Direction | The direction *the remote endpoint* supports (e.g. "Can *the remote endpoint* SEND this message type?")
|================================================================================================


The direction describes if messages shall be sendable or receivable:

[cols=",",options="header",]
Expand Down Expand Up @@ -135,6 +140,8 @@ If the message was incorrect, an ACK_WITH_FAILURE will be reported. For specific

This request is used for request a list of endpoints that support a technical message type and has corresponding routings to the requesting endpoint.

This command takes into account the *routes* between endpoints, which implicitly includes capabilities.

=== Command

[cols=",",]
Expand All @@ -144,6 +151,13 @@ This request is used for request a list of endpoints that support a technical me
|TypeURL |types.agrirouter.com/agrirouter.request.payload.account.ListEndpointsQuery
|===============================================================================

[cols="1,3,2,4",options="header",]
|================================================================================================
|# |Name |Type |Description
|1 |technical_message_type |String |The technical message type *the remote endpoint* supports
|2 |direction |Direction | The direction the data can flow *from the perspective of the requesting endpoint* (e.g. "Can *I* SEND this specific data type to the other endpoint?")
|================================================================================================

For further information, see xref:./ecosystem.adoc##call-for-endpoints-that-support-a-technical-message-type[Call for endpoints that support a technical message type]

=== Result
Expand All @@ -155,6 +169,13 @@ For further information, see xref:./ecosystem.adoc##call-for-endpoints-that-sup
|TypeURL |types.agrirouter.com/agrirouter.response.payload.account.ListEndpointsResponse
|===================================================================================

[cols="1,3,2,4",options="header",]
|================================================================================================
|# |Name |Type |Description
|1 |technical_message_type |String |The technical message type *the remote endpoint* supports
|2 |direction |Direction | The direction the data can flow *from the perspective of the requesting endpoint* (e.g. "Can *I* SEND this specific data type to the other endpoint?")
|================================================================================================

For further information, see xref:./ecosystem.adoc##call-for-endpoints-that-support-a-technical-message-type[Call for endpoints that support a technical message type]


Expand Down
8 changes: 8 additions & 0 deletions modules/ROOT/pages/troubleshooting/faq.adoc
Original file line number Diff line number Diff line change
@@ -0,0 +1,8 @@
# Troubleshooting FAQs

## Onboarding

### The request has timed out or UTCTimestamp is not provided

Make sure your system time is exactly matching official time sources. While agrirouter has some tolerance for timestamps in the past, it does _not_ have any tolerance
for timestamps that are in the future.

0 comments on commit 4f12a1a

Please sign in to comment.