CreatePackageLicenseQuery

Creates a query to fetch merged license data (PackageLicense + PackageLicenseOverride) for a package version from all the namespaces in the namespace chain. This is the primary API for the Edit Dependency UI page. The response combines:

Original licenses/copyrights/notices from PackageLicense (fetched from OSS namespace).
Any overrides from PackageLicenseOverride (fetched from user namespace).
Selection states for each item (defaults to selected if not in selection map).

POST

namespaces

{tenant_meta.namespace}

queries

package-license-queries

CreatePackageLicenseQuery

curl --request POST \
  --url https://api.endorlabs.com/v1/namespaces/{tenant_meta.namespace}/queries/package-license-queries \
  --header 'Content-Type: application/json' \
  --data '
{
  "tenant_meta": {}
}
'

{
  "meta": {
    "name": "<string>",
    "annotations": {},
    "create_time": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "description": "<string>",
    "index_data": {
      "data": [
        "<string>"
      ],
      "search_score": 123,
      "tenant": "<string>",
      "will_be_deleted_at": "2023-11-07T05:31:56Z"
    },
    "kind": "<string>",
    "parent_kind": "<string>",
    "parent_uuid": "<string>",
    "references": {},
    "tags": [
      "<string>"
    ],
    "update_time": "2023-11-07T05:31:56Z",
    "updated_by": "<string>",
    "upsert_time": "2023-11-07T05:31:56Z",
    "version": "<string>"
  },
  "spec": {
    "package_version_uuid": "<string>",
    "applied_overrides": [
      {
        "namespace": "<string>",
        "override_uuid": "<string>"
      }
    ],
    "copyrights": [
      {
        "copyright_text": "<string>",
        "file_locations": [
          {
            "end_byte": 123,
            "end_line": 123,
            "relative_path": "<string>",
            "start_byte": 123,
            "start_line": 123
          }
        ],
        "identifier": "<string>",
        "is_edited": true,
        "resolved_namespace": "<string>",
        "resolved_override_uuid": "<string>",
        "selected": true
      }
    ],
    "licenses": [
      {
        "file_locations": [
          {
            "end_byte": 123,
            "end_line": 123,
            "relative_path": "<string>",
            "start_byte": 123,
            "start_line": 123
          }
        ],
        "identifier": "<string>",
        "is_edited": true,
        "license_text": "<string>",
        "resolved_namespace": "<string>",
        "resolved_override_uuid": "<string>",
        "selected": true,
        "source": "<string>",
        "spdx_expr": "<string>"
      }
    ],
    "notices": [
      {
        "file_locations": [
          {
            "end_byte": 123,
            "end_line": 123,
            "relative_path": "<string>",
            "start_byte": 123,
            "start_line": 123
          }
        ],
        "identifier": "<string>",
        "is_edited": true,
        "notices_text": "<string>",
        "resolved_namespace": "<string>",
        "resolved_override_uuid": "<string>",
        "selected": true
      }
    ],
    "package_license_name": "<string>"
  },
  "tenant_meta": {
    "namespace": "<string>"
  },
  "uuid": "<string>"
}

Path Parameters

tenant_meta.namespace

string

required

Namespaces are a way to organize organizational units into virtual groupings of resources. Namespaces must be a fully qualified name, for example, the child namespace of namespace "endor.prod" called "app" is called "endor.prod.app".

Body

application/json

PackageLicenseQuery represents the merged result of PackageLicense + PackageLicenseOverride. This response combines original license data from PackageLicense with any overrides and selection states from PackageLicenseOverride across all namespaces in the namespace chain, providing a complete view for the UI.

Response

A successful response.

meta

object

Common fields for all Endor Labs resources.

Show child attributes

spec

object

Show child attributes

tenant_meta

object

Tenant related data for the tenant containing the resource.

Show child attributes

uuid

string

read-only

The uuid of the resource.

DeletePackageLicenseOverride

UpdatePackageLicense

⌘I

CreatePackageLicenseQuery

curl --request POST \
  --url https://api.endorlabs.com/v1/namespaces/{tenant_meta.namespace}/queries/package-license-queries \
  --header 'Content-Type: application/json' \
  --data '
{
  "tenant_meta": {}
}
'

{
  "meta": {
    "name": "<string>",
    "annotations": {},
    "create_time": "2023-11-07T05:31:56Z",
    "created_by": "<string>",
    "description": "<string>",
    "index_data": {
      "data": [
        "<string>"
      ],
      "search_score": 123,
      "tenant": "<string>",
      "will_be_deleted_at": "2023-11-07T05:31:56Z"
    },
    "kind": "<string>",
    "parent_kind": "<string>",
    "parent_uuid": "<string>",
    "references": {},
    "tags": [
      "<string>"
    ],
    "update_time": "2023-11-07T05:31:56Z",
    "updated_by": "<string>",
    "upsert_time": "2023-11-07T05:31:56Z",
    "version": "<string>"
  },
  "spec": {
    "package_version_uuid": "<string>",
    "applied_overrides": [
      {
        "namespace": "<string>",
        "override_uuid": "<string>"
      }
    ],
    "copyrights": [
      {
        "copyright_text": "<string>",
        "file_locations": [
          {
            "end_byte": 123,
            "end_line": 123,
            "relative_path": "<string>",
            "start_byte": 123,
            "start_line": 123
          }
        ],
        "identifier": "<string>",
        "is_edited": true,
        "resolved_namespace": "<string>",
        "resolved_override_uuid": "<string>",
        "selected": true
      }
    ],
    "licenses": [
      {
        "file_locations": [
          {
            "end_byte": 123,
            "end_line": 123,
            "relative_path": "<string>",
            "start_byte": 123,
            "start_line": 123
          }
        ],
        "identifier": "<string>",
        "is_edited": true,
        "license_text": "<string>",
        "resolved_namespace": "<string>",
        "resolved_override_uuid": "<string>",
        "selected": true,
        "source": "<string>",
        "spdx_expr": "<string>"
      }
    ],
    "notices": [
      {
        "file_locations": [
          {
            "end_byte": 123,
            "end_line": 123,
            "relative_path": "<string>",
            "start_byte": 123,
            "start_line": 123
          }
        ],
        "identifier": "<string>",
        "is_edited": true,
        "notices_text": "<string>",
        "resolved_namespace": "<string>",
        "resolved_override_uuid": "<string>",
        "selected": true
      }
    ],
    "package_license_name": "<string>"
  },
  "tenant_meta": {
    "namespace": "<string>"
  },
  "uuid": "<string>"
}

Documentation Index

Path Parameters

Body

Response