Interface APIMetadata

API Metadata object is used to describe both APIDataset and APIDataObject.

interface APIMetadata {
    description: String;
    documentation: String;
    fields: { [key: string]: MetadataField };
    layout: UILayout;
    name: String;
    navigation?: object;
    urls: MetadataUrls;
}

Index

Properties

description documentation fields layout name navigation? urls

Properties

description

description: String

Description on the view.

documentation

documentation: String

Link to the objects documentation.

fields

fields: { [key: string]: MetadataField }

Field definitions describing the APIDataObject

layout

layout: UILayout

What layout the API APIDataObject will use

name

name: String

Name of the view.

`Optional`navigation

navigation?: object

Navigation structure for the website.

urls

urls: MetadataUrls

URL relevant to the current object