Link Description

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/link_description",
  "title": "Link Description",
  "type": "object",
  "description": "The request-related [HATEOAS link](/docs/api/reference/api-responses/#hateoas-links) information.",
  "required": [
    "href",
    "rel"
  ],
  "properties": {
    "href": {
      "type": "string",
      "description": "The complete target URL. To make the related call, combine the method with this [URI Template-formatted](https://tools.ietf.org/html/rfc6570) link. For pre-processing, include the `$`, `(`, and `)` characters. The `href` is the key HATEOAS component that links a completed call with a subsequent call."
    },
    "rel": {
      "type": "string",
      "description": "The [link relation type](https://tools.ietf.org/html/rfc5988#section-4), which serves as an ID for a link that unambiguously describes the semantics of the link. See [Link Relations](https://www.iana.org/assignments/link-relations/link-relations.xhtml)."
    },
    "method": {
      "type": "string",
      "description": "The HTTP method required to make the related call.",
      "enum": [
        "GET",
        "POST",
        "PUT",
        "DELETE",
        "HEAD",
        "CONNECT",
        "OPTIONS",
        "PATCH"
      ]
    }
  }
}