From d1cc041ef4991964b063000f90bc4868a64d4bfa Mon Sep 17 00:00:00 2001
From: Robert Butora <robert.butora@inaf.it>
Date: Sat, 1 Mar 2025 15:41:50 +0100
Subject: [PATCH] README: updates sections on endpoints (renames uws_mcutout ->
 async/uws)

---
 README.md | 42 ++++++++++++++++++++++++------------------
 1 file changed, 24 insertions(+), 18 deletions(-)

diff --git a/README.md b/README.md
index 8705786..2c4ce49 100644
--- a/README.md
+++ b/README.md
@@ -15,50 +15,56 @@ curl --get http://localhost:8004/vlkb/datasets/availability
 ```
 
 
-## Enpoints
+## End-points
 
 - **availability** is a [VOSI](https://ivoa.net/documents/VOSI/20170524/REC-VOSI-1.1.html) end-point and returns information whether the service is active
 - **capabilities** is a [VOSI](https://ivoa.net/documents/VOSI/20170524/REC-VOSI-1.1.html) end-point which describes service' functions and paramters
-- **soda** synchronous end-point provides [SODA](https://ivoa.net/documents/SODA/20170517/index.html) service
-- **uws_mcutout** a non-standard asynchronous [UWS](https://ivoa.net/documents/UWS/20161024/REC-UWS-1.1-20161024.html#ApplicationsOfUWS) end-point which allows several cuts to be specified in one request by own [Job Description Language](JDL.md). All cuts are returned compressed in one tar.gz file
+- **sync** synchronous end-point provides [SODA](https://ivoa.net/documents/SODA/20170517/index.html) service
+- **async/uws** (optional) a non-standard asynchronous [UWS](https://ivoa.net/documents/UWS/20161024/REC-UWS-1.1-20161024.html#ApplicationsOfUWS) end-point which allows several cuts to be specified in one request by specific [Job Description Language](JDL.md). All cuts are returned compressed in one tar.gz file
 
 
-## Security
+## Docker image
 
-The data store may hold public and/or private collections.
+is available from the gitlab-repository of this project.
 
-The vlkb-soda supports OIDC/OAuth2.0 protocol and will validate access token in the request.
-Non authenticated requests may be allowed by configuration, and will access only public data.
+SODA-docker's internal mount point for the FITS-files storage is **/srv/datasets** (read-only).
 
-If request passes token validation, group-based authorization check is performed. A user may access the data
-if at least on of the user's groups is allowed the access. Access rights for data collections are held in the authorization table.
+SODA-docker's internal mount point which temporarely holds cut files is **/srv/cutouts** (read-write) for **mcutout only**.
 
+Configuration parameters are set by these docker environment variables:
 
-## Docker image
+| parameter | description  |
+|---------|--------------|
+| **ACCESS_CONTEXT_ROOT** | root of the end-points (default: 'soda') |
+| **ENABLE_ASYNC_UWS** | set true to enable async endpoint (default: false) |
 
-is available from the gitlab-repository of this project.
+Context-root parameter uses 'tomcat syntax' in which the forward-slash path-separator is replaced with hash: vlkb#datasets -> vlkb/datasets
 
-SODA-docker's internal mount point for the FITS-files storage is **/srv/datasets** (read-only).
+## Security (optional)
 
-SODA-docker's internal mount point which temporarely holds cut files is **/srv/cutouts** (read-write) for **mcutout only**.
+The data store may hold public and/or private collections.
 
+The vlkb-soda supports OIDC/OAuth2.0 protocol and will validate access token in the request.
+Non authenticated requests may be allowed by configuration, and will access only public data.
 
-Configuration parameters are set by these docker environment variables:
+If request passes token validation, group-based authorization check is performed. A user may access the data
+if at least on of the user's groups is allowed the access. Access rights for data collections are held in the authorization table.
 
+Administer new users with [AUTH](https://ict.inaf.it/gitlab/ViaLactea/vlkb-authz) service. 
+
+Configure security:
 
 | parameter | description  |
 |---------|--------------|
-| **ACCESS_CONTEXT_ROOT** | root of the vlkb-soda end-points |
 | **OIDC_INTROSPECT** | URL to OAuth2.0 introspect end-point for token validation |
 | **OIDC_RAP_URL** | root URL of an Open ID Connect comaptible identity service |
 | **OIDC_GMS_URL** | root URL of Group Management Service |
 | **OIDC_CLIENT** | client-id of a Relying party |
 | **OIDC_SECRET** | secret of of the client |
-| **AUTHZ_DB_URL** | DB where a table with authorization info ('goups' column) can be found |
+| **AUTHZ_DB_URL** | DB where a table with authorization info ('groups' column) can be found |
 | **AUTHZ_DB_SCHEMA** | schema of the authorization table |
 | **AUTHZ_DB_USERNAME** | user in the DB with authorization table |
 | **AUTHZ_DB_PASSWORD** | password for the DB-user |
-| **CUTOUTS_URL** | access point to download resulting cuts (**mcutout only**) |
 
-Context-root parameter uses 'tomcat syntax' in which the forward-slash path-separator is replaced with hash: vlkb#datasets -> vlkb/datasets
+
 
-- 
GitLab