chef-boneyard / chef-web-docs-2016

DEPRECATED - All The Documentation
Other
74 stars 149 forks source link

chef-server policy endpoints aren't documented #563

Closed pburkholder closed 9 years ago

pburkholder commented 9 years ago

@danielsdeleo may need to help with this, but https://docs.chef.io/api_chef_server.html doesn't have documentation on the /policy_group and other policyfile endpoints.

Thanks,

Peter

danielsdeleo commented 9 years ago

I can either write something up in here or update the RAML in the server repo. Preference?

jamescott commented 9 years ago

Update the RAML in the server repo, send me the URL for it when finished. I will probably add something to the chef-docs API pages so they are doc'd until the new RAML-based pages are ready.

mmzyk commented 9 years ago

@tylercloke has recently updated all the RAML docs I believe @danielsdeleo, so probably want to check with him on the state of it and what's there now, so you don't accidentally update something that might be old.

jamescott commented 9 years ago

yeah, @tylercloke sent me the info he's got. I'm gonna make an update to the docs to placeholder this for the near term until the RAML API docs are ready.

danielsdeleo commented 9 years ago

@jamescott @tylercloke The policies stuff is old and the APIs have been substantially revised since then. I'll try to get you an update today. Until then, the best place to look is at the pedant tests: https://github.com/chef/chef-server/blob/master/oc-chef-pedant/spec/api/policies/complete_endpoint_spec.rb These are a lot less factored than other pedant tests so they should be more readable.

pburkholder commented 9 years ago

Hmm: https://docs.chef.io/api_chef_server.html still doesn't have the endpoints documented. Reopening.

danielsdeleo commented 9 years ago

I guess github got overzealous with the ticket linkage. But anyway, the RAML docs are good now so it's ready for the @jamescott treatment

jamescott commented 9 years ago

Updated release notes for Chef Server 12.1: http://docs.chef.io/release/server_12-1/release_notes.html

And also the root Chef Server API doc: http://docs.chef.io/api_chef_server.html

We'll have to keep working toward the full RAML solution, but this update gets things published for 12.1.