Link description object - sgpinkus/json-schema GitHub Wiki

THIS WIKI IS OBSOLETE. PLEASE SEE THE NEW JSON-SCHEMA-ORG/JSON-SCHEMA-SPEC REPOSITORY.



A Link Description Object must be an object, and it has the following properties:

Universal properties

  • href - this value is used to calculate the URI that is the target of the link
  • rel - this value determines the "link relation" of the link, such as "parent", "child" or "author" (see RFC 5988). There are also some new values defined as part of JSON Schema.
  • targetSchema (optional) - this value describes a schema. When the link is followed, the resulting data is expected (but not guaranteed) to be described by this schema.

Link submission properties

These properties describe exactly what an agent needs to do to follow the hyperlink.

  • method - the method used to follow the hyperlink. For HTTP (or HTTPS), this could be "GET" or "POST"
  • encType - how to encode any data you are providing when you request the link, as a MIME type
  • schema - a schema for the data that should be supplied along with the link.

These three properties interact very closely, so they are all described on the same page: [submission links](submission links).

⚠️ **GitHub.com Fallback** ⚠️