Service Description

Description

service-description
Service Description

Properties

Property Description
contentType
string[]
enum
  • application/vnd.shootproof+json

An array of acceptable media types for this API service.
links required read-only
object
Links

Each property defines a hypertext link relationship as indicated by a link object or array of link objects. The target URL of each hypertext link relationship is related to the current resource according to the defined semantics of the link relationship property name.
name
string

The name of the API service.
time
string
date-time

The current server time for this API service.
type
string
enum
  • service-description
Type

The type of resource represented.

OpenAPI Schema

The following schema is based on OpenAPI 3.0 and is provided in our downloadable OpenAPI document.

{
  "properties": {
    "contentType": {
      "description": "An array of acceptable media types for this API service.",
      "items": {
        "enum": [
          "application/vnd.shootproof+json"
        ],
        "type": "string"
      },
      "type": "array"
    },
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "name": {
      "description": "The name of the API service.",
      "example": "ShootProof Studio Panel API",
      "type": "string"
    },
    "time": {
      "description": "The current server time for this API service.",
      "format": "date-time",
      "type": "string"
    },
    "type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Type"
        },
        {
          "enum": [
            "service-description"
          ]
        }
      ]
    }
  },
  "title": "Service Description",
  "type": "object"
}
Service Description