tapis-project/documentation

Documentation for Tapis v3

documentation's Issues

PgREST: Rework documentation for Tables, Views, and Roles.

Getting full docs written for each endpoint in PgREST.

Documentation: meta CURL responses

The following operations have missing responses:

• Create DB
• Delete DB
• Get Collection Size
• Replace Document
• Modify Document
• Delete Document
• List Index
• Create Index
• Delete Index
• Create an Aggregation
• Execute an Aggregation
• Delete an Aggregation

Systems: Document support for sharing

Add documentation on the implicit grant type

We provide a concrete description of how to integrate the authorization_code grant type into a server. We should provide similar documentation on how to integrate implicit into a pure-static application.

Add documentation on the device code grant type

We provide a concrete description of how to integrate the authorization_code grant type into a server. We should provide similar documentation on how to integrate device_code into a headless application.

Docs: Update Systems createUserCred docs

SDSC asked that documentation be updated to reflect that createUserCredentials in systems service only supports one set of credentials per user per system. Updating credentials overwrites previously registered data.

document vault root key revoke procedure

Updates to Administrative section based on SDSC feedback

"Roles, Permissions and Service Accounts":

• specifically recommended to not have any roleBindings on the "default" account.
• add a link to the part of the Deployer documentation on how to specify the value for skadmin_sk_privileged_sa and set it to the name of the service account that was defined

Tests:

• Expand section on tapis-tests

DB Backups:

• Which DBs for which services
• The link to the MongoDB GitHub repository gives a 404.
• Mention safekeeping the YAML somewhere (git), and safekeeping other secrets. I'm thinking particularly of the secrets in "tapisdatadir".

Files: Document support for sharing - share,unshare,sharedAppCtx

Documentation: meta pySDK operations

Currently Missing meta pySDK operations in readthedocs for:

• List Indexes
• Create Index
• Delete Index
• Create an Aggregation
• Execute an Aggregation
• Delete an Aggregation

Apps: Update auth checking for service requests

Update auth checking for service requests to match recent updates for Systems.
Service requests should always be allowed for some cases when a service calls as itself.
Else normal user auth checks should be made based on oboUser.
Plan - Update Apps to:

• always allow a service calling as itself to read a system.
  

• if svc not calling as itself do the normal checks using oboOrImpersonationId.
  

• as before make sure auth checks are skipped if svc passes in sharedAppCtx=true.
  

• remove SVCLIST_READ allow list.
  

Documentation: Python calls

There are a couple of small things that are incorrect within the documentation.

In the section that deals with documents, the function signatures for:

• Getting a Document
• Replacing a Document
• Modifying a Document
• Deleting a Document
  all have "documentId", when it should be "docId".

Also, the Modify call is missing the request_body parameter

Apps: Document support for sharing

envVariables docs not correct

https://github.com/tapis-project/documentation/blob/master/source/technical/apps.rst#parameterset-attributes-table

says that envVariables is an array of strings, but it is an array of JSON objects with "key","value","description" keys.

                "envVariables": [
                    {
                        "key": "ir_gateway_url",
                        "value": "https://gateway-analysis-dev/",
                        "description": null
                    },
                    {
                        "key": "download_file",
                        "value": "gateway_download.zip",
                        "description": null
                    }

The above is the output of curl -s -H "X-Tapis-Token: $JWT" https://tacc.tapis.io/v3/apps/app-name

Jobs: Missing Curl and Tapipy submit examples

The documentation for Jobs currently has examples for status/search/list/etc. but doesn't have examples for submit and resubmit.