APIs.json · Schema
JSON Schema for APIs.json 0.20
API AggregationAPI CatalogingAPI CommonsAPI DiscoveryAPI GovernanceAPI OperationsMachine ReadableSpecificationStandard
Properties
| Name | Type | Description |
|---|---|---|
| aid | string | unique identifier for APIs.json |
| visibility | string | The visibility for the APIs.json collection. |
| rating | string | The rating for the APIs.json collection. |
| type | string | The type of the APIs.json collection. |
| position | string | The position of the maintainer of APIs.json. |
| access | string | The access level for the APIs in an APIs.json. |
| name | string | The name of the service described |
| description | string | Description of the service |
| url | string | URL where the apis.json file will live |
| image | string | Image to represent the API |
| created | string | Date when the file was created |
| modified | string | Date when the file was modified |
| specificationVersion | string | APIs.json spec version, latest is 0.19 |
| apis | array | All the APIs of this service |
| maintainers | array | Maintainers of the apis.json file |
| tags | array | Tags to describe the service |
| include | array | Links to other apis.json definitions included in this service |
| common | array | Common properties that apply across all APIs. |
| overlays | array | Links to other apis.json that will be overlaid original. |
| network | array | Links to other apis.json that will be included in discovery. |