For the complete documentation index, see llms.txt.
Skip to main content
Version: 8.11 (unreleased)

Ingest catalog assets

PUT 
/catalog/assets/ingestion

Ingests the full set of catalog assets.

For each asset, the actual element template JSON file as well as an accompanying README file must be provided. The README should provide a description of the asset and can use Markdown syntax. It must contain a YAML frontmatter section with a template field that references the element template by its file name. Optionally, the frontmatter can specify a category and a list of tags that can be used to search and filter assets in the catalog.

---
template: banking-system-connector.json
category: Finance
tags:
  - invoice
  - payment
  - transaction
---
## Description
...

## Usage
...

The files must be provided as multipart/form-data with the named parts readme and template (the part name is the same for each file of the respective type).

The optional source form field identifies the catalog source the assets are ingested from. Only assets of the ingested source are unpublished when they are missing from the payload; assets of other sources stay untouched. If a submitted element template ID already exists in a different source, the asset is adopted: its source is updated to the ingested source and it is (re)published there. This is the hand-over path when a source is renamed or a mono-repo is split into multiple repositories — the last successful ingestion wins. Requests without a source match the default bucket of assets that were ingested without a source.

Previously ingested assets of the ingested source that are not included in the request payload will be marked as unpublished in the catalog. Unpublished assets are only accessible to administrators; regular modeling users cannot use them for new diagram elements anymore. Existing diagrams using assets that get unpublished will continue to work as before.

Re-ingesting an unpublished asset with an unchanged template at its latest version does not require a version bump: the stored content is updated from the submission, including its deprecation flag. Deprecation is lifecycle metadata that follows the latest ingestion while an asset is unpublished. Changing a published asset — including only its deprecation flag — requires a higher template version.

Request​

Responses​

The catalog assets were ingested successfully.