SmartBear · Schema

SmartBear API Entry

A single API definition entry in the SwaggerHub registry, including metadata, versions, and access properties.

API DesignAPI DocumentationAPI TestingContract TestingGovernanceMonitoringPlatform

Properties

Name	Type	Description
name	string	Name of the API
description	string	Human-readable description of the API
created	string	Timestamp when the API was created
modified	string	Timestamp when the API was last modified
swaggerUrl	string	URL to the SwaggerHub UI for this API
url	string	Raw URL to the API definition
versions	array	List of available version strings
owner	string	Owner username or organization name
isPrivate	boolean	Whether the API is private (true) or public (false)
tags	array	Tags associated with the API for discovery

View JSON Schema on GitHub

JSON Schema

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "https://api-evangelist.github.io/smartbear/json-schema/smartbear-api-entry-schema.json",
  "title": "SmartBear API Entry",
  "description": "A single API definition entry in the SwaggerHub registry, including metadata, versions, and access properties.",
  "type": "object",
  "properties": {
    "name": {
      "type": "string",
      "description": "Name of the API"
    },
    "description": {
      "type": "string",
      "description": "Human-readable description of the API"
    },
    "created": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the API was created"
    },
    "modified": {
      "type": "string",
      "format": "date-time",
      "description": "Timestamp when the API was last modified"
    },
    "swaggerUrl": {
      "type": "string",
      "format": "uri",
      "description": "URL to the SwaggerHub UI for this API"
    },
    "url": {
      "type": "string",
      "format": "uri",
      "description": "Raw URL to the API definition"
    },
    "versions": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "List of available version strings"
    },
    "owner": {
      "type": "string",
      "description": "Owner username or organization name"
    },
    "isPrivate": {
      "type": "boolean",
      "description": "Whether the API is private (true) or public (false)"
    },
    "tags": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Tags associated with the API for discovery"
    }
  },
  "required": ["name", "owner"]
}