Association requests POST documentation inaccurate
Open
Nobody has claimed this yet.
Aspect: Documentation
Triage: Confirmed
Type: Bug
- Dominant language
- Erlang
- Stars
- 303
- Forks
- 211
- Avg merge
- 1d 8h
- Merged PRs (30d)
- 5
Description
Chef Server Version
12.13.0-1
Platform Details
debian jessie
Configuration
standalone
Scenario:
When creating an association request using the API documentation, I found that a request body is required, but the documentation does not mention it:
https://docs.chef.io/api_chef_server.html#id16
The required json is {"user": <username>}
Expected Result:
Just an update to the documentation
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
Open the API documentation at https://docs.chef.io/api_chef_server.html#id16 and compare the association request POST instructions with the reported request body. Update that section to state that the JSON body {"user": } is required; done when the documented request accurately describes the endpoint.
Written by the indexing model from the issue text.
Assessment
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 1/5
- Estimated time
- Under an hour
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 45/100