| .. | ||
| images-upload.json | ||
| images.json | ||
| index.js | ||
| labels-add.json | ||
| labels-edit.json | ||
| labels.json | ||
| media-upload.json | ||
| media.json | ||
| members-add.json | ||
| members-edit.json | ||
| members-upload.json | ||
| members.json | ||
| pages-add.json | ||
| pages-edit.json | ||
| pages.json | ||
| posts-add.json | ||
| posts-edit.json | ||
| posts.json | ||
| products-add.json | ||
| products-edit.json | ||
| products.json | ||
| README.md | ||
| snippets-add.json | ||
| snippets-edit.json | ||
| snippets.json | ||
| tags-add.json | ||
| tags-edit.json | ||
| tags.json | ||
| tiers-add.json | ||
| tiers-edit.json | ||
| tiers.json | ||
| webhooks-add.json | ||
| webhooks-edit.json | ||
| webhooks.json | ||
JSON Schema structuring convention
When adding a new schema or definition following naming convention should be followed:
- Name the file containing JSON definitions in the same way as resource is named in the API (aka "docName" in controller config). For example, for tags the definitions file would be
tags.json - Name the file containing JSON schema (which usually references "definitions") using following convention
{resourceName}-{methodName}.json. For example, for tags.edit method file would be namedtags-edit.json - Update
index.jslist with a new definition name
The need to have separate "definitions" and "schema" files comes from schema reusability pattern that JSON schema allows for through $ref keyword. In some cases, the pattern doesn't quite work out because of limitations of the syntax (cannot override parts of referenced definition). Generally try to reuse as much schema as possible to avoid duplication unless it becomes painful to do so.