v1

latestOpenAPI 3.1.02026-07-24239123562.1 KB

schemas

Get a single schemas artifact

Returns a single schemas artifact matching the namespace, slug, and version

get/v1/artifacts/schemas/{namespace}/{slug}/{version}

Path parameters

namespacestring required

Artifact namespace. Should be common, private-, or client-

slugstring required

Artifact slug

versionstring required

Artifact version

Query parameters

include_prereleasesboolean

Include prerelease artifacts in search

Response

Successfully fetched SchemaObject

namespacestring required

slugstring required

versionstring required

namestring nullable

descriptionstring nullable

createdAtstring date-time required

lastUpdatedAtstring date-time required

otherVersionsstring[]

type'schema' required

Example response

{
  "type": "schema",
  "namespace": "private-test",
  "slug": "tabular",
  "version": "v0.5.0",
  "createdAt": "2024-04-25T15:15:34.269Z",
  "lastUpdatedAt": "2023-04-25T17:15:34.269Z",
  "name": "Tabular schema",
  "description": "A tabular schema",
  "otherVersions": [
    "v0.1.0",
    "v0.5.0"
  ]
}