swagger: '2.0' info: title: external/applications/applications.proto ApplicationsService Comp_Assets API version: version not set consumes: - application/json produces: - application/json tags: - name: Comp_Assets paths: /api/v0/compliance/reporting/assets/config: put: summary: Set Unreachable Assets Config description: 'SetAssetConfig sets the compliance config with the parameters of no of days And API returns the policy name and no of the days which will set in the compliance data base Authorization Action: ``` compliance:reports:update ```' operationId: ReportingService_SetAssetConfig responses: '200': description: A successful response. schema: $ref: '#/definitions/chef.automate.api.compliance.reporting.v1.ComplianceConfigResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/grpc.gateway.runtime.Error' parameters: - name: body in: body required: true schema: $ref: '#/definitions/chef.automate.api.compliance.reporting.v1.ComplianceConfigRequest' tags: - Comp_Assets /api/v0/compliance/reporting/assets/config/search: get: summary: Get Assets Config description: "GetAssetConfig gets the config details from the compliance data base \nand API return the policy name and no of days\nAuthorization Action:\n```\ncompliance:reports:get\n```" operationId: ReportingService_GetAssetConfig responses: '200': description: A successful response. schema: $ref: '#/definitions/chef.automate.api.compliance.reporting.v1.ComplianceConfigResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/grpc.gateway.runtime.Error' tags: - Comp_Assets /api/v0/compliance/reporting/assets/count: post: summary: Assets Count description: 'Count the compliance assets based on different filter options. The API returns the response based on reported and unreported assets Authorization Action: ``` compliance:reports:list ```' operationId: ReportingService_AssetCount responses: '200': description: A successful response. schema: $ref: '#/definitions/chef.automate.api.compliance.reporting.v1.AssetSummary' default: description: An unexpected error response. schema: $ref: '#/definitions/grpc.gateway.runtime.Error' parameters: - name: body in: body required: true schema: $ref: '#/definitions/chef.automate.api.compliance.reporting.v1.ListFilters' tags: - Comp_Assets /api/v0/compliance/reporting/assets/search: post: summary: List Assets description: 'Lists the compliance assets based on different filter options. The API works with filtering assets based on collected, uncollected, unreported and unreachable assets Authorization Action: ``` compliance:reports:list ```' operationId: ReportingService_ListAsset responses: '200': description: A successful response. schema: $ref: '#/definitions/chef.automate.api.compliance.reporting.v1.AssetListResponse' default: description: An unexpected error response. schema: $ref: '#/definitions/grpc.gateway.runtime.Error' parameters: - name: body in: body required: true schema: $ref: '#/definitions/chef.automate.api.compliance.reporting.v1.AssetListRequest' tags: - Comp_Assets definitions: chef.automate.api.compliance.reporting.v1.Assets: type: object properties: node_uuid: type: string title: Node UUid for the asset status: type: string title: Status of the last run of the asset first_run: type: string title: First Run details of asset last_run: type: string title: Last run details of asset chef.automate.api.compliance.reporting.v1.AssetSummary: type: object properties: total_assets: type: integer format: int32 title: Total number of total assets collected: $ref: '#/definitions/chef.automate.api.compliance.reporting.v1.Collected' title: Accessing the collected from Collected Message uncollected: $ref: '#/definitions/chef.automate.api.compliance.reporting.v1.Uncollected' title: Total number of not collected assests chef.automate.api.compliance.reporting.v1.AssetListResponse: type: object properties: assets: type: array items: $ref: '#/definitions/chef.automate.api.compliance.reporting.v1.Assets' title: Assets list as per the filters applied chef.automate.api.compliance.reporting.v1.ListFilters: type: object properties: filters: type: array items: $ref: '#/definitions/chef.automate.api.compliance.reporting.v1.ListFilter' 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 }" chef.automate.api.compliance.reporting.v1.AssetListRequest: type: object properties: filters: type: array items: $ref: '#/definitions/chef.automate.api.compliance.reporting.v1.ListFilter' title: List of the filters to be applied size: type: integer format: int32 title: Size of the asset list from: type: integer format: int32 description: The offset for paginating requests. An offset defines a place in the results in order to show the next page of the results. sort: type: string title: Sort required from the which field assets_type: type: string title: Asset Type as collected, unreported, unreachable, uncollected 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.compliance.reporting.v1.Collected: type: object properties: passed: type: integer format: int32 title: Total collected and passsed in the assets failed: type: integer format: int32 title: Total collected and failed in the assets skipped: type: integer format: int32 title: Total collected and skipped in the assets waived: type: integer format: int32 title: Total collected and waived in the assets chef.automate.api.compliance.reporting.v1.ComplianceConfigResponse: type: object properties: policy_name: type: string title: Policy name to get from config value: type: integer format: int32 title: No of days to get for config title: ComplianceConfigResponse to get the policy name and no of days chef.automate.api.compliance.reporting.v1.ListFilter: type: object properties: values: type: array items: type: string description: Filters applied to the list. type: type: string description: The field to filter on. chef.automate.api.compliance.reporting.v1.ComplianceConfigRequest: type: object properties: value: type: integer format: int32 title: No of days for the config title: ComplianceConfigRequest to update no of days in the config chef.automate.api.compliance.reporting.v1.Uncollected: type: object properties: unreachable: type: integer format: int32 title: Total count of unreachable assets unreported: type: integer format: int32 title: Total count of unreported assets