getodk / getodk/docs

For Central API docs, show optional/required info

Open
#1,836 0 comments 1 reaction 0 assignees View on GitHub
Central
Dominant language
Python
Stars
58
Forks
160
Avg merge
5d 11h
Merged PRs (30d)
12

Description

For example: https://github.com/getodk/central-backend/blob/0cd56948854ecc544a1b4af9efd88cf9ceee153d/docs/api.yaml#L11958 -- this is not surfaced in the rendered docs.

Contributor guide

Open the contributing guide

Research direction

Start with docs/api.yaml around the linked line and inspect how the Central API schema is rendered in the Sphinx documentation. Confirm where optional and required information is lost, then verify the rendered API docs visibly show that information for the example endpoint.

Written by the indexing model from the issue text.

Assessment

Domain
documentation
Issue type
Documentation
Difficulty
3/5
Estimated time
1-2 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.