Bug #19929
openImprove documentation in the discovery document
0%
Description
Just like every public class and method in the Python SDK should have its own docstring, every public schema, resource type, and method in the API server's discovery document should have a consistent description
. SDKs in every language can use this to generate documentation.
IMO unless some other requirement overrides, description
fields should follow the same Markdown formatting rules we use for Python docstrings, for the same reasons: to provide a presentation that looks good in both plaintext and HTML.
- Make sure all parameters of all methods are advertised. Known missing:
- The
select
parameter ofget
methods
- The
- Make sure all parameters of all methods have a description. Known missing:
list
parameterscount
,distinct
,filters
,limit
,offset
,order
,where
- Make sure all method parameters with default values advertise that default correctly—with a possible exception for parameters that must be cluster-specific like
cluster_id
. Known missing:- The
select
attribute of most methods list
parametersbypass_federation
,filters
,order
,where
.
- The
Don't bother with anything deprecated and/or do this after the "declutter the API story".
Related issues
Updated by Brett Smith 8 months ago
- Related to Support #18799: Strategy to generate Python SDK docstrings based on API docs added
Updated by Brett Smith 8 months ago
- Story points set to 1.0
Estimating one story point based on:
$ git grep -c description: services/api/app/controllers/ services/api/app/controllers/application_controller.rb:8 services/api/app/controllers/arvados/v1/collections_controller.rb:4 services/api/app/controllers/arvados/v1/container_requests_controller.rb:2 services/api/app/controllers/arvados/v1/groups_controller.rb:7 services/api/app/controllers/arvados/v1/nodes_controller.rb:2 services/api/app/controllers/arvados/v1/schema_controller.rb:31
Point being, most of the work is documenting the common methods once in schema_controller
, there aren't tons of exceptions and additions beyond that.
Updated by Brett Smith 7 months ago
- Release deleted (
60) - Target version set to To be scheduled
I am proposing we do this as part of improving our documentation generally. It's been groomed. We don't have to take this approach, but I would like to at least discuss it and not postpone it automatically.
Updated by Brett Smith 7 months ago
- Related to Bug #3817: [API] Discovery document schema does not include generated fields like job dependencies added
Updated by Peter Amstutz 5 months ago
- Target version changed from To be scheduled to Development 2023-05-10 sprint
Updated by Peter Amstutz 5 months ago
- Target version changed from Development 2023-05-10 sprint to Development 2023-05-24 sprint
Updated by Peter Amstutz 5 months ago
- Target version changed from Development 2023-05-24 sprint to Development 2023-06-07
Updated by Peter Amstutz 4 months ago
- Target version changed from Development 2023-06-07 to To be scheduled
Updated by Peter Amstutz 1 day ago
- Target version changed from To be scheduled to Development 2023-11-22 sprint
Updated by Peter Amstutz 1 day ago
- Related to Story #15397: Declutter the API added