Skip to content

Commit

Permalink
tweak trigger-service docs (#10845)
Browse files Browse the repository at this point in the history
CHANGELOG_BEGIN
CHANGELOG_END
  • Loading branch information
garyverhaegen-da authored Sep 10, 2021
1 parent fb5ab5d commit 567fe43
Show file tree
Hide file tree
Showing 2 changed files with 6 additions and 10 deletions.
4 changes: 2 additions & 2 deletions docs/source/tools/trigger-service/authorization.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@ For example, use the following flags if the trigger service and the auth middlew
--auth https://example.com/auth
--auth-callback https://example.com/trigger/cb

Assuming that the auth middleware is available under ``https://example.com/auth/``
and the trigger service is available under ``https://example.com/trigger/``.
Assuming that the auth middleware is available under ``https://example.com/auth``
and the trigger service is available under ``https://example.com/trigger``.

Note that the trigger service must be able to share cookies with the auth middleware as described in the :ref:`Deployment notes <oauth2-middleware-deployment>`.

Expand Down
12 changes: 4 additions & 8 deletions docs/source/tools/trigger-service/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,7 @@ The :ref:`running-a-no-op-trigger` section shows a simple method using the ``dam

Complex workflows can require running many triggers for many parties and at a certain point, use of ``daml trigger`` with its process per trigger model becomes unwieldy. The Trigger Service provides the means to host multiple triggers for multiple parties running against a common ledger in a single process and provides a convenient interface for starting, stopping and monitoring them.

The Trigger Service is a ledger client that acts as an end-user agent. The Trigger Service intermediates between the ledger and end-users by running triggers on their behalf. The Trigger Service is an HTTP REST service. All requests and responses use JSON to encode data.
The Trigger Service is a ledger client that acts as an end-user agent. The Trigger Service intermediates between the ledger and end-users by running triggers on their behalf. The Trigger Service is an HTTP service. All requests and responses use JSON to encode data.

Starting the Trigger Service
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
Expand Down Expand Up @@ -61,7 +61,7 @@ where

- ``triggerName`` contains the identifier for the trigger in the form
``${packageId}:${moduleName}:${identifierName}``. You can find the
package id using ``daml damlc inspect path/to/trigger.dar``.
package id using ``daml damlc inspect path/to/trigger.dar | head -1``.
- ``party`` is the party the trigger will be running as.
- ``applicationId`` is an optional field to specify the application ID
the trigger will use for command submissions. If omitted, the
Expand Down Expand Up @@ -134,7 +134,7 @@ HTTP Response
Status of a trigger
*******************

The status endoint returns you metadata about the trigger like the
The status endoint returns metadata about the trigger like the
party it is running as and the trigger id as well as the state the
trigger is in (querying the acs, running, stopped).

Expand Down Expand Up @@ -165,7 +165,7 @@ HTTP Response
Upload a new DAR
****************

Upload a DAR containing one or more triggers. If successful, the DAR's "main package ID" will be in the response (the main package ID for a DAR can also be obtained using ``daml damlc inspect-dar path/to/dar``).
Upload a DAR containing one or more triggers. If successful, the DAR's "main package ID" will be in the response (the main package ID for a DAR can also be obtained using ``daml damlc inspect path/to/dar | head -1``).

HTTP Request
============
Expand Down Expand Up @@ -201,10 +201,6 @@ HTTP Request
- URL: ``/livez``
- Method: ``GET``

.. code-block:: json
{"status":"pass"}
HTTP Response
=============

Expand Down

0 comments on commit 567fe43

Please sign in to comment.