search

chef / chef-server

Chef Infra Server is a hub for configuration data; storing cookbooks, node policies and metadata of managed nodes.
https://www.chef.io/chef/
Apache License 2.0
289 stars 209 forks source link

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

Open stuartnelson3 opened 5 years ago

stuartnelson3 commented 5 years ago

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.

markan commented 5 years ago

I'd look at src/oc_erchef/raml-docs for our current 'most authoritative' docs. If I understand you correctly, the 'accept' of an invite is what you are looking for. That's documented here: src/oc_erchef/raml-docs/users/association_requests.yaml. Any PR's improving the documentation or chef-server-ctl would be quite welcome.