JSON Type Metadata

Q

How to add documentation information to a JSON type with metadata?

✍: FYIcenter.com

A

You can add documentation information to a JSON type with there metadata properties:

"title" - Takes a JSON string as a short description for this JSON type.

"description" - Takes a JSON string as a long description for this JSON type.

"default" - Takes a JSON value of this JSON type as the default value. If the consumer wants to, it can use it in the case where no JSON value is provided.

"examples" - Takes a JSON array of JSON values of this JSON type as example JSON values. If the consumer wants to, it can be served JSON value examples.

The JSON schema below shows you how "title", "description", "default" and "examples" properties can be used to help documenting a JSON type:

{
    "title": "Class Survey",
    "description": "JSON schema used for class survey collected in JSON format.",
    "type": "object",
    "properties": {
        "clarity": {
            "$ref": "#/definitions/rating"
        },
        "efficiency": {
            "$ref": "#/definitions/rating"
        }
    },
    "definitions": {
        "rating": {
            "type": "integer",
            "minimum": 0,
            "maximum": 5
        }
    },
    "default": {
        "clarity": 0,
        "efficiency": 0
    },
    "examples": [
        {
            "clarity": 5,
            "efficiency": 5
        }
    ]
}

 

Introduction of JSON Schema

⇒⇒JSON Tutorials

2017-08-20, 109👍, 0💬