Jump to

• Request
• Response

Get a project inclusions report

get

https://{your_site_interface}/opa-hub/api/12.2.36/projects/{project-name}/inclusions-report

This operation will get a project inclusions report as a JSON array. To receive the report as CSV data, send an HTTP Accept header of "Accept: text/csv".

Request

Path Parameters

• project-name(required): string
  The name of the project.

Query Parameters

• expand: string
  Comma separated list of named resources to expand, or "all" to expand all
• fields: string
  Comma separated list of fields to be returned
• links: string
  Comma separated list of links to be returned, or "none" to omit links

There's no request body for this operation.

Security

• Authorization: apiKey
  Type: apiKey

  Description: Obtain a bearer token from https://{your_site_interface}/opa-hub/api/12.2.17/auth and use it in the Authorization header as: Bearer {token}.
• oauth2_opa: oauth2
  Type: oauth2

  Description: POST the OAuth2 Client Credentials parameters to https://{your_site_interface}/opa-hub/api/12.2.17/auth and use the access token from the response in the Authorization header.

Back to Top

Response

Supported Media Types

• application/json
• text/csv

200 Response

The request was successfully completed.

Body ()

Root Schema : projectInclusionsReport

Type: object

Show Source

• inclusions: array inclusions
  Read Only: true

  Contains a flat array of all the project names and versions included by this project.

{
    "type":"object",
    "properties":{
        "inclusions":{
            "type":"array",
            "description":"Contains a flat array of all the project names and versions included by this project.",
            "readOnly":true,
            "items":{
                "description":"An inclusion for a project.",
                "$ref":"#/components/schemas/projectInclusionsReportInclusion"
            }
        }
    },
    "additionalProperties":false
}

Nested Schema : inclusions

Type: array

Read Only: true

Contains a flat array of all the project names and versions included by this project.

Show Source

• Array of: object projectInclusionsReportInclusion

{
    "type":"array",
    "description":"Contains a flat array of all the project names and versions included by this project.",
    "readOnly":true,
    "items":{
        "description":"An inclusion for a project.",
        "$ref":"#/components/schemas/projectInclusionsReportInclusion"
    }
}

Nested Schema : projectInclusionsReportInclusion

Type: object

Show Source

• inclusionLatestVersion: integer (int64)
  The latest version of the included project.
• inclusionName(required): string
  The name of the included project.
• inclusionVersion(required): integer (int64)
  The version of the included project.
• projectName(required): string
  The name of the including project.
• projectVersion(required): integer (int64)
  The version of the including project.
• upToDateFlag(required): boolean
  A flag indicating whether the included project is the latest version.

{
    "type":"object",
    "properties":{
        "projectName":{
            "type":"string",
            "description":"The name of the including project."
        },
        "projectVersion":{
            "type":"integer",
            "format":"int64",
            "description":"The version of the including project."
        },
        "inclusionName":{
            "type":"string",
            "description":"The name of the included project."
        },
        "inclusionVersion":{
            "type":"integer",
            "format":"int64",
            "description":"The version of the included project."
        },
        "inclusionLatestVersion":{
            "type":"integer",
            "format":"int64",
            "description":"The latest version of the included project."
        },
        "upToDateFlag":{
            "type":"boolean",
            "description":"A flag indicating whether the included project is the latest version."
        }
    },
    "additionalProperties":false,
    "required":[
        "inclusionVersion",
        "upToDateFlag",
        "projectName",
        "projectVersion",
        "inclusionName"
    ]
}

Back to Top