search

chef / automate

Chef Automate provides a full suite of enterprise capabilities for maintaining continuous visibility into application, infrastructure, and security automation.
https://automate.chef.io/
Apache License 2.0
227 stars 113 forks source link

add endpoint details for api docs #2756

Open vjeffrey opened 4 years ago

vjeffrey commented 4 years ago

User Story

for the endpoints we've already written up, let's get some general api details in. to do this, we need to add descriptions to the 03-tags swagger json file, like:

"tags": [
    { "name": "ReportingService", "x-displayName": "Reporting" },
    { "name": "StatsService", "x-displayName": "Stats" },
    { "name": "ConfigMgmt", "x-displayName": "Nodes" },
    { "name": "NodesService", "x-displayName": "Nodes" },
    { "name": "service_groups", "x-displayName": "Services and Service Groups"},
    { "name": "retention", "x-displayName": "Service Management",
      "description": "Lorem ipsum dolor sit amet, consectetur adipiscing elit, sed do eiusmod tempor incididunt ut labore et dolore magna aliqua. Ut enim ad minim veniam, quis nostrud exercitation ullamco laboris nisi ut aliquip ex ea commodo consequat. Duis aute irure dolor in reprehenderit in voluptate velit esse cillum dolore eu fugiat nulla pariatur. Excepteur sint occaecat cupidatat non proident, sunt in culpa qui officia deserunt mollit anim id est laborum." },
    { "name": "tokens", "x-displayName": "IAM Tokens",
      "description": "Use Chef Automate tokens to do the thing."}
  ]

Definition of Done

apis have descriptions

susanev commented 4 years ago

i believe we have short descriptions on some of the associated ui pages. it would be cool to align with those, or if those need to change to also update those in the ui so stuff aligns. let me know if we need more of them.. i can list them all.

reporting
Compliance reports describe the status of scanned infrastructure.
config management
Nodes connected to Chef Automate by way of chef-client.
service groups
Service groups are Habitat services ordered by package identifiers and configurations.
retention
Manage the retention of events, service groups, Chef Client runs, compliance reports and scans in Chef Automate.
api tokens
API tokens grant authorized access to the Chef Automate API.
susanev commented 4 years ago

@chef/docs-team @vjeffrey has this work been done already?

vjeffrey commented 4 years ago

adding to the board; not complete yet