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, 1334🔥, 0💬
Popular Posts:
How to convert JSON Objects to PHP Associative Arrays using the json_decode() function? Actually, JS...
How to reinstall npm with a node version manager? I am getting permission errors with the current ve...
Where Is the Submitted Form Data Stored in PHP? When a user submit a form on your Web server, user e...
How To Loop through an Array without Using "foreach" in PHP? PHP offers the following functions to a...
How to use "{{...}}" Liquid Codes in "set-body" Policy Statement? The "{{...}}" Liquid Codes in "set...