Chef Software projects API is one of 30 APIs that Chef Software publishes on the APIs.io network, described by a machine-readable OpenAPI specification.
Tagged areas include projects. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and authentication docs.
This API exposes
5 operations
across 2 paths,
and defines 12 schemas.
It is described by OpenAPI 2.0, at version version not set.
Requests are made against the base URL https://automate.chef.io/api/v0.
5 operations2 paths12 schemas1 DELETE2 GET1 POST1 PUT
Metadata
The identity and technical contract details declared by the specification.
Specification
OpenAPI 2.0
API Version
version not set
Base URL
https://automate.chef.io/api/v0
Resource Areas
1
Paths & Operations 5
Across 2 paths, the API surfaces 5 operations — 1 DELETE, 2 GET, 1 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.
projects 5
GET
/apis/iam/v2/projects
Lists all projects
Policies_ListProjects→ 200default
POST
/apis/iam/v2/projects
Creates a project
Policies_CreateProject1 param→ 200default
GET
/apis/iam/v2/projects/{id}
Gets a project
Policies_GetProject1 param→ 200default
DELETE
/apis/iam/v2/projects/{id}
Deletes a project
Policies_DeleteProject1 param→ 200default
PUT
/apis/iam/v2/projects/{id}
Updates a project
Policies_UpdateProject2 params→ 200default
Schemas 12
The contract defines 12 schemas that model the data the API accepts and returns. The most detailed are chef.automate.api.iam.v2.Project (4 properties), grpc.gateway.runtime.Error (4 properties), chef.automate.api.iam.v2.CreateProjectReq (3 properties), chef.automate.api.iam.v2.UpdateProjectReq (2 properties). Each schema is shown below with its type and property counts.
chef.automate.api.iam.v2.CreateProjectReq
object
3 properties2 required
chef.automate.api.iam.v2.ListProjectsResp
object
1 property
chef.automate.api.iam.v2.ProjectRulesStatus
string
chef.automate.api.iam.v2.UpdateProjectReq
object
2 properties2 required
chef.automate.api.iam.v2.Project
object
4 properties
chef.automate.api.iam.v2.UpdateProjectResp
object
1 property
chef.automate.api.iam.v2.Type
string
grpc.gateway.runtime.Error
object
4 properties
google.protobuf.Any
object
Any contains an arbitrary serialized protocol buffer message along with a URL that describes the type of the serialized message. Protobuf library provides supp…
2 properties
chef.automate.api.iam.v2.DeleteProjectResp
object
chef.automate.api.iam.v2.CreateProjectResp
object
1 property
chef.automate.api.iam.v2.GetProjectResp
object
1 property
Specification
The full machine-readable OpenAPI contract behind this narrative.
