Commit 1784f2f9 authored by Andrii Salnikov's avatar Andrii Salnikov

REST specification more formatting update

parent 06cafbd4
Pipeline #7427 passed with stages
in 3 minutes and 57 seconds
......@@ -15,7 +15,7 @@ ARC CE REST interface specification
The REST API endpoint
---------------------
The various functionalities of the service are accessible through HTTP(S) URL built upon following pattern
The various functionalities of the service are accessible through HTTP(S) URL built upon following pattern:
:arcdef:`<service endpoint URL>/rest/<version>/<functionality>`
......@@ -50,26 +50,33 @@ Description of functionalities and operations
Supported versions
''''''''''''''''''
HTTP ``GET`` request on ``<service endpoint URL>/rest`` returns list of supported versions.
:arcdef:`GET <service endpoint URL>/rest`
The XML response is like:
Operations:
- ``GET`` - returns list of supported REST API versions
- ``POST``, ``PUT``, ``DELETE`` - not supported
.. code-block:: xml
Example response:
<versions>
<version>1.0</version>
<version>1.1</version>
<version>1.2</version>
</versions>
The XML response is like:
.. note::
TODO: Aleksandr defines consistent JSON rendering based on actual implementation
.. code-block:: xml
<versions>
<version>1.0</version>
<version>1.1</version>
<version>1.2</version>
</versions>
.. note::
TODO: Aleksandr defines consistent JSON rendering based on actual implementation
The JSON is:
The JSON is:
.. code-block:: json
.. code-block:: json
[ "1.0", "1.1", "1.2" ]
[ "1.0", "1.1", "1.2" ]
Obtaining CE resource information
'''''''''''''''''''''''''''''''''
......@@ -271,7 +278,7 @@ Operations:
A-REX control directory files access for debugging
++++++++++++++++++++++++++++++++++++++++++++++++++
:arcdef:`<base URL>/jobs/<job id>/debug/<file type>`
:arcdef:`GET <base URL>/jobs/<job id>/debug/<file type>`
Operations:
......@@ -369,9 +376,14 @@ Delegation is a 2-step process. Step 1 generates pair of private/public keys on
Delegations management
++++++++++++++++++++++
.. note::
TODO: Do we need bulk operations for delegation? For bulk jobs it seams better approach is to share the same delegation? Some clarification is needed for the entire workflow. How job is associated with delegation ID?
In this sense following operations can be replaced with per-ID URLs.
.. warning::
TODO: Aleksandr - clarification is needed for the entire workflow. How job is associated with delegation ID?
Do we need bulk operations for delegation?
For bulk jobs submission it seams the better approach is to share the same delegation.
In this sense following operations probably need to be replaced with per-ID URLs.
``POST <base URL>/delegations/?action=get,renew,delete`` used to manage ARC CE delegations.
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment