Shorturl

Description

Represents a URL that has been converted to a shortened format, suitable for sharing on social networking platforms.

Properties

Property Description
links required read-only

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.

shorturl read-only

The shortened form of url. This URL will redirect to url.

type

The type of resource represented.

url

The URL to shorten.

OpenAPI Schema

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

{
  "description": "Represents a URL that has been converted to a shortened format, suitable\nfor sharing on social networking platforms.",
  "properties": {
    "links": {
      "$ref": "#/components/schemas/Links"
    },
    "shorturl": {
      "description": "The shortened form of `url`. This URL will redirect to `url`.",
      "example": "https://xmpl.io/a4oi",
      "format": "uri",
      "readOnly": true,
      "type": "string"
    },
    "type": {
      "allOf": [
        {
          "$ref": "#/components/schemas/Type"
        },
        {
          "enum": [
            "shorturl"
          ]
        }
      ]
    },
    "url": {
      "description": "The URL to shorten.",
      "example": "https://example.com/a-really-long-url",
      "format": "uri",
      "type": "string"
    }
  },
  "required": [
    "type",
    "url"
  ],
  "title": "Shorturl",
  "type": "object"
}