Skip to content

/v1/catalog-imports/format

GET
/v1/catalog-imports/format
curl --request GET \
--url https://api.emely.io/v1/catalog-imports/format \
--header 'Authorization: Bearer <token>'

The emely-catalog-import format: its JSON Schema, the sha256 the dry run pins on every plan, the upload limits, the mapper guidance and the 23 reference vocabularies the document must draw its enumerated values from. Requires an api_operator token.

The import format contract and live vocabularies

Media typeapplication/json
object
formatVersion
required
integer
schemaSha256
required
string
jsonSchema
required
object
key
additional properties
vocabularies
required
object
key
additional properties
Array<object>
object
key
additional properties
limits
required
object
partBytes
required
integer
documentBytes
required
integer
documentItems
required
integer
guidance
required
string
Examplegenerated
{
"formatVersion": 1,
"schemaSha256": "example",
"jsonSchema": {
"additionalProperty": "example"
},
"vocabularies": {
"additionalProperty": [
{
"additionalProperty": "example"
}
]
},
"limits": {
"partBytes": 1,
"documentBytes": 1,
"documentItems": 1
},
"guidance": "example"
}

Missing or invalid bearer token

Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
integer
detail
string
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example"
}

Token role refused for this route

Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
integer
detail
string
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example"
}

Upstream error

Media typeapplication/problem+json
object
type
required
string
title
required
string
status
required
integer
detail
string
Examplegenerated
{
"type": "example",
"title": "example",
"status": 1,
"detail": "example"
}