APIs.guru · Schema

ApiVersion

ApiVersion schema from APIs.guru REST API

API CatalogAPI DirectoryAPI DiscoveryCommunityGraphQLOpen SourceOpenAPI

Properties

Name Type Description
added string Timestamp when the version was added
externalDocs object Copy of `externalDocs` section from OpenAPI definition
info object Copy of `info` section from OpenAPI definition
link string Link to the individual API entry for this API
openapiVer string The value of the `openapi` or `swagger` property of the source definition
swaggerUrl string URL to OpenAPI definition in JSON format
swaggerYamlUrl string URL to OpenAPI definition in YAML format
updated string Timestamp when the version was updated
View JSON Schema on GitHub

JSON Schema

apis-guru-api-version-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/apis-guru/refs/heads/main/json-schema/apis-guru-api-version-schema.json",
  "title": "ApiVersion",
  "description": "ApiVersion schema from APIs.guru REST API",
  "additionalProperties": false,
  "properties": {
    "added": {
      "description": "Timestamp when the version was added",
      "format": "date-time",
      "type": "string"
    },
    "externalDocs": {
      "description": "Copy of `externalDocs` section from OpenAPI definition",
      "minProperties": 1,
      "type": "object"
    },
    "info": {
      "description": "Copy of `info` section from OpenAPI definition",
      "minProperties": 1,
      "type": "object"
    },
    "link": {
      "description": "Link to the individual API entry for this API",
      "format": "url",
      "type": "string"
    },
    "openapiVer": {
      "description": "The value of the `openapi` or `swagger` property of the source definition",
      "type": "string"
    },
    "swaggerUrl": {
      "description": "URL to OpenAPI definition in JSON format",
      "format": "url",
      "type": "string"
    },
    "swaggerYamlUrl": {
      "description": "URL to OpenAPI definition in YAML format",
      "format": "url",
      "type": "string"
    },
    "updated": {
      "description": "Timestamp when the version was updated",
      "format": "date-time",
      "type": "string"
    }
  },
  "required": [
    "added",
    "updated",
    "swaggerUrl",
    "swaggerYamlUrl",
    "info",
    "openapiVer"
  ],
  "type": "object"
}