[Documentation]: /upsert docs don't clarify that at least one of version or config is required
Nobody has claimed this yet.
- Dominant language
- JavaScript
- Stars
- 232
- Forks
- 77
- Avg merge
- 3d 6h
- Merged PRs (30d)
- 17
Description
The /upsert documentation (docs/pages/APIs/Configure/Configure_REST_API.md) marks both version and config as optional, but at least one must be provided. If neither is supplied, configJSON is undefined and the request crashes. The docs (and OpenAPI spec at docs/mmgis-openapi.json) should clarify this mutual dependency.
From #333
Contributor 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.
Research direction
Start with docs/pages/APIs/Configure/Configure_REST_API.md and compare the /upsert parameter descriptions with docs/mmgis-openapi.json. Clarify that at least one of version or config is required, including the failure case when neither is supplied. Done when both documentation sources communicate this mutual dependency consistently.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- javascript
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Quiet
- Clarity
- Clearly specified
- Newbie friendliness
- 68/100