RFC 67 is not documented
Nobody has claimed this yet.
- Dominant language
- HTML
- Stars
- 143
- Forks
- 438
- Avg merge
- 1d 10h
- Merged PRs (30d)
- 16
Description
User Story
As a Developer, I will use this work when I want to use the Chef Server API.
Description
Since Chef Server 12.18.14, the API for /cookbooks/NAME/version has changed but has not been documented.
https://github.com/chef/chef-server/pull/1034
https://github.com/chef-boneyard/chef-rfc/blob/master/rfc067-cookbook-segment-deprecation.md
Chef Version
Chef Server 12.18.14+
Platform Version
CentOS 7
Definition of Done
The changes to the API are documented.
Demo Script / Repro Steps
The documentation of missing from the Chef Server API page.
On the Chef Server API page, the X-Ops-Server-API-Version: 2 is not referenced at all.
The section for /cookbooks/NAME/version has no reference to the new response format.
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 the Chef Server API page linked in the issue, then read RFC 67 and the referenced Chef Server pull request. Document the X-Ops-Server-API-Version: 2 header and the changed response format for /cookbooks/NAME/version. Done means the missing API changes are covered on that page.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- html
- Domain
- api, documentation
- Issue type
- Documentation
- Difficulty
- 2/5
- Estimated time
- 1-3 hours
- Activity status
- Stale
- Clarity
- Clearly specified
- Newbie friendliness
- 48/100