-
-
Notifications
You must be signed in to change notification settings - Fork 7
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Schemas for menus and menu locations.
- Loading branch information
1 parent
56c97cb
commit 832b54d
Showing
7 changed files
with
203 additions
and
8 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| { | ||
| "$schema": "http://json-schema.org/draft-07/hyper-schema#", | ||
| "$id": "https://raw.githubusercontent.com/johnbillion/wp-json-schemas/trunk/schemas/rest-api/collections/menu-locations.json", | ||
| "title": "WP_REST_API_Menu_Locations", | ||
| "description": "A collection of menu locations in a REST API context.", | ||
| "type": "object", | ||
| "additionalProperties": { | ||
| "$ref": "../menu-location.json" | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,10 @@ | ||
| { | ||
| "$schema": "http://json-schema.org/draft-07/hyper-schema#", | ||
| "$id": "https://raw.githubusercontent.com/johnbillion/wp-json-schemas/trunk/schemas/rest-api/collections/menus.json", | ||
| "title": "WP_REST_API_Menus", | ||
| "description": "A collection of menus in a REST API context.", | ||
| "type": "array", | ||
| "items": { | ||
| "$ref": "../menu.json" | ||
| } | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,59 @@ | ||
| { | ||
| "$schema": "http://json-schema.org/draft-07/hyper-schema#", | ||
| "$id": "https://raw.githubusercontent.com/johnbillion/wp-json-schemas/trunk/schemas/rest-api/menu-location.json", | ||
| "title": "WP_REST_API_Menu_Location", | ||
| "description": "A menu location in a REST API context.", | ||
| "type": "object", | ||
| "required": [ | ||
| "name", | ||
| "description", | ||
| "menu", | ||
| "_links" | ||
| ], | ||
| "properties": { | ||
| "name": { | ||
| "description": "The name of the menu location.", | ||
| "type": "string", | ||
| "readOnly": true | ||
| }, | ||
| "description": { | ||
| "description": "The description of the menu location.", | ||
| "type": "string", | ||
| "readOnly": true | ||
| }, | ||
| "menu": { | ||
| "description": "The ID of the assigned menu.", | ||
| "type": "integer", | ||
| "readOnly": true | ||
| }, | ||
| "_links": { | ||
| "$ref": "properties/object-links.json" | ||
| } | ||
| }, | ||
| "links": [ | ||
| { | ||
| "rel": "self", | ||
| "href": "/wp/v2/menu-locations/{name}", | ||
| "hrefSchema": { | ||
| "properties": { | ||
| "name": { | ||
| "$ref": "#/properties/name" | ||
| } | ||
| } | ||
| }, | ||
| "targetSchema": { | ||
| "$ref": "#" | ||
| } | ||
| }, | ||
| { | ||
| "rel": "collection", | ||
| "href": "/wp/v2/menu-locations", | ||
| "targetSchema": { | ||
| "type": "array", | ||
| "items": { | ||
| "$ref": "#" | ||
| } | ||
| } | ||
| } | ||
| ] | ||
| } |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
| @@ -0,0 +1,100 @@ | ||
| { | ||
| "$schema": "http://json-schema.org/draft-07/hyper-schema#", | ||
| "$id": "https://raw.githubusercontent.com/johnbillion/wp-json-schemas/trunk/schemas/rest-api/menu.json", | ||
| "title": "WP_REST_API_Menu", | ||
| "description": "A menu in a REST API context.", | ||
| "type": "object", | ||
| "required": [ | ||
| "id", | ||
| "description", | ||
| "name", | ||
| "slug", | ||
| "meta", | ||
| "locations", | ||
| "auto_add", | ||
| "_links" | ||
| ], | ||
| "properties": { | ||
| "id": { | ||
| "description": "Unique identifier for the term.", | ||
| "type": "integer", | ||
| "readOnly": true | ||
| }, | ||
| "description": { | ||
| "description": "HTML description of the term.", | ||
| "type": "string" | ||
| }, | ||
| "name": { | ||
| "description": "HTML title for the term.", | ||
| "type": "string" | ||
| }, | ||
| "slug": { | ||
| "description": "An alphanumeric identifier for the term unique to its type.", | ||
| "type": "string" | ||
| }, | ||
| "meta": { | ||
| "description": "Meta fields.", | ||
| "oneOf": [ | ||
| { | ||
| "$ref": "../../schema.json#/definitions/EmptyArray" | ||
| }, | ||
| { | ||
| "type": "object" | ||
| } | ||
| ] | ||
| }, | ||
| "locations": { | ||
| "description": "The locations assigned to the menu.", | ||
| "type": "array", | ||
| "items": { | ||
| "type": "string" | ||
| } | ||
| }, | ||
| "auto_add": { | ||
| "description": "Whether to automatically add top level pages to this menu.", | ||
| "type": "boolean" | ||
| }, | ||
| "_links": { | ||
| "$ref": "properties/object-links.json" | ||
| }, | ||
| "_embedded": { | ||
| "description": "The embedded representation of relations. Only present when the '_embed' query parameter is set.", | ||
| "type": "object", | ||
| "required": [ | ||
| "wp:menu-location" | ||
| ], | ||
| "properties": { | ||
| "wp:menu-location": { | ||
| "description": "The menu locations.", | ||
| "type": "array" | ||
| } | ||
| } | ||
| } | ||
| }, | ||
| "links": [ | ||
| { | ||
| "rel": "self", | ||
| "href": "/wp/v2/menus/{id}", | ||
| "hrefSchema": { | ||
| "properties": { | ||
| "id": { | ||
| "$ref": "#/properties/id" | ||
| } | ||
| } | ||
| }, | ||
| "targetSchema": { | ||
| "$ref": "#" | ||
| } | ||
| }, | ||
| { | ||
| "rel": "collection", | ||
| "href": "/wp/v2/menus", | ||
| "targetSchema": { | ||
| "type": "array", | ||
| "items": { | ||
| "$ref": "#" | ||
| } | ||
| } | ||
| } | ||
| ] | ||
| } |