For Central API docs, show optional/required info

Open
#1,836 0 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Assessment

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

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.

Description

Central
Dominant language
Python
Stars
58
Forks
161
Avg merge
20h 51m
Merged PRs (30d)
2

Getting set up

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

More from getodk/docs

All issues in getodk/docs

Similar issues

More Python issues

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.