Chef Software projects API

openapi: 3.2.0
info:
  title: external/applications/applications.proto ApplicationsService Projects API
  version: version not set
servers:
- url: https://automate.chef.io/api/v0
tags:
- name: projects
paths:
  /apis/iam/v2/projects:
    get:
      summary: Lists all projects
      description: 'Lists all projects.


        Authorization Action:

        ```

        iam:projects:list

        ```'
      operationId: Policies_ListProjects
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/chef.automate.api.iam.v2.ListProjectsResp'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/grpc.gateway.runtime.Error'
      tags:
      - projects
    post:
      summary: Creates a project
      description: 'Creates a new project to be used in the policies that control permissions in Automate.


        A project defines the scope of resources in a policy statement. Resources can be in more than one project.


        When a project is created, the system also creates three policies associated with the new project,

        one for each of the following roles: editor, viewer, and project owner.

        You can optionally pass the `skip_policies` flag set to `true` to skip the creation of these policies.


        Authorization Action:

        ```

        iam:projects:create

        ```'
      operationId: Policies_CreateProject
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/chef.automate.api.iam.v2.CreateProjectResp'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/grpc.gateway.runtime.Error'
      tags:
      - projects
      x-code-samples:
      - lang: JSON
        source: '{"name": "My Custom Project", "id": "custom-project", "skip_policies": true}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/chef.automate.api.iam.v2.CreateProjectReq'
        required: true
  /apis/iam/v2/projects/{id}:
    get:
      summary: Gets a project
      description: 'Returns the details for a project.


        Authorization Action:

        ```

        iam:projects:get

        ```'
      operationId: Policies_GetProject
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/chef.automate.api.iam.v2.GetProjectResp'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/grpc.gateway.runtime.Error'
      parameters:
      - name: id
        description: ID of the project.
        in: path
        required: true
        schema:
          type: string
      tags:
      - projects
    delete:
      summary: Deletes a project
      description: 'Deletes a project from any resources tagged with it.


        Also deletes this project from any project list in any policy statements.

        If the resulting project list for a given statement is empty, it is deleted.

        If the resulting policy has no statements, it is also deleted.


        Authorization Action:

        ```

        iam:projects:delete

        ```'
      operationId: Policies_DeleteProject
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/chef.automate.api.iam.v2.DeleteProjectResp'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/grpc.gateway.runtime.Error'
      parameters:
      - name: id
        description: ID of the project.
        in: path
        required: true
        schema:
          type: string
      tags:
      - projects
    put:
      summary: Updates a project
      description: 'Updates the name of an existing project.


        Authorization Action:

        ```

        iam:projects:update

        ```'
      operationId: Policies_UpdateProject
      responses:
        '200':
          description: A successful response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/chef.automate.api.iam.v2.UpdateProjectResp'
        default:
          description: An unexpected error response.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/grpc.gateway.runtime.Error'
      parameters:
      - name: id
        description: Unique ID. Cannot be changed.
        in: path
        required: true
        schema:
          type: string
      tags:
      - projects
      x-code-samples:
      - lang: JSON
        source: '{"name": "My Custom Updated Project Name"}'
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/chef.automate.api.iam.v2.UpdateProjectReq'
        required: true
components:
  schemas:
    chef.automate.api.iam.v2.CreateProjectReq:
      type: object
      example:
        name: My Custom Project
        id: custom-project
        skip_policies: true
      properties:
        id:
          type: string
          description: Unique ID. Cannot be changed.
        name:
          type: string
          description: Name for the new project.
        skip_policies:
          type: boolean
          description: Boolean flag to skip adding policies associated with the project. Set to false by default.
      required:
      - id
      - name
    chef.automate.api.iam.v2.UpdateProjectResp:
      type: object
      example:
        name: My Custom Project
        id: custom-project
      properties:
        project:
          $ref: '#/components/schemas/chef.automate.api.iam.v2.Project'
    chef.automate.api.iam.v2.ListProjectsResp:
      type: object
      example:
        projects:
        - name: My Custom Project
          id: custom-project
        - name: My Custom Project 2
          id: custom-project-2
      properties:
        projects:
          type: array
          items:
            $ref: '#/components/schemas/chef.automate.api.iam.v2.Project'
    chef.automate.api.iam.v2.CreateProjectResp:
      type: object
      example:
        name: My Custom Project
        id: custom-project
      properties:
        project:
          $ref: '#/components/schemas/chef.automate.api.iam.v2.Project'
    chef.automate.api.iam.v2.Project:
      type: object
      properties:
        name:
          type: string
          description: Name for the project.
        id:
          type: string
          description: Unique ID. Cannot be changed.
        type:
          $ref: '#/components/schemas/chef.automate.api.iam.v2.Type'
          description: Whether this policy is user created (`CUSTOM`) or chef managed (`CHEF_MANAGED`).
        status:
          $ref: '#/components/schemas/chef.automate.api.iam.v2.ProjectRulesStatus'
          description: The current status of the rules for this project.
    chef.automate.api.iam.v2.ProjectRulesStatus:
      type: string
      enum:
      - PROJECT_RULES_STATUS_UNSET
      - RULES_APPLIED
      - EDITS_PENDING
      - NO_RULES
      default: PROJECT_RULES_STATUS_UNSET
    google.protobuf.Any:
      type: object
      properties:
        type_url:
          type: string
          description: "A URL/resource name that uniquely identifies the type of the serialized\nprotocol buffer message. This string must contain at least\none \"/\" character. The last segment of the URL's path must represent\nthe fully qualified name of the type (as in\n`path/google.protobuf.Duration`). The name should be in a canonical form\n(e.g., leading \".\" is not accepted).\n\nIn practice, teams usually precompile into the binary all types that they\nexpect it to use in the context of Any. However, for URLs which use the\nscheme `http`, `https`, or no scheme, one can optionally set up a type\nserver that maps type URLs to message definitions as follows:\n\n* If no scheme is provided, `https` is assumed.\n* An HTTP GET on the URL must yield a [google.protobuf.Type][]\n  value in binary format, or produce an error.\n* Applications are allowed to cache lookup results based on the\n  URL, or have them precompiled into a binary to avoid any\n  lookup. Therefore, binary compatibility needs to be preserved\n  on changes to types. (Use versioned type names to manage\n  breaking changes.)\n\nNote: this functionality is not currently available in the official\nprotobuf release, and it is not used for type URLs beginning with\ntype.googleapis.com.\n\nSchemes other than `http`, `https` (or the empty scheme) might be\nused with implementation specific semantics."
        value:
          type: string
          format: byte
          description: Must be a valid serialized protocol buffer of the above specified type.
      description: "`Any` contains an arbitrary serialized protocol buffer message along with a\nURL that describes the type of the serialized message.\n\nProtobuf library provides support to pack/unpack Any values in the form\nof utility functions or additional generated methods of the Any type.\n\nExample 1: Pack and unpack a message in C++.\n\n    Foo foo = ...;\n    Any any;\n    any.PackFrom(foo);\n    ...\n    if (any.UnpackTo(&foo)) {\n      ...\n    }\n\nExample 2: Pack and unpack a message in Java.\n\n    Foo foo = ...;\n    Any any = Any.pack(foo);\n    ...\n    if (any.is(Foo.class)) {\n      foo = any.unpack(Foo.class);\n    }\n\n Example 3: Pack and unpack a message in Python.\n\n    foo = Foo(...)\n    any = Any()\n    any.Pack(foo)\n    ...\n    if any.Is(Foo.DESCRIPTOR):\n      any.Unpack(foo)\n      ...\n\n Example 4: Pack and unpack a message in Go\n\n     foo := &pb.Foo{...}\n     any, err := anypb.New(foo)\n     if err != nil {\n       ...\n     }\n     ...\n     foo := &pb.Foo{}\n     if err := any.UnmarshalTo(foo); err != nil {\n       ...\n     }\n\nThe pack methods provided by protobuf library will by default use\n'type.googleapis.com/full.type.name' as the type URL and the unpack\nmethods only use the fully qualified type name after the last '/'\nin the type URL, for example \"foo.bar.com/x/y.z\" will yield type\nname \"y.z\".\n\n\nJSON\n====\nThe JSON representation of an `Any` value uses the regular\nrepresentation of the deserialized, embedded message, with an\nadditional field `@type` which contains the type URL. Example:\n\n    package google.profile;\n    message Person {\n      string first_name = 1;\n      string last_name = 2;\n    }\n\n    {\n      \"@type\": \"type.googleapis.com/google.profile.Person\",\n      \"firstName\": <string>,\n      \"lastName\": <string>\n    }\n\nIf the embedded message type is well-known and has a custom JSON\nrepresentation, that representation will be embedded adding a field\n`value` which holds the custom JSON in addition to the `@type`\nfield. Example (for message [google.protobuf.Duration][]):\n\n    {\n      \"@type\": \"type.googleapis.com/google.protobuf.Duration\",\n      \"value\": \"1.212s\"\n    }"
    chef.automate.api.iam.v2.DeleteProjectResp:
      type: object
      example:
        name: My Custom Project
        id: custom-project
    chef.automate.api.iam.v2.UpdateProjectReq:
      type: object
      example:
        name: My Custom Project
      properties:
        id:
          type: string
          description: Unique ID. Cannot be changed.
        name:
          type: string
          description: Name for the project.
      required:
      - id
      - name
    grpc.gateway.runtime.Error:
      type: object
      properties:
        error:
          type: string
        code:
          type: integer
          format: int32
        message:
          type: string
        details:
          type: array
          items:
            $ref: '#/components/schemas/google.protobuf.Any'
    chef.automate.api.iam.v2.GetProjectResp:
      type: object
      example:
        name: My Custom Project
        id: custom-project
      properties:
        project:
          $ref: '#/components/schemas/chef.automate.api.iam.v2.Project'
    chef.automate.api.iam.v2.Type:
      type: string
      enum:
      - CHEF_MANAGED
      - CUSTOM
      default: CHEF_MANAGED