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, 1416🔥, 0💬
Popular Posts:
How To Use an Array as a Queue in PHP? A queue is a simple data structure that manages data elements...
How to use the "set-body" Policy Statement for an Azure API service operation? The "set-body" Policy...
How to validate the id_token signature received from Azure AD v2.0 authentication response? You can ...
Where to find tutorials on OpenID? Here is a large collection of tutorials to answer many frequently...
How to attach console to a Running Container using the "docker container exec" command? I want to ge...