Improve API docs about updating form metadata/config
Maintainers usually reply within 1 day
Nobody has claimed this yet.
Assessment
- Difficulty
- 2/5
- Estimated time
- Half a day
- Newbie friendliness
- 55/100
- Issue type
- Documentation
- Clarity
- Mostly clear
- Activity status
- Active
- Domain
- api, documentation
Research direction
The gap is in the 'Modifying a Form' section of the API docs at docs.getodk.org/central-api-form-management, which says only state can be changed. Find where that page's source lives, then add webformsEnabled to the list of modifiable fields. Check the state values against the user docs before linking to them. Done when the section lists every modifiable field and the state meanings or links are present; the payload does not say whether the maintainers want the meanings written out or just linked.
Written by the indexing model from the issue text.
Description
Filing an issue based on https://github.com/getodk/central-backend/pull/1966#discussion_r4279217761
The API docs about Modifying a Form seem to be missing a couple of things. The docs say:
It is currently possible to modify only one thing about a Form: its
state
However, these days, it is also possible to modify webformsEnabled.
See the
stateAttribute in the Request documentation to the right to see the possible values and their meanings.
- I don't see any Request documentation to the right. That text may predate our moving the API docs to docs.getodk.org.
- I don't see that we document the meaning of each state and the differences between the states. I think we could consider linking to the user docs for this.
- Dominant language
- JavaScript
- Stars
- 233
- Forks
- 241
- Avg merge
- 1d 22h
- Merged PRs (30d)
- 13
Getting set up
- Ships a Dockerfile or Docker Compose file
- Has a pull request template
- No contributing guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
More from getodk/central
-
sessions are not reapedPossibly taken A pull request linked to this issue is open or already merged. Open
Difficulty 1/5 Under an hour Newbie friendliness 88/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 73/100
Maintainers usually reply within 1 day
-
The `New Submission` button on the Submissions tab is now harder to access on mobilePossibly taken @sadiqkhoja claimed this 1 day ago. Openfrontend
Difficulty 2/5 1-3 hours Newbie friendliness 65/100
getodk/central#2334 · 1 assignee ·
Maintainers usually reply within 1 day
-
Copying text from table clicks on the rowPossibly taken @sadiqkhoja claimed this 1 day ago. Openfrontend needs testing
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
getodk/central#2331 · 1 comment · 1 assignee ·
Maintainers usually reply within 1 day
-
Hide closed formsPossibly taken @nicoleorlowski claimed this 8 days ago. Openfrontend needs testing
Difficulty 2/5 1-3 hours Newbie friendliness 64/100
getodk/central#2323 · 1 comment · 1 assignee ·
Maintainers usually reply within 1 day
Similar issues
-
Difficulty 2/5 1-3 hours Newbie friendliness 73/100
product-os/flowzone#2048 ·
Maintainers usually reply within 1 day
-
documentation
Difficulty 2/5 1-3 hours Newbie friendliness 85/100
hugomrdias/playwright-test#786 · 1 comment ·
Maintainers usually reply within 1 day
-
code-review secondshift
Difficulty 2/5 1-3 hours Newbie friendliness 84/100
piotrekno1/second-shift#419 ·
Maintainers usually reply within 1 day
-
area:compiler effort:S impact:low platform:wasm type:chore
Difficulty 1/5 Under an hour Newbie friendliness 85/100
Maintainers usually reply within 1 day
-
Difficulty 2/5 1-3 hours Newbie friendliness 68/100
PolicyEngine/cliff-watch#55 ·
Maintainers usually reply within 2 days