Sign in
Catalog specification

List catalog specifications

Lists all catalog specifications.

get/metadata/metadata_specification

Query parameters

limitstring

Limits the number of results returned per page.

offsetstring

The starting point for pagination. Defaults to 0 if not provided.

entity'organization' | 'account' | 'namespace' | 'application' | 'build' | 'asset' | 'scope' | 'release' | 'deployment' | 'user'

Parent entity that holds metadata information.

metadatastring

Entity metadata key, for example: coverage, frameworks, vulnerabilities.

nrnstring required

Nullplatform Resource Name (NRN) representing a hierarchical identifier for nullplatform resources.

NRN where the catalog specification is defined.

includestring

Add additional catalog specifications to the response. For example: global.

mergeboolean

Merge catalog specifications using NRN hierarchy.

onlystring

Return only catalog specifications that match the provided entity.

Response

Object representing pagination parameters for controlling the number and order of results

Example response

{
  "results": [
    {
      "id": "134544a6-a089-43ba-9d52-5b6e6e4fa8d1",
      "name": "Namespace tags",
      "description": "Add tags as key-value object to namespace entities",
      "nrn": "organization=1",
      "entity": "namespace",
      "metadata": "tags",
      "schema": {
        "type": "object",
        "properties": {
          "my_string_property": {
            "type": "string",
            "tag": true
          },
          "my_number_property": {
            "type": "number",
            "default": 0,
            "tag": "my_custom_tag_name"
          },
          "my_object_property": {
            "type": "object",
            "properties": {
              "my_nested_property": {
                "type": "string"
              }
            }
          }
        },
        "required": [
          "my_string_property"
        ],
        "additionalProperties": false
      }
    }
  ]
}

Changes

No recorded changes to this endpoint across all 1 revision of this API.