Skip to main content

List Catalogue

GET 
/api/v1/sources/catalogue

List the sources the installed dfe-schemas catalogue ships ready to create.

tags keeps an entry whose holding directory is one of the names given. untagged is a file that sits in the catalogue root, and omitting tags lists every entry. engine keeps an entry whose transform engine is that one, without regard to case, and an engine no entry uses lists nothing. An entry already stored as a source is left out unless include_stored is set, matched on the catalogue entry name even when the source was given a different one. A source written by hand does not hide an entry. Each entry says whether the deployed transform ships its default variant, read off that app's mounted contract, so a console can hold back an entry the create would refuse. It also says whether this deployment can run the entry at all: a source that needs a per-source app (a fetcher or a transform) is refused on a gRPC deployment.

Request​

Responses​

Successful Response