Skip to main content
GET
A version's context envelope

Authorizations

Authorization
string
header
required

The access token received from the authorization server in the OAuth 2.0 flow.

Path Parameters

name
string
required

The API's name.

Pattern: ^[a-z][a-z0-9_]{1,62}$
version
string
required

'v', or 'draft' (owner only).

Pattern: ^(v\d{1,6}|draft)$

Query Parameters

format
string | null
Pattern: ^(json|markdown|odcs)$

Response

Successful Response

Everything a consumer needs to use a version correctly.

api
string
required
title
string
required
description
string
required
version
integer
required
status
enum<string>
required

A version's lifecycle. Only draft can be edited.

Available options:
draft,
published,
retired
context_hash
string
required
endpoint
string
required
source
string
required
grain
string
required
columns
EnvelopeColumn · object[]
required
default_sort
string[]
required
default_page_size
integer
required
max_page_size
integer
required
examples
ContractExample · object[]
required
pinned
PinnedContext · object
required

What DataHub said about the source when the version was published.

Also the API's title and description at publish, so a later rename doesn't change what a published version says about itself.

live
LiveContext · object
required

Resolved per request (briefly cached).

pack
PackContext · object | null
notes
string[]