chef / chef/chef-server

PUT /users/<username>/association_requests/<request_id> undocumented

Open
#1,603 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Status: Good First Issue Triage: Confirmed
Dominant language
Erlang
Stars
303
Forks
211
Avg merge
1d 8h
Merged PRs (30d)
5

Description

Describe the Enhancement:

This is a question / potential request for enhancement. The chef server API docs list endpoints for interaction with /association_requests, but completing the quest for a user is not documented. Is this on purpose? I've created a service to do this and had to use verbose output from chef-server-ctl and read some of the tests to figure out how to do it myself, but it seems like it could be easily documented if that's a desire for the project. I would also be interested in knowing if this is undocumented on purpose and I should not rely on this endpoint between releases.

Current Alternative

As mentioned above, executing chef-server-ctl commands in verbose mode and figuring out request bodies from the specs.

Can We Help You Implement This?:

A link or suggestion on how to add this to the documentation, if that's desired.

Contributor guide

Open the contributing guide

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.

Research direction

Start with the existing Chef Server API documentation for /association_requests, then use the verbose chef-server-ctl output and the association request specs mentioned in the issue to confirm the PUT request body. Document PUT /users//association_requests/<request_id> and state whether clients may rely on it between releases.

Written by the indexing model from the issue text.

Assessment

Domain
api, documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.