Add URL Annotation

[philkra]

🚀 Feature Proposal

Annotation that associates an URL to a property and/or type, that is then reflected in the spec.

Motivation

Additional meta data to improve e.g. developer experience to link to a resource for more context.

Example

in TypeScript:

/** @url https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#byte-units */
type ByteSize = string

in the spec:

{
    "name": "data.input_bytes",
    "required": false,
    "type": {
    "kind": "instance_of",
    "type": {
        "name": "ByteSize",
        "namespace": "internal",
        "url": "https://www.elastic.co/guide/en/elasticsearch/reference/current/common-options.html#byte-units"
    }
}

[delvedor]

This has already been done in #260 :)
The js doc tag to be used is @doc_url. It looks like the docs need to be updated.

[delvedor]

Closed in #324.