swagger: '2.0' info: title: external/applications/applications.proto ApplicationsService hidden API version: version not set consumes: - application/json produces: - application/json tags: - name: hidden paths: /api/v0/applications/version: get: summary: Show Version description: 'Displays the current version of the applications-service Authorization Action: ``` system:serviceVersion:get ```' operationId: ApplicationsService_GetVersion responses: '200': description: A successful response. schema: $ref: '#/definitions/chef.automate.api.common.version.VersionInfo' default: description: An unexpected error response. schema: $ref: '#/definitions/grpc.gateway.runtime.Error' tags: - hidden /api/v0/cfgmgmt/version: get: operationId: ConfigMgmt_GetVersion responses: '200': description: A successful response. schema: $ref: '#/definitions/chef.automate.api.common.version.VersionInfo' default: description: An unexpected error response. schema: $ref: '#/definitions/grpc.gateway.runtime.Error' tags: - hidden /api/v0/compliance/reporting/version: get: operationId: ReportingService_GetVersion responses: '200': description: A successful response. schema: $ref: '#/definitions/chef.automate.api.common.version.VersionInfo' default: description: An unexpected error response. schema: $ref: '#/definitions/grpc.gateway.runtime.Error' tags: - hidden /api/v0/eventexport: get: operationId: EventFeedService_EventExport responses: '200': description: A successful response.(streaming responses) schema: type: object properties: result: $ref: '#/definitions/chef.automate.api.event_feed.response.EventExportResponse' error: $ref: '#/definitions/grpc.gateway.runtime.StreamError' title: Stream result of chef.automate.api.event_feed.response.EventExportResponse default: description: An unexpected error response. schema: $ref: '#/definitions/grpc.gateway.runtime.Error' parameters: - name: output_type description: JSON or CSV. in: query required: false type: string - name: filter description: Filters to be applied to the request. in: query required: false type: array items: type: string collectionFormat: multi - name: start description: Earliest events to return. in: query required: false type: string format: int64 - name: end description: Latest events to return. in: query required: false type: string format: int64 - name: order description: Order the results should be returned in. in: query required: false type: string enum: - ASC - DESC default: ASC tags: - hidden /apis/iam/v2/introspect_projects: get: operationId: Policies_IntrospectAllProjects responses: '200': description: A successful response. schema: $ref: '#/definitions/chef.automate.api.iam.v2.ListProjectsResp' default: description: An unexpected error response. schema: $ref: '#/definitions/grpc.gateway.runtime.Error' tags: - hidden definitions: 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: '#/definitions/chef.automate.api.iam.v2.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 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: '#/definitions/chef.automate.api.iam.v2.Type' description: Whether this policy is user created (`CUSTOM`) or chef managed (`CHEF_MANAGED`). status: $ref: '#/definitions/chef.automate.api.iam.v2.ProjectRulesStatus' description: The current status of the rules for this project. 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\": ,\n \"lastName\": \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 }" grpc.gateway.runtime.Error: type: object properties: error: type: string code: type: integer format: int32 message: type: string details: type: array items: $ref: '#/definitions/google.protobuf.Any' chef.automate.api.iam.v2.Type: type: string enum: - CHEF_MANAGED - CUSTOM default: CHEF_MANAGED grpc.gateway.runtime.StreamError: type: object properties: grpc_code: type: integer format: int32 http_code: type: integer format: int32 message: type: string http_status: type: string details: type: array items: $ref: '#/definitions/google.protobuf.Any' chef.automate.api.common.version.VersionInfo: type: object properties: name: type: string version: type: string sha: type: string built: type: string chef.automate.api.event_feed.response.EventExportResponse: type: object properties: content: type: string format: byte description: Exported reports in JSON or CSV.