Skip to content

Add a describedby Link header #3

Description

@jdesrosiers

Interesting product! With a few enhancements I can use it to rapid prototype JSON Hyper-Schema APIs that I can easily share with others.

The most important thing would be to add describedby Links to document GETs.

GET https://api.npoint.io/my-super-cool-resource HTTP/1.1
HTTP/1.1 200 OK
Content-Type: application/json
Link: </my-super-cool-resource/schema>; rel="describedby"

{
  "data": "foo"
}

The describedby Link indicates that the JSON in the response conforms to the schema retrievable at that location given.

http://json-schema.org/latest/json-schema-core.html#rfc.section.10.1

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions