openproject/docs/api/apiv3/components/schemas/link.yml

# Schema: Link
---
type: object
required:
- href
properties:
  href:
    type: string
    nullable: true
    description: URL to the referenced resource (might be relative)
  title:
    type: string
    description: "\tRepresentative label for the resource"
  templated:
    type: boolean
    default: false
    description: If true the href contains parts that need to be replaced by the client
  method:
    type: string
    default: GET
    description: The HTTP verb to use when requesting the resource
  payload:
    type: string
    description: The payload to send in the request to achieve the desired result
  identifier:
    type: string
    description: "\tAn optional unique identifier to the link object"
examples:
- href: 
- href: "/api/v3/work_packages"
  method: POST
- href: "/api/v3/examples/{example_id}"
  templated: true
- href: urn:openproject-org:api:v3:undisclosed