APIs.json Schema
The JSON Schema definitions that underpin the APIs.json format. These schemas describe the structure of indexes, API entries, properties, and all the metadata needed to properly describe API contracts and operations.
AID
A unique identifier for the collection, consisting of [root domain]:[string] (ie. apis.json:spec-example).
View
APIs AID
A unique identifier for the api, consisting of [root domain]:[string] (ie. apis.json:spec-api).
View
APIs Base Url
Web URL corresponding to the root URL of the API or primary endpoint.
View
APIs Contact
An object to describe a person.
View
APIs Name
Human readable text description of the API.
View
APIs Human Url
Web URL corresponding to human readable information about the API.
View
APIs Name
URL of an image which can be used as an "icon" for the API if displayed by a search engine.
View
APIs Name
Name of the API.
View
APIs Overlays Type
The type of overlay being made available.
View
APIs Overlays URL
The URL for the overlay.
View
APIs Overlays
An optional list of overlays to apply to individual APIs.
View
APIs Properties Data
The data for the property. * must be url or data.
View
APIs Properties Media Type
IANA media type representing the property.
View
APIs Properties Name
The display name of the property.
View
APIs Properties Type
Different properties of an API, see the list of APIs.json properties for a complete list.
View
APIs Properties URL
The URL for the property. * must be url or data.
View
APIs Properties
The human and machine-readable properties of an API.
View
APIs Tags
This is a list of descriptive strings which identify the API.
View
APIs Version
String representing the version number of the API this description refers to.
View
APIs
List of APIs identified in the file.
View
Common Media Type
IANA media type representing the property.
View
Common Name
The display name of the property.
View
Common Type
Please see reserved keywords below.
View
Common URL
The URL for the common property.
View
Common
A list of common properties for use across all APIs and tools.
View
Created
Date of creation of the file.
View
Description
Text human readable description of the collection of APIs.
View
Image
Web URL leading to an image to be used to represent the collection of APIs defined in this file.
View
Include Name
The name of the APIs.json file referenced.
View
Include URL
The URL of the APIs.json file referenced.
View
Include
Additional APIs.json to include with the index.
View
Kind
Classifies the entity the APIs.json document is about, separately from the document `type`. Conventional lowercase values include `company`, `opensource`, `government`, `topic`, `standard`, `protocol`, and `non-profit`. Replaces the prior `x-type` / `xType` vendor extensions; new files should use `kind`.
View
Maintainers
Who is responsible for maintaining an APIs.json.
View
Modified
Date of last modification of the file.
View
Name
Text string of human readable name for the collection of APIs.
View
Networks Name
The name of network being made available.
View
Networks URL
The URL for the network search node.
View
Networks
A list of other APIs.json search indexes to include for discovery.
View
Overlays Type
The type of overlay being made available.
View
Overlays URL
The URL for the overlay.
View
Overlays
An optional list of overlays to apply to primary APIs.json.
View
Specification Version
Version of the APIs.json specification in use.
View
Tags
This is a list of descriptive strings which identify the contents of the APIs.json file. Represented as an array.
View
Type
The document kind of this APIs.json file. Canonical value is `Index` — an index of one or more APIs and their associated properties. Reserved values are `Index`, `Collection` (multiple APIs), and `Blueprint` (a template for a new API). Use the separate `kind` field to classify the entity the document is about (company, government, opensource, topic, standard, etc.).
View
URL
Web URL indicating the location of the latest version of this file.
View