Sign in
Catalog specification

Read a catalog specification

Reads a catalog specification for an entity.

get/metadata/metadata_specification/{id}

Path parameters

idstring uuid required

Unique ID for the entity, in UUID format.

Unique ID for the catalog specification.

Response

Object representing a catalog specification for a nullplatform entity

idstring uuid

Unique ID for the entity, in UUID format.

namestring

Catalog specification name, for example: Build Coverage, Application Frameworks, Build Vulnerabilities.

nrnstring

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

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

Parent entity that holds metadata information.

metadatastring nullable

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

descriptionstring

Catalog specification description.

schemaobject

Catalog specification schema. Must be a valid JSON Schema.

Example response

{
  "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.