Tools, FAQ, Tutorials:
JSON Type Metadata
How to add documentation information to a JSON type with metadata?
✍: FYIcenter.com
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
}
]
}
2023-07-08, ∼2904🔥, 0💬
Popular Posts:
Where to find tutorials on RSS specifications? I want to learn it to describe my API services. Here ...
How to detect errors occurred in the json_decode() call? You can use the following two functions to ...
How To Pad an Array with the Same Value Multiple Times in PHP? If you want to add the same value mul...
Can Multiple Paragraphs Be Included in a List Item? Yes. You can include multiple paragraphs in a si...
How to use the urllib.request.Request object to build more complex HTTP request? The urllib.request....