From dbf739bbaae9fe2ee931474711127db02afb5cdc Mon Sep 17 00:00:00 2001 From: Sergey Biryukov Date: Fri, 24 Feb 2017 22:33:05 +0000 Subject: [PATCH] REST API: Add QUnit tests for wp-api.js and PHPUnit fixture generation. Add QUnit tests: verify that wp-api loads correctly, verify that the expected base models and collections exist and can be instantiated, verify that collections contain the correct models, verify that expected helper functions are in place for each collection. The QUnit tests rely on two fixture files: `tests/qunit/fixtures/wp-api-generated.js` contains the data response from each core endpoint and is generated by running the PHPUnit `restapi-jsclient` group. `tests/qunit/fixtures/wp-api.js` maps the generated data to endpoint routes, and overrides `Backbone.ajax` to mock the responses for the tests. Add PHPUnit tests in `tests/phpunit/tests/rest-api/rest-schema-setup.php`. First, verify that the API returns the expected routes via `server->get_routes()`. Then, the `test_build_wp_api_client_fixtures` test goes thru each endpoint and requests it from the API, tests that it returns data, and builds up the data for the mocked QUnit tests, saving the final results to `tests/qunit/fixtures/wp-api-generated.js`. Add a new grunt task `restapi-jsclient` which runs the phpunit side data generation and the qunit tests together. Props jnylen0, welcher, adamsilverstein, netweb, ocean90, rachelbaker. Merges [40058], [40061], [40065], [40066], [40077], and [40104] to the 4.7 branch. Fixes #39264. git-svn-id: https://develop.svn.wordpress.org/branches/4.7@40116 602fd350-edb4-49c9-b593-d223f7449a82 --- Gruntfile.js | 9 + tests/phpunit/includes/bootstrap.php | 5 +- .../tests/rest-api/rest-post-meta-fields.php | 3 + .../tests/rest-api/rest-schema-setup.php | 404 ++ tests/qunit/fixtures/wp-api-generated.js | 4307 +++++++++++++++++ tests/qunit/fixtures/wp-api.js | 55 + tests/qunit/index.html | 9 + tests/qunit/wp-includes/js/wp-api.js | 195 + 8 files changed, 4985 insertions(+), 2 deletions(-) create mode 100644 tests/phpunit/tests/rest-api/rest-schema-setup.php create mode 100644 tests/qunit/fixtures/wp-api-generated.js create mode 100644 tests/qunit/fixtures/wp-api.js create mode 100644 tests/qunit/wp-includes/js/wp-api.js diff --git a/Gruntfile.js b/Gruntfile.js index 5a9317c12d..80e2968bf5 100644 --- a/Gruntfile.js +++ b/Gruntfile.js @@ -439,6 +439,10 @@ module.exports = function(grunt) { 'external-http': { cmd: 'phpunit', args: ['-c', 'phpunit.xml.dist', '--group', 'external-http'] + }, + 'restapi-jsclient': { + cmd: 'phpunit', + args: ['-c', 'phpunit.xml.dist', '--group', 'restapi-jsclient'] } }, uglify: { @@ -672,6 +676,11 @@ module.exports = function(grunt) { 'jshint:media' ] ); + grunt.registerTask( 'restapi-jsclient', [ + 'phpunit:restapi-jsclient', + 'qunit:compiled' + ] ); + grunt.renameTask( 'watch', '_watch' ); grunt.registerTask( 'watch', function() { diff --git a/tests/phpunit/includes/bootstrap.php b/tests/phpunit/includes/bootstrap.php index 29d109bb7a..b462e7039b 100644 --- a/tests/phpunit/includes/bootstrap.php +++ b/tests/phpunit/includes/bootstrap.php @@ -18,8 +18,9 @@ $config_file_path .= '/wp-tests-config.php'; */ global $wpdb, $current_site, $current_blog, $wp_rewrite, $shortcode_tags, $wp, $phpmailer, $wp_theme_directories; -if ( !is_readable( $config_file_path ) ) { - die( "ERROR: wp-tests-config.php is missing! Please use wp-tests-config-sample.php to create a config file.\n" ); +if ( ! is_readable( $config_file_path ) ) { + echo "ERROR: wp-tests-config.php is missing! Please use wp-tests-config-sample.php to create a config file.\n"; + exit( 1 ); } require_once $config_file_path; require_once dirname( __FILE__ ) . '/functions.php'; diff --git a/tests/phpunit/tests/rest-api/rest-post-meta-fields.php b/tests/phpunit/tests/rest-api/rest-post-meta-fields.php index 9aa5110fc3..4c0726b67d 100644 --- a/tests/phpunit/tests/rest-api/rest-post-meta-fields.php +++ b/tests/phpunit/tests/rest-api/rest-post-meta-fields.php @@ -10,13 +10,16 @@ * @group restapi */ class WP_Test_REST_Post_Meta_Fields extends WP_Test_REST_TestCase { + protected static $wp_meta_keys_saved; protected static $post_id; public static function wpSetUpBeforeClass( $factory ) { + self::$wp_meta_keys_saved = $GLOBALS['wp_meta_keys']; self::$post_id = $factory->post->create(); } public static function wpTearDownAfterClass() { + $GLOBALS['wp_meta_keys'] = self::$wp_meta_keys_saved; wp_delete_post( self::$post_id, true ); } diff --git a/tests/phpunit/tests/rest-api/rest-schema-setup.php b/tests/phpunit/tests/rest-api/rest-schema-setup.php new file mode 100644 index 0000000000..eea2224331 --- /dev/null +++ b/tests/phpunit/tests/rest-api/rest-schema-setup.php @@ -0,0 +1,404 @@ +server = $wp_rest_server = new Spy_REST_Server; + do_action( 'rest_api_init' ); + } + + public function tearDown() { + parent::tearDown(); + remove_filter( 'rest_url', array( $this, 'test_rest_url_for_leading_slash' ), 10, 2 ); + /** @var WP_REST_Server $wp_rest_server */ + global $wp_rest_server; + $wp_rest_server = null; + } + + public function test_expected_routes_in_schema() { + $routes = $this->server->get_routes(); + + $this->assertTrue( is_array( $routes ), '`get_routes` should return an array.' ); + $this->assertTrue( ! empty( $routes ), 'Routes should not be empty.' ); + + $routes = array_filter( array_keys( $routes ), array( $this, 'is_builtin_route' ) ); + + $expected_routes = array( + '/', + '/oembed/1.0', + '/oembed/1.0/embed', + '/wp/v2', + '/wp/v2/posts', + '/wp/v2/posts/(?P[\\d]+)', + '/wp/v2/posts/(?P[\\d]+)/revisions', + '/wp/v2/posts/(?P[\\d]+)/revisions/(?P[\\d]+)', + '/wp/v2/pages', + '/wp/v2/pages/(?P[\\d]+)', + '/wp/v2/pages/(?P[\\d]+)/revisions', + '/wp/v2/pages/(?P[\\d]+)/revisions/(?P[\\d]+)', + '/wp/v2/media', + '/wp/v2/media/(?P[\\d]+)', + '/wp/v2/types', + '/wp/v2/types/(?P[\\w-]+)', + '/wp/v2/statuses', + '/wp/v2/statuses/(?P[\\w-]+)', + '/wp/v2/taxonomies', + '/wp/v2/taxonomies/(?P[\\w-]+)', + '/wp/v2/categories', + '/wp/v2/categories/(?P[\\d]+)', + '/wp/v2/tags', + '/wp/v2/tags/(?P[\\d]+)', + '/wp/v2/users', + '/wp/v2/users/(?P[\\d]+)', + '/wp/v2/users/me', + '/wp/v2/comments', + '/wp/v2/comments/(?P[\\d]+)', + '/wp/v2/settings', + ); + + $this->assertEquals( $expected_routes, $routes ); + } + + private function is_builtin_route( $route ) { + return ( + '/' === $route || + preg_match( '#^/oembed/1\.0(/.+)?$#', $route ) || + preg_match( '#^/wp/v2(/.+)?$#', $route ) + ); + } + + public function test_build_wp_api_client_fixtures() { + // Set up data for individual endpoint responses. We need to specify + // lots of different fields on these objects, otherwise the generated + // fixture file will be different between runs of PHPUnit tests, which + // is not desirable. + + $administrator_id = $this->factory->user->create( array( + 'role' => 'administrator', + 'display_name' => 'REST API Client Fixture: User', + 'user_nicename' => 'restapiclientfixtureuser', + 'user_email' => 'administrator@example.org', + ) ); + wp_set_current_user( $administrator_id ); + + $post_id = $this->factory->post->create( array( + 'post_name' => 'restapi-client-fixture-post', + 'post_title' => 'REST API Client Fixture: Post', + 'post_content' => 'REST API Client Fixture: Post', + 'post_excerpt' => 'REST API Client Fixture: Post', + 'post_author' => 0, + ) ); + wp_update_post( array( + 'ID' => $post_id, + 'post_content' => 'Updated post content.', + ) ); + + $page_id = $this->factory->post->create( array( + 'post_type' => 'page', + 'post_name' => 'restapi-client-fixture-page', + 'post_title' => 'REST API Client Fixture: Page', + 'post_content' => 'REST API Client Fixture: Page', + 'post_excerpt' => 'REST API Client Fixture: Page', + 'post_date' => '2017-02-14 00:00:00', + 'post_date_gmt' => '2017-02-14 00:00:00', + 'post_author' => 0, + ) ); + wp_update_post( array( + 'ID' => $page_id, + 'post_content' => 'Updated page content.', + ) ); + + $tag_id = $this->factory->tag->create( array( + 'name' => 'REST API Client Fixture: Tag', + 'slug' => 'restapi-client-fixture-tag', + 'description' => 'REST API Client Fixture: Tag', + ) ); + + $media_id = $this->factory->attachment->create_object( '/tmp/canola.jpg', 0, array( + 'post_mime_type' => 'image/jpeg', + 'post_excerpt' => 'A sample caption', + 'post_name' => 'restapi-client-fixture-attachment', + 'post_title' => 'REST API Client Fixture: Attachment', + 'post_date' => '2017-02-14 00:00:00', + 'post_date_gmt' => '2017-02-14 00:00:00', + 'post_author' => 0, + ) ); + + $comment_id = $this->factory->comment->create( array( + 'comment_approved' => 1, + 'comment_post_ID' => $post_id, + 'user_id' => 0, + 'comment_date' => '2017-02-14 00:00:00', + 'comment_date_gmt' => '2017-02-14 00:00:00', + 'comment_author' => 'Internet of something or other', + 'comment_author_email' => 'lights@example.org', + 'comment_author_url' => 'http://lights.example.org/', + ) ); + + // Generate route data for subsequent QUnit tests. + $routes_to_generate_data = array( + array( + 'route' => '/', + 'name' => 'Schema', + ), + array( + 'route' => '/oembed/1.0', + 'name' => 'oembed', + ), + array( + 'route' => '/oembed/1.0/embed', + 'name' => 'oembeds', + ), + array( + 'route' => '/wp/v2/posts', + 'name' => 'PostsCollection', + ), + array( + 'route' => '/wp/v2/posts/' . $post_id, + 'name' => 'PostModel', + ), + array( + 'route' => '/wp/v2/posts/' . $post_id . '/revisions', + 'name' => 'postRevisions', + ), + array( + 'route' => '/wp/v2/posts/' . $post_id . '/revisions/1', + 'name' => 'revision', + ), + array( + 'route' => '/wp/v2/pages', + 'name' => 'PagesCollection', + ), + array( + 'route' => '/wp/v2/pages/' . $page_id, + 'name' => 'PageModel', + ), + array( + 'route' => '/wp/v2/pages/'. $page_id . '/revisions', + 'name' => 'pageRevisions', + ), + array( + 'route' => '/wp/v2/pages/'. $page_id . '/revisions/1', + 'name' => 'pageRevision', + ), + array( + 'route' => '/wp/v2/media', + 'name' => 'MediaCollection', + ), + array( + 'route' => '/wp/v2/media/' . $media_id, + 'name' => 'MediaModel', + ), + array( + 'route' => '/wp/v2/types', + 'name' => 'TypesCollection', + ), + array( + 'route' => '/wp/v2/types/', + 'name' => 'TypeModel', + ), + array( + 'route' => '/wp/v2/statuses', + 'name' => 'StatusesCollection', + ), + array( + 'route' => '/wp/v2/statuses/publish', + 'name' => 'StatusModel', + ), + array( + 'route' => '/wp/v2/taxonomies', + 'name' => 'TaxonomiesCollection', + ), + array( + 'route' => '/wp/v2/taxonomies/category', + 'name' => 'TaxonomyModel', + ), + array( + 'route' => '/wp/v2/categories', + 'name' => 'CategoriesCollection', + ), + array( + 'route' => '/wp/v2/categories/1', + 'name' => 'CategoryModel', + ), + array( + 'route' => '/wp/v2/tags', + 'name' => 'TagsCollection', + ), + array( + 'route' => '/wp/v2/tags/' . $tag_id, + 'name' => 'TagModel', + ), + array( + 'route' => '/wp/v2/users', + 'name' => 'UsersCollection', + ), + array( + 'route' => '/wp/v2/users/' . $administrator_id, + 'name' => 'UserModel', + ), + array( + 'route' => '/wp/v2/users/me', + 'name' => 'me', + ), + array( + 'route' => '/wp/v2/comments', + 'name' => 'CommentsCollection', + ), + array( + 'route' => '/wp/v2/comments/1', + 'name' => 'CommentModel', + ), + array( + 'route' => '/wp/v2/settings', + 'name' => 'settings', + ), + ); + + $mocked_responses = "/**\n"; + $mocked_responses .= " * DO NOT EDIT\n"; + $mocked_responses .= " * Auto-generated by test_build_wp_api_client_fixtures\n"; + $mocked_responses .= " */\n"; + $mocked_responses .= "var mockedApiResponse = {};\n"; + $mocked_responses .= "/* jshint -W109 */\n"; + + foreach ( $routes_to_generate_data as $route ) { + $request = new WP_REST_Request( 'GET', $route['route'] ); + $response = $this->server->dispatch( $request ); + $data = $response->get_data(); + + $this->assertTrue( ! empty( $data ), $route['name'] . ' route should return data.' ); + + if ( version_compare( PHP_VERSION, '5.4', '>=' ) ) { + $fixture = $this->normalize_fixture( $data, $route['name'] ); + $mocked_responses .= "\nmockedApiResponse." . $route['name'] . ' = ' + . json_encode( $fixture, JSON_PRETTY_PRINT | JSON_UNESCAPED_SLASHES ) + . ";\n"; + } + } + + if ( is_multisite() ) { + echo "Skipping generation of API client fixtures in multisite mode.\n"; + } else if ( version_compare( PHP_VERSION, '5.4', '<' ) ) { + echo "Skipping generation of API client fixtures due to unsupported JSON_* constants.\n"; + } else { + // Save the route object for QUnit tests. + $file = './tests/qunit/fixtures/wp-api-generated.js'; + file_put_contents( $file, $mocked_responses ); + } + + // Clean up our test data. + wp_delete_post( $post_id, true ); + wp_delete_post( $page_id, true ); + wp_delete_term( $tag_id, 'tags' ); + wp_delete_attachment( $media_id ); + wp_delete_comment( $comment_id ); + } + + /** + * This array contains normalized versions of object IDs and other values + * that can change depending on how PHPUnit is executed. For details on + * how they were generated, see #39264. + */ + private static $fixture_replacements = array( + 'PostsCollection.0.id' => 3, + 'PostsCollection.0.guid.rendered' => 'http://example.org/?p=3', + 'PostsCollection.0.link' => 'http://example.org/?p=3', + 'PostsCollection.0._links.self.0.href' => 'http://example.org/?rest_route=/wp/v2/posts/3', + 'PostsCollection.0._links.replies.0.href' => 'http://example.org/?rest_route=%2Fwp%2Fv2%2Fcomments&post=3', + 'PostsCollection.0._links.version-history.0.href' => 'http://example.org/?rest_route=/wp/v2/posts/3/revisions', + 'PostsCollection.0._links.wp:attachment.0.href' => 'http://example.org/?rest_route=%2Fwp%2Fv2%2Fmedia&parent=3', + 'PostsCollection.0._links.wp:term.0.href' => 'http://example.org/?rest_route=%2Fwp%2Fv2%2Fcategories&post=3', + 'PostsCollection.0._links.wp:term.1.href' => 'http://example.org/?rest_route=%2Fwp%2Fv2%2Ftags&post=3', + 'PostModel.id' => 3, + 'PostModel.guid.rendered' => 'http://example.org/?p=3', + 'PostModel.link' => 'http://example.org/?p=3', + 'postRevisions.0.author' => '2', + 'postRevisions.0.id' => 4, + 'postRevisions.0.parent' => 3, + 'postRevisions.0.slug' => '3-revision-v1', + 'postRevisions.0.guid.rendered' => 'http://example.org/?p=4', + 'postRevisions.0._links.parent.0.href' => 'http://example.org/?rest_route=/wp/v2/posts/3', + 'PagesCollection.0.id' => 5, + 'PagesCollection.0.guid.rendered' => 'http://example.org/?page_id=5', + 'PagesCollection.0.link' => 'http://example.org/?page_id=5', + 'PagesCollection.0._links.self.0.href' => 'http://example.org/?rest_route=/wp/v2/pages/5', + 'PagesCollection.0._links.replies.0.href' => 'http://example.org/?rest_route=%2Fwp%2Fv2%2Fcomments&post=5', + 'PagesCollection.0._links.version-history.0.href' => 'http://example.org/?rest_route=/wp/v2/pages/5/revisions', + 'PagesCollection.0._links.wp:attachment.0.href' => 'http://example.org/?rest_route=%2Fwp%2Fv2%2Fmedia&parent=5', + 'PageModel.id' => 5, + 'PageModel.guid.rendered' => 'http://example.org/?page_id=5', + 'PageModel.link' => 'http://example.org/?page_id=5', + 'pageRevisions.0.author' => '2', + 'pageRevisions.0.id' => 6, + 'pageRevisions.0.parent' => 5, + 'pageRevisions.0.slug' => '5-revision-v1', + 'pageRevisions.0.guid.rendered' => 'http://example.org/?p=6', + 'pageRevisions.0._links.parent.0.href' => 'http://example.org/?rest_route=/wp/v2/pages/5', + 'MediaCollection.0.id' => 7, + 'MediaCollection.0.guid.rendered' => 'http://example.org/?attachment_id=7', + 'MediaCollection.0.link' => 'http://example.org/?attachment_id=7', + 'MediaCollection.0._links.self.0.href' => 'http://example.org/?rest_route=/wp/v2/media/7', + 'MediaCollection.0._links.replies.0.href' => 'http://example.org/?rest_route=%2Fwp%2Fv2%2Fcomments&post=7', + 'MediaModel.id' => 7, + 'MediaModel.guid.rendered' => 'http://example.org/?attachment_id=7', + 'MediaModel.link' => 'http://example.org/?attachment_id=7', + 'TagsCollection.0.id' => 2, + 'TagsCollection.0._links.self.0.href' => 'http://example.org/?rest_route=/wp/v2/tags/2', + 'TagsCollection.0._links.wp:post_type.0.href' => 'http://example.org/?rest_route=%2Fwp%2Fv2%2Fposts&tags=2', + 'TagModel.id' => 2, + 'UsersCollection.1.id' => 2, + 'UsersCollection.1.link' => 'http://example.org/?author=2', + 'UsersCollection.1._links.self.0.href' => 'http://example.org/?rest_route=/wp/v2/users/2', + 'UserModel.id' => 2, + 'UserModel.link' => 'http://example.org/?author=2', + 'me.id' => 2, + 'me.link' => 'http://example.org/?author=2', + 'CommentsCollection.0.id' => 2, + 'CommentsCollection.0.post' => 3, + 'CommentsCollection.0.link' => 'http://example.org/?p=3#comment-2', + 'CommentsCollection.0._links.self.0.href' => 'http://example.org/?rest_route=/wp/v2/comments/2', + 'CommentsCollection.0._links.up.0.href' => 'http://example.org/?rest_route=/wp/v2/posts/3', + ); + + private function normalize_fixture( $data, $path ) { + if ( isset( self::$fixture_replacements[ $path ] ) ) { + return self::$fixture_replacements[ $path ]; + } + + if ( ! is_array( $data ) ) { + return $data; + } + + foreach ( $data as $key => $value ) { + if ( is_string( $value ) && ( + 'date' === $key || + 'date_gmt' === $key || + 'modified' === $key || + 'modified_gmt' === $key + ) ) { + $data[ $key ] = '2017-02-14T00:00:00'; + } else { + $data[ $key ] = $this->normalize_fixture( $value, "$path.$key" ); + } + } + + return $data; + } +} diff --git a/tests/qunit/fixtures/wp-api-generated.js b/tests/qunit/fixtures/wp-api-generated.js new file mode 100644 index 0000000000..a7f253282f --- /dev/null +++ b/tests/qunit/fixtures/wp-api-generated.js @@ -0,0 +1,4307 @@ +/** + * DO NOT EDIT + * Auto-generated by test_build_wp_api_client_fixtures + */ +var mockedApiResponse = {}; +/* jshint -W109 */ + +mockedApiResponse.Schema = { + "name": "Test Blog", + "description": "Just another WordPress site", + "url": "http://example.org", + "home": "http://example.org", + "namespaces": [ + "oembed/1.0", + "wp/v2" + ], + "authentication": [], + "routes": { + "/": { + "namespace": "", + "methods": [ + "GET" + ], + "endpoints": [ + { + "methods": [ + "GET" + ], + "args": { + "context": { + "required": false, + "default": "view" + } + } + } + ], + "_links": { + "self": "http://example.org/?rest_route=/" + } + }, + "/oembed/1.0": { + "namespace": "oembed/1.0", + "methods": [ + "GET" + ], + "endpoints": [ + { + "methods": [ + "GET" + ], + "args": { + "namespace": { + "required": false, + "default": "oembed/1.0" + }, + "context": { + "required": false, + "default": "view" + } + } + } + ], + "_links": { + "self": "http://example.org/?rest_route=/oembed/1.0" + } + }, + "/oembed/1.0/embed": { + "namespace": "oembed/1.0", + "methods": [ + "GET" + ], + "endpoints": [ + { + "methods": [ + "GET" + ], + "args": { + "url": { + "required": true + }, + "format": { + "required": false, + "default": "json" + }, + "maxwidth": { + "required": false, + "default": 600 + } + } + } + ], + "_links": { + "self": "http://example.org/?rest_route=/oembed/1.0/embed" + } + }, + "/wp/v2": { + "namespace": "wp/v2", + "methods": [ + "GET" + ], + "endpoints": [ + { + "methods": [ + "GET" + ], + "args": { + "namespace": { + "required": false, + "default": "wp/v2" + }, + "context": { + "required": false, + "default": "view" + } + } + } + ], + "_links": { + "self": "http://example.org/?rest_route=/wp/v2" + } + }, + "/wp/v2/posts": { + "namespace": "wp/v2", + "methods": [ + "GET", + "POST" + ], + "endpoints": [ + { + "methods": [ + "GET" + ], + "args": { + "context": { + "required": false, + "default": "view", + "enum": [ + "view", + "embed", + "edit" + ], + "description": "Scope under which the request is made; determines fields present in response.", + "type": "string" + }, + "page": { + "required": false, + "default": 1, + "description": "Current page of the collection.", + "type": "integer" + }, + "per_page": { + "required": false, + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "type": "integer" + }, + "search": { + "required": false, + "description": "Limit results to those matching a string.", + "type": "string" + }, + "after": { + "required": false, + "description": "Limit response to posts published after a given ISO8601 compliant date.", + "type": "string" + }, + "author": { + "required": false, + "default": [], + "description": "Limit result set to posts assigned to specific authors.", + "type": "array", + "items": { + "type": "integer" + } + }, + "author_exclude": { + "required": false, + "default": [], + "description": "Ensure result set excludes posts assigned to specific authors.", + "type": "array", + "items": { + "type": "integer" + } + }, + "before": { + "required": false, + "description": "Limit response to posts published before a given ISO8601 compliant date.", + "type": "string" + }, + "exclude": { + "required": false, + "default": [], + "description": "Ensure result set excludes specific IDs.", + "type": "array", + "items": { + "type": "integer" + } + }, + "include": { + "required": false, + "default": [], + "description": "Limit result set to specific IDs.", + "type": "array", + "items": { + "type": "integer" + } + }, + "offset": { + "required": false, + "description": "Offset the result set by a specific number of items.", + "type": "integer" + }, + "order": { + "required": false, + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "description": "Order sort attribute ascending or descending.", + "type": "string" + }, + "orderby": { + "required": false, + "default": "date", + "enum": [ + "date", + "relevance", + "id", + "include", + "title", + "slug" + ], + "description": "Sort collection by object attribute.", + "type": "string" + }, + "slug": { + "required": false, + "description": "Limit result set to posts with one or more specific slugs.", + "type": "array", + "items": { + "type": "string" + } + }, + "status": { + "required": false, + "default": "publish", + "description": "Limit result set to posts assigned one or more statuses.", + "type": "array", + "items": { + "enum": [ + "publish", + "future", + "draft", + "pending", + "private", + "trash", + "auto-draft", + "inherit", + "any" + ], + "type": "string" + } + }, + "categories": { + "required": false, + "default": [], + "description": "Limit result set to all items that have the specified term assigned in the categories taxonomy.", + "type": "array", + "items": { + "type": "integer" + } + }, + "categories_exclude": { + "required": false, + "default": [], + "description": "Limit result set to all items except those that have the specified term assigned in the categories taxonomy.", + "type": "array", + "items": { + "type": "integer" + } + }, + "tags": { + "required": false, + "default": [], + "description": "Limit result set to all items that have the specified term assigned in the tags taxonomy.", + "type": "array", + "items": { + "type": "integer" + } + }, + "tags_exclude": { + "required": false, + "default": [], + "description": "Limit result set to all items except those that have the specified term assigned in the tags taxonomy.", + "type": "array", + "items": { + "type": "integer" + } + }, + "sticky": { + "required": false, + "description": "Limit result set to items that are sticky.", + "type": "boolean" + } + } + }, + { + "methods": [ + "POST" + ], + "args": { + "date": { + "required": false, + "description": "The date the object was published, in the site's timezone.", + "type": "string" + }, + "date_gmt": { + "required": false, + "description": "The date the object was published, as GMT.", + "type": "string" + }, + "slug": { + "required": false, + "description": "An alphanumeric identifier for the object unique to its type.", + "type": "string" + }, + "status": { + "required": false, + "enum": [ + "publish", + "future", + "draft", + "pending", + "private" + ], + "description": "A named status for the object.", + "type": "string" + }, + "password": { + "required": false, + "description": "A password to protect access to the content and excerpt.", + "type": "string" + }, + "title": { + "required": false, + "description": "The title for the object.", + "type": "object" + }, + "content": { + "required": false, + "description": "The content for the object.", + "type": "object" + }, + "author": { + "required": false, + "description": "The ID for the author of the object.", + "type": "integer" + }, + "excerpt": { + "required": false, + "description": "The excerpt for the object.", + "type": "object" + }, + "featured_media": { + "required": false, + "description": "The ID of the featured media for the object.", + "type": "integer" + }, + "comment_status": { + "required": false, + "enum": [ + "open", + "closed" + ], + "description": "Whether or not comments are open on the object.", + "type": "string" + }, + "ping_status": { + "required": false, + "enum": [ + "open", + "closed" + ], + "description": "Whether or not the object can be pinged.", + "type": "string" + }, + "format": { + "required": false, + "enum": [ + "standard" + ], + "description": "The format for the object.", + "type": "string" + }, + "meta": { + "required": false, + "description": "Meta fields.", + "type": "object" + }, + "sticky": { + "required": false, + "description": "Whether or not the object should be treated as sticky.", + "type": "boolean" + }, + "template": { + "required": false, + "enum": [ + "" + ], + "description": "The theme file to use to display the object.", + "type": "string" + }, + "categories": { + "required": false, + "description": "The terms assigned to the object in the category taxonomy.", + "type": "array", + "items": { + "type": "integer" + } + }, + "tags": { + "required": false, + "description": "The terms assigned to the object in the post_tag taxonomy.", + "type": "array", + "items": { + "type": "integer" + } + } + } + } + ], + "_links": { + "self": "http://example.org/?rest_route=/wp/v2/posts" + } + }, + "/wp/v2/posts/(?P[\\d]+)": { + "namespace": "wp/v2", + "methods": [ + "GET", + "POST", + "PUT", + "PATCH", + "DELETE" + ], + "endpoints": [ + { + "methods": [ + "GET" + ], + "args": { + "id": { + "required": false, + "description": "Unique identifier for the object.", + "type": "integer" + }, + "context": { + "required": false, + "default": "view", + "enum": [ + "view", + "embed", + "edit" + ], + "description": "Scope under which the request is made; determines fields present in response.", + "type": "string" + }, + "password": { + "required": false, + "description": "The password for the post if it is password protected.", + "type": "string" + } + } + }, + { + "methods": [ + "POST", + "PUT", + "PATCH" + ], + "args": { + "id": { + "required": false, + "description": "Unique identifier for the object.", + "type": "integer" + }, + "date": { + "required": false, + "description": "The date the object was published, in the site's timezone.", + "type": "string" + }, + "date_gmt": { + "required": false, + "description": "The date the object was published, as GMT.", + "type": "string" + }, + "slug": { + "required": false, + "description": "An alphanumeric identifier for the object unique to its type.", + "type": "string" + }, + "status": { + "required": false, + "enum": [ + "publish", + "future", + "draft", + "pending", + "private" + ], + "description": "A named status for the object.", + "type": "string" + }, + "password": { + "required": false, + "description": "A password to protect access to the content and excerpt.", + "type": "string" + }, + "title": { + "required": false, + "description": "The title for the object.", + "type": "object" + }, + "content": { + "required": false, + "description": "The content for the object.", + "type": "object" + }, + "author": { + "required": false, + "description": "The ID for the author of the object.", + "type": "integer" + }, + "excerpt": { + "required": false, + "description": "The excerpt for the object.", + "type": "object" + }, + "featured_media": { + "required": false, + "description": "The ID of the featured media for the object.", + "type": "integer" + }, + "comment_status": { + "required": false, + "enum": [ + "open", + "closed" + ], + "description": "Whether or not comments are open on the object.", + "type": "string" + }, + "ping_status": { + "required": false, + "enum": [ + "open", + "closed" + ], + "description": "Whether or not the object can be pinged.", + "type": "string" + }, + "format": { + "required": false, + "enum": [ + "standard" + ], + "description": "The format for the object.", + "type": "string" + }, + "meta": { + "required": false, + "description": "Meta fields.", + "type": "object" + }, + "sticky": { + "required": false, + "description": "Whether or not the object should be treated as sticky.", + "type": "boolean" + }, + "template": { + "required": false, + "enum": [ + "" + ], + "description": "The theme file to use to display the object.", + "type": "string" + }, + "categories": { + "required": false, + "description": "The terms assigned to the object in the category taxonomy.", + "type": "array", + "items": { + "type": "integer" + } + }, + "tags": { + "required": false, + "description": "The terms assigned to the object in the post_tag taxonomy.", + "type": "array", + "items": { + "type": "integer" + } + } + } + }, + { + "methods": [ + "DELETE" + ], + "args": { + "id": { + "required": false, + "description": "Unique identifier for the object.", + "type": "integer" + }, + "force": { + "required": false, + "default": false, + "description": "Whether to bypass trash and force deletion.", + "type": "boolean" + } + } + } + ] + }, + "/wp/v2/posts/(?P[\\d]+)/revisions": { + "namespace": "wp/v2", + "methods": [ + "GET" + ], + "endpoints": [ + { + "methods": [ + "GET" + ], + "args": { + "parent": { + "required": false, + "description": "The ID for the parent of the object.", + "type": "integer" + }, + "context": { + "required": false, + "default": "view", + "enum": [ + "view", + "embed", + "edit" + ], + "description": "Scope under which the request is made; determines fields present in response.", + "type": "string" + } + } + } + ] + }, + "/wp/v2/posts/(?P[\\d]+)/revisions/(?P[\\d]+)": { + "namespace": "wp/v2", + "methods": [ + "GET", + "DELETE" + ], + "endpoints": [ + { + "methods": [ + "GET" + ], + "args": { + "parent": { + "required": false, + "description": "The ID for the parent of the object.", + "type": "integer" + }, + "id": { + "required": false, + "description": "Unique identifier for the object.", + "type": "integer" + }, + "context": { + "required": false, + "default": "view", + "enum": [ + "view", + "embed", + "edit" + ], + "description": "Scope under which the request is made; determines fields present in response.", + "type": "string" + } + } + }, + { + "methods": [ + "DELETE" + ], + "args": { + "parent": { + "required": false, + "description": "The ID for the parent of the object.", + "type": "integer" + }, + "id": { + "required": false, + "description": "Unique identifier for the object.", + "type": "integer" + }, + "force": { + "required": false, + "default": false, + "description": "Required to be true, as revisions do not support trashing.", + "type": "boolean" + } + } + } + ] + }, + "/wp/v2/pages": { + "namespace": "wp/v2", + "methods": [ + "GET", + "POST" + ], + "endpoints": [ + { + "methods": [ + "GET" + ], + "args": { + "context": { + "required": false, + "default": "view", + "enum": [ + "view", + "embed", + "edit" + ], + "description": "Scope under which the request is made; determines fields present in response.", + "type": "string" + }, + "page": { + "required": false, + "default": 1, + "description": "Current page of the collection.", + "type": "integer" + }, + "per_page": { + "required": false, + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "type": "integer" + }, + "search": { + "required": false, + "description": "Limit results to those matching a string.", + "type": "string" + }, + "after": { + "required": false, + "description": "Limit response to posts published after a given ISO8601 compliant date.", + "type": "string" + }, + "author": { + "required": false, + "default": [], + "description": "Limit result set to posts assigned to specific authors.", + "type": "array", + "items": { + "type": "integer" + } + }, + "author_exclude": { + "required": false, + "default": [], + "description": "Ensure result set excludes posts assigned to specific authors.", + "type": "array", + "items": { + "type": "integer" + } + }, + "before": { + "required": false, + "description": "Limit response to posts published before a given ISO8601 compliant date.", + "type": "string" + }, + "exclude": { + "required": false, + "default": [], + "description": "Ensure result set excludes specific IDs.", + "type": "array", + "items": { + "type": "integer" + } + }, + "include": { + "required": false, + "default": [], + "description": "Limit result set to specific IDs.", + "type": "array", + "items": { + "type": "integer" + } + }, + "menu_order": { + "required": false, + "description": "Limit result set to posts with a specific menu_order value.", + "type": "integer" + }, + "offset": { + "required": false, + "description": "Offset the result set by a specific number of items.", + "type": "integer" + }, + "order": { + "required": false, + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "description": "Order sort attribute ascending or descending.", + "type": "string" + }, + "orderby": { + "required": false, + "default": "date", + "enum": [ + "date", + "relevance", + "id", + "include", + "title", + "slug", + "menu_order" + ], + "description": "Sort collection by object attribute.", + "type": "string" + }, + "parent": { + "required": false, + "default": [], + "description": "Limit result set to those of particular parent IDs.", + "type": "array", + "items": { + "type": "integer" + } + }, + "parent_exclude": { + "required": false, + "default": [], + "description": "Limit result set to all items except those of a particular parent ID.", + "type": "array", + "items": { + "type": "integer" + } + }, + "slug": { + "required": false, + "description": "Limit result set to posts with one or more specific slugs.", + "type": "array", + "items": { + "type": "string" + } + }, + "status": { + "required": false, + "default": "publish", + "description": "Limit result set to posts assigned one or more statuses.", + "type": "array", + "items": { + "enum": [ + "publish", + "future", + "draft", + "pending", + "private", + "trash", + "auto-draft", + "inherit", + "any" + ], + "type": "string" + } + } + } + }, + { + "methods": [ + "POST" + ], + "args": { + "date": { + "required": false, + "description": "The date the object was published, in the site's timezone.", + "type": "string" + }, + "date_gmt": { + "required": false, + "description": "The date the object was published, as GMT.", + "type": "string" + }, + "slug": { + "required": false, + "description": "An alphanumeric identifier for the object unique to its type.", + "type": "string" + }, + "status": { + "required": false, + "enum": [ + "publish", + "future", + "draft", + "pending", + "private" + ], + "description": "A named status for the object.", + "type": "string" + }, + "password": { + "required": false, + "description": "A password to protect access to the content and excerpt.", + "type": "string" + }, + "parent": { + "required": false, + "description": "The ID for the parent of the object.", + "type": "integer" + }, + "title": { + "required": false, + "description": "The title for the object.", + "type": "object" + }, + "content": { + "required": false, + "description": "The content for the object.", + "type": "object" + }, + "author": { + "required": false, + "description": "The ID for the author of the object.", + "type": "integer" + }, + "excerpt": { + "required": false, + "description": "The excerpt for the object.", + "type": "object" + }, + "featured_media": { + "required": false, + "description": "The ID of the featured media for the object.", + "type": "integer" + }, + "comment_status": { + "required": false, + "enum": [ + "open", + "closed" + ], + "description": "Whether or not comments are open on the object.", + "type": "string" + }, + "ping_status": { + "required": false, + "enum": [ + "open", + "closed" + ], + "description": "Whether or not the object can be pinged.", + "type": "string" + }, + "menu_order": { + "required": false, + "description": "The order of the object in relation to other object of its type.", + "type": "integer" + }, + "meta": { + "required": false, + "description": "Meta fields.", + "type": "object" + }, + "template": { + "required": false, + "enum": [ + "" + ], + "description": "The theme file to use to display the object.", + "type": "string" + } + } + } + ], + "_links": { + "self": "http://example.org/?rest_route=/wp/v2/pages" + } + }, + "/wp/v2/pages/(?P[\\d]+)": { + "namespace": "wp/v2", + "methods": [ + "GET", + "POST", + "PUT", + "PATCH", + "DELETE" + ], + "endpoints": [ + { + "methods": [ + "GET" + ], + "args": { + "id": { + "required": false, + "description": "Unique identifier for the object.", + "type": "integer" + }, + "context": { + "required": false, + "default": "view", + "enum": [ + "view", + "embed", + "edit" + ], + "description": "Scope under which the request is made; determines fields present in response.", + "type": "string" + }, + "password": { + "required": false, + "description": "The password for the post if it is password protected.", + "type": "string" + } + } + }, + { + "methods": [ + "POST", + "PUT", + "PATCH" + ], + "args": { + "id": { + "required": false, + "description": "Unique identifier for the object.", + "type": "integer" + }, + "date": { + "required": false, + "description": "The date the object was published, in the site's timezone.", + "type": "string" + }, + "date_gmt": { + "required": false, + "description": "The date the object was published, as GMT.", + "type": "string" + }, + "slug": { + "required": false, + "description": "An alphanumeric identifier for the object unique to its type.", + "type": "string" + }, + "status": { + "required": false, + "enum": [ + "publish", + "future", + "draft", + "pending", + "private" + ], + "description": "A named status for the object.", + "type": "string" + }, + "password": { + "required": false, + "description": "A password to protect access to the content and excerpt.", + "type": "string" + }, + "parent": { + "required": false, + "description": "The ID for the parent of the object.", + "type": "integer" + }, + "title": { + "required": false, + "description": "The title for the object.", + "type": "object" + }, + "content": { + "required": false, + "description": "The content for the object.", + "type": "object" + }, + "author": { + "required": false, + "description": "The ID for the author of the object.", + "type": "integer" + }, + "excerpt": { + "required": false, + "description": "The excerpt for the object.", + "type": "object" + }, + "featured_media": { + "required": false, + "description": "The ID of the featured media for the object.", + "type": "integer" + }, + "comment_status": { + "required": false, + "enum": [ + "open", + "closed" + ], + "description": "Whether or not comments are open on the object.", + "type": "string" + }, + "ping_status": { + "required": false, + "enum": [ + "open", + "closed" + ], + "description": "Whether or not the object can be pinged.", + "type": "string" + }, + "menu_order": { + "required": false, + "description": "The order of the object in relation to other object of its type.", + "type": "integer" + }, + "meta": { + "required": false, + "description": "Meta fields.", + "type": "object" + }, + "template": { + "required": false, + "enum": [ + "" + ], + "description": "The theme file to use to display the object.", + "type": "string" + } + } + }, + { + "methods": [ + "DELETE" + ], + "args": { + "id": { + "required": false, + "description": "Unique identifier for the object.", + "type": "integer" + }, + "force": { + "required": false, + "default": false, + "description": "Whether to bypass trash and force deletion.", + "type": "boolean" + } + } + } + ] + }, + "/wp/v2/pages/(?P[\\d]+)/revisions": { + "namespace": "wp/v2", + "methods": [ + "GET" + ], + "endpoints": [ + { + "methods": [ + "GET" + ], + "args": { + "parent": { + "required": false, + "description": "The ID for the parent of the object.", + "type": "integer" + }, + "context": { + "required": false, + "default": "view", + "enum": [ + "view", + "embed", + "edit" + ], + "description": "Scope under which the request is made; determines fields present in response.", + "type": "string" + } + } + } + ] + }, + "/wp/v2/pages/(?P[\\d]+)/revisions/(?P[\\d]+)": { + "namespace": "wp/v2", + "methods": [ + "GET", + "DELETE" + ], + "endpoints": [ + { + "methods": [ + "GET" + ], + "args": { + "parent": { + "required": false, + "description": "The ID for the parent of the object.", + "type": "integer" + }, + "id": { + "required": false, + "description": "Unique identifier for the object.", + "type": "integer" + }, + "context": { + "required": false, + "default": "view", + "enum": [ + "view", + "embed", + "edit" + ], + "description": "Scope under which the request is made; determines fields present in response.", + "type": "string" + } + } + }, + { + "methods": [ + "DELETE" + ], + "args": { + "parent": { + "required": false, + "description": "The ID for the parent of the object.", + "type": "integer" + }, + "id": { + "required": false, + "description": "Unique identifier for the object.", + "type": "integer" + }, + "force": { + "required": false, + "default": false, + "description": "Required to be true, as revisions do not support trashing.", + "type": "boolean" + } + } + } + ] + }, + "/wp/v2/media": { + "namespace": "wp/v2", + "methods": [ + "GET", + "POST" + ], + "endpoints": [ + { + "methods": [ + "GET" + ], + "args": { + "context": { + "required": false, + "default": "view", + "enum": [ + "view", + "embed", + "edit" + ], + "description": "Scope under which the request is made; determines fields present in response.", + "type": "string" + }, + "page": { + "required": false, + "default": 1, + "description": "Current page of the collection.", + "type": "integer" + }, + "per_page": { + "required": false, + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "type": "integer" + }, + "search": { + "required": false, + "description": "Limit results to those matching a string.", + "type": "string" + }, + "after": { + "required": false, + "description": "Limit response to posts published after a given ISO8601 compliant date.", + "type": "string" + }, + "author": { + "required": false, + "default": [], + "description": "Limit result set to posts assigned to specific authors.", + "type": "array", + "items": { + "type": "integer" + } + }, + "author_exclude": { + "required": false, + "default": [], + "description": "Ensure result set excludes posts assigned to specific authors.", + "type": "array", + "items": { + "type": "integer" + } + }, + "before": { + "required": false, + "description": "Limit response to posts published before a given ISO8601 compliant date.", + "type": "string" + }, + "exclude": { + "required": false, + "default": [], + "description": "Ensure result set excludes specific IDs.", + "type": "array", + "items": { + "type": "integer" + } + }, + "include": { + "required": false, + "default": [], + "description": "Limit result set to specific IDs.", + "type": "array", + "items": { + "type": "integer" + } + }, + "offset": { + "required": false, + "description": "Offset the result set by a specific number of items.", + "type": "integer" + }, + "order": { + "required": false, + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "description": "Order sort attribute ascending or descending.", + "type": "string" + }, + "orderby": { + "required": false, + "default": "date", + "enum": [ + "date", + "relevance", + "id", + "include", + "title", + "slug" + ], + "description": "Sort collection by object attribute.", + "type": "string" + }, + "parent": { + "required": false, + "default": [], + "description": "Limit result set to those of particular parent IDs.", + "type": "array", + "items": { + "type": "integer" + } + }, + "parent_exclude": { + "required": false, + "default": [], + "description": "Limit result set to all items except those of a particular parent ID.", + "type": "array", + "items": { + "type": "integer" + } + }, + "slug": { + "required": false, + "description": "Limit result set to posts with one or more specific slugs.", + "type": "array", + "items": { + "type": "string" + } + }, + "status": { + "required": false, + "default": "inherit", + "description": "Limit result set to posts assigned one or more statuses.", + "type": "array", + "items": { + "enum": [ + "inherit", + "private", + "trash" + ], + "type": "string" + } + }, + "media_type": { + "required": false, + "enum": [ + "image", + "video", + "text", + "application", + "audio" + ], + "description": "Limit result set to attachments of a particular media type.", + "type": "string" + }, + "mime_type": { + "required": false, + "description": "Limit result set to attachments of a particular MIME type.", + "type": "string" + } + } + }, + { + "methods": [ + "POST" + ], + "args": { + "date": { + "required": false, + "description": "The date the object was published, in the site's timezone.", + "type": "string" + }, + "date_gmt": { + "required": false, + "description": "The date the object was published, as GMT.", + "type": "string" + }, + "slug": { + "required": false, + "description": "An alphanumeric identifier for the object unique to its type.", + "type": "string" + }, + "status": { + "required": false, + "enum": [ + "publish", + "future", + "draft", + "pending", + "private" + ], + "description": "A named status for the object.", + "type": "string" + }, + "title": { + "required": false, + "description": "The title for the object.", + "type": "object" + }, + "author": { + "required": false, + "description": "The ID for the author of the object.", + "type": "integer" + }, + "comment_status": { + "required": false, + "enum": [ + "open", + "closed" + ], + "description": "Whether or not comments are open on the object.", + "type": "string" + }, + "ping_status": { + "required": false, + "enum": [ + "open", + "closed" + ], + "description": "Whether or not the object can be pinged.", + "type": "string" + }, + "meta": { + "required": false, + "description": "Meta fields.", + "type": "object" + }, + "template": { + "required": false, + "enum": [ + "" + ], + "description": "The theme file to use to display the object.", + "type": "string" + }, + "alt_text": { + "required": false, + "description": "Alternative text to display when attachment is not displayed.", + "type": "string" + }, + "caption": { + "required": false, + "description": "The attachment caption.", + "type": "object" + }, + "description": { + "required": false, + "description": "The attachment description.", + "type": "object" + }, + "post": { + "required": false, + "description": "The ID for the associated post of the attachment.", + "type": "integer" + } + } + } + ], + "_links": { + "self": "http://example.org/?rest_route=/wp/v2/media" + } + }, + "/wp/v2/media/(?P[\\d]+)": { + "namespace": "wp/v2", + "methods": [ + "GET", + "POST", + "PUT", + "PATCH", + "DELETE" + ], + "endpoints": [ + { + "methods": [ + "GET" + ], + "args": { + "id": { + "required": false, + "description": "Unique identifier for the object.", + "type": "integer" + }, + "context": { + "required": false, + "default": "view", + "enum": [ + "view", + "embed", + "edit" + ], + "description": "Scope under which the request is made; determines fields present in response.", + "type": "string" + } + } + }, + { + "methods": [ + "POST", + "PUT", + "PATCH" + ], + "args": { + "id": { + "required": false, + "description": "Unique identifier for the object.", + "type": "integer" + }, + "date": { + "required": false, + "description": "The date the object was published, in the site's timezone.", + "type": "string" + }, + "date_gmt": { + "required": false, + "description": "The date the object was published, as GMT.", + "type": "string" + }, + "slug": { + "required": false, + "description": "An alphanumeric identifier for the object unique to its type.", + "type": "string" + }, + "status": { + "required": false, + "enum": [ + "publish", + "future", + "draft", + "pending", + "private" + ], + "description": "A named status for the object.", + "type": "string" + }, + "title": { + "required": false, + "description": "The title for the object.", + "type": "object" + }, + "author": { + "required": false, + "description": "The ID for the author of the object.", + "type": "integer" + }, + "comment_status": { + "required": false, + "enum": [ + "open", + "closed" + ], + "description": "Whether or not comments are open on the object.", + "type": "string" + }, + "ping_status": { + "required": false, + "enum": [ + "open", + "closed" + ], + "description": "Whether or not the object can be pinged.", + "type": "string" + }, + "meta": { + "required": false, + "description": "Meta fields.", + "type": "object" + }, + "template": { + "required": false, + "enum": [ + "" + ], + "description": "The theme file to use to display the object.", + "type": "string" + }, + "alt_text": { + "required": false, + "description": "Alternative text to display when attachment is not displayed.", + "type": "string" + }, + "caption": { + "required": false, + "description": "The attachment caption.", + "type": "object" + }, + "description": { + "required": false, + "description": "The attachment description.", + "type": "object" + }, + "post": { + "required": false, + "description": "The ID for the associated post of the attachment.", + "type": "integer" + } + } + }, + { + "methods": [ + "DELETE" + ], + "args": { + "id": { + "required": false, + "description": "Unique identifier for the object.", + "type": "integer" + }, + "force": { + "required": false, + "default": false, + "description": "Whether to bypass trash and force deletion.", + "type": "boolean" + } + } + } + ] + }, + "/wp/v2/types": { + "namespace": "wp/v2", + "methods": [ + "GET" + ], + "endpoints": [ + { + "methods": [ + "GET" + ], + "args": { + "context": { + "required": false, + "default": "view", + "enum": [ + "view", + "embed", + "edit" + ], + "description": "Scope under which the request is made; determines fields present in response.", + "type": "string" + } + } + } + ], + "_links": { + "self": "http://example.org/?rest_route=/wp/v2/types" + } + }, + "/wp/v2/types/(?P[\\w-]+)": { + "namespace": "wp/v2", + "methods": [ + "GET" + ], + "endpoints": [ + { + "methods": [ + "GET" + ], + "args": { + "type": { + "required": false, + "description": "An alphanumeric identifier for the post type.", + "type": "string" + }, + "context": { + "required": false, + "default": "view", + "enum": [ + "view", + "embed", + "edit" + ], + "description": "Scope under which the request is made; determines fields present in response.", + "type": "string" + } + } + } + ] + }, + "/wp/v2/statuses": { + "namespace": "wp/v2", + "methods": [ + "GET" + ], + "endpoints": [ + { + "methods": [ + "GET" + ], + "args": { + "context": { + "required": false, + "default": "view", + "enum": [ + "view", + "embed", + "edit" + ], + "description": "Scope under which the request is made; determines fields present in response.", + "type": "string" + } + } + } + ], + "_links": { + "self": "http://example.org/?rest_route=/wp/v2/statuses" + } + }, + "/wp/v2/statuses/(?P[\\w-]+)": { + "namespace": "wp/v2", + "methods": [ + "GET" + ], + "endpoints": [ + { + "methods": [ + "GET" + ], + "args": { + "status": { + "required": false, + "description": "An alphanumeric identifier for the status.", + "type": "string" + }, + "context": { + "required": false, + "default": "view", + "enum": [ + "view", + "embed", + "edit" + ], + "description": "Scope under which the request is made; determines fields present in response.", + "type": "string" + } + } + } + ] + }, + "/wp/v2/taxonomies": { + "namespace": "wp/v2", + "methods": [ + "GET" + ], + "endpoints": [ + { + "methods": [ + "GET" + ], + "args": { + "context": { + "required": false, + "default": "view", + "enum": [ + "view", + "embed", + "edit" + ], + "description": "Scope under which the request is made; determines fields present in response.", + "type": "string" + }, + "type": { + "required": false, + "description": "Limit results to taxonomies associated with a specific post type.", + "type": "string" + } + } + } + ], + "_links": { + "self": "http://example.org/?rest_route=/wp/v2/taxonomies" + } + }, + "/wp/v2/taxonomies/(?P[\\w-]+)": { + "namespace": "wp/v2", + "methods": [ + "GET" + ], + "endpoints": [ + { + "methods": [ + "GET" + ], + "args": { + "taxonomy": { + "required": false, + "description": "An alphanumeric identifier for the taxonomy.", + "type": "string" + }, + "context": { + "required": false, + "default": "view", + "enum": [ + "view", + "embed", + "edit" + ], + "description": "Scope under which the request is made; determines fields present in response.", + "type": "string" + } + } + } + ] + }, + "/wp/v2/categories": { + "namespace": "wp/v2", + "methods": [ + "GET", + "POST" + ], + "endpoints": [ + { + "methods": [ + "GET" + ], + "args": { + "context": { + "required": false, + "default": "view", + "enum": [ + "view", + "embed", + "edit" + ], + "description": "Scope under which the request is made; determines fields present in response.", + "type": "string" + }, + "page": { + "required": false, + "default": 1, + "description": "Current page of the collection.", + "type": "integer" + }, + "per_page": { + "required": false, + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "type": "integer" + }, + "search": { + "required": false, + "description": "Limit results to those matching a string.", + "type": "string" + }, + "exclude": { + "required": false, + "default": [], + "description": "Ensure result set excludes specific IDs.", + "type": "array", + "items": { + "type": "integer" + } + }, + "include": { + "required": false, + "default": [], + "description": "Limit result set to specific IDs.", + "type": "array", + "items": { + "type": "integer" + } + }, + "order": { + "required": false, + "default": "asc", + "enum": [ + "asc", + "desc" + ], + "description": "Order sort attribute ascending or descending.", + "type": "string" + }, + "orderby": { + "required": false, + "default": "name", + "enum": [ + "id", + "include", + "name", + "slug", + "term_group", + "description", + "count" + ], + "description": "Sort collection by term attribute.", + "type": "string" + }, + "hide_empty": { + "required": false, + "default": false, + "description": "Whether to hide terms not assigned to any posts.", + "type": "boolean" + }, + "parent": { + "required": false, + "description": "Limit result set to terms assigned to a specific parent.", + "type": "integer" + }, + "post": { + "required": false, + "description": "Limit result set to terms assigned to a specific post.", + "type": "integer" + }, + "slug": { + "required": false, + "description": "Limit result set to terms with a specific slug.", + "type": "string" + } + } + }, + { + "methods": [ + "POST" + ], + "args": { + "description": { + "required": false, + "description": "HTML description of the term.", + "type": "string" + }, + "name": { + "required": true, + "description": "HTML title for the term.", + "type": "string" + }, + "slug": { + "required": false, + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + }, + "parent": { + "required": false, + "description": "The parent term ID.", + "type": "integer" + }, + "meta": { + "required": false, + "description": "Meta fields.", + "type": "object" + } + } + } + ], + "_links": { + "self": "http://example.org/?rest_route=/wp/v2/categories" + } + }, + "/wp/v2/categories/(?P[\\d]+)": { + "namespace": "wp/v2", + "methods": [ + "GET", + "POST", + "PUT", + "PATCH", + "DELETE" + ], + "endpoints": [ + { + "methods": [ + "GET" + ], + "args": { + "id": { + "required": false, + "description": "Unique identifier for the term.", + "type": "integer" + }, + "context": { + "required": false, + "default": "view", + "enum": [ + "view", + "embed", + "edit" + ], + "description": "Scope under which the request is made; determines fields present in response.", + "type": "string" + } + } + }, + { + "methods": [ + "POST", + "PUT", + "PATCH" + ], + "args": { + "id": { + "required": false, + "description": "Unique identifier for the term.", + "type": "integer" + }, + "description": { + "required": false, + "description": "HTML description of the term.", + "type": "string" + }, + "name": { + "required": false, + "description": "HTML title for the term.", + "type": "string" + }, + "slug": { + "required": false, + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + }, + "parent": { + "required": false, + "description": "The parent term ID.", + "type": "integer" + }, + "meta": { + "required": false, + "description": "Meta fields.", + "type": "object" + } + } + }, + { + "methods": [ + "DELETE" + ], + "args": { + "id": { + "required": false, + "description": "Unique identifier for the term.", + "type": "integer" + }, + "force": { + "required": false, + "default": false, + "description": "Required to be true, as terms do not support trashing.", + "type": "boolean" + } + } + } + ] + }, + "/wp/v2/tags": { + "namespace": "wp/v2", + "methods": [ + "GET", + "POST" + ], + "endpoints": [ + { + "methods": [ + "GET" + ], + "args": { + "context": { + "required": false, + "default": "view", + "enum": [ + "view", + "embed", + "edit" + ], + "description": "Scope under which the request is made; determines fields present in response.", + "type": "string" + }, + "page": { + "required": false, + "default": 1, + "description": "Current page of the collection.", + "type": "integer" + }, + "per_page": { + "required": false, + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "type": "integer" + }, + "search": { + "required": false, + "description": "Limit results to those matching a string.", + "type": "string" + }, + "exclude": { + "required": false, + "default": [], + "description": "Ensure result set excludes specific IDs.", + "type": "array", + "items": { + "type": "integer" + } + }, + "include": { + "required": false, + "default": [], + "description": "Limit result set to specific IDs.", + "type": "array", + "items": { + "type": "integer" + } + }, + "offset": { + "required": false, + "description": "Offset the result set by a specific number of items.", + "type": "integer" + }, + "order": { + "required": false, + "default": "asc", + "enum": [ + "asc", + "desc" + ], + "description": "Order sort attribute ascending or descending.", + "type": "string" + }, + "orderby": { + "required": false, + "default": "name", + "enum": [ + "id", + "include", + "name", + "slug", + "term_group", + "description", + "count" + ], + "description": "Sort collection by term attribute.", + "type": "string" + }, + "hide_empty": { + "required": false, + "default": false, + "description": "Whether to hide terms not assigned to any posts.", + "type": "boolean" + }, + "post": { + "required": false, + "description": "Limit result set to terms assigned to a specific post.", + "type": "integer" + }, + "slug": { + "required": false, + "description": "Limit result set to terms with a specific slug.", + "type": "string" + } + } + }, + { + "methods": [ + "POST" + ], + "args": { + "description": { + "required": false, + "description": "HTML description of the term.", + "type": "string" + }, + "name": { + "required": true, + "description": "HTML title for the term.", + "type": "string" + }, + "slug": { + "required": false, + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + }, + "meta": { + "required": false, + "description": "Meta fields.", + "type": "object" + } + } + } + ], + "_links": { + "self": "http://example.org/?rest_route=/wp/v2/tags" + } + }, + "/wp/v2/tags/(?P[\\d]+)": { + "namespace": "wp/v2", + "methods": [ + "GET", + "POST", + "PUT", + "PATCH", + "DELETE" + ], + "endpoints": [ + { + "methods": [ + "GET" + ], + "args": { + "id": { + "required": false, + "description": "Unique identifier for the term.", + "type": "integer" + }, + "context": { + "required": false, + "default": "view", + "enum": [ + "view", + "embed", + "edit" + ], + "description": "Scope under which the request is made; determines fields present in response.", + "type": "string" + } + } + }, + { + "methods": [ + "POST", + "PUT", + "PATCH" + ], + "args": { + "id": { + "required": false, + "description": "Unique identifier for the term.", + "type": "integer" + }, + "description": { + "required": false, + "description": "HTML description of the term.", + "type": "string" + }, + "name": { + "required": false, + "description": "HTML title for the term.", + "type": "string" + }, + "slug": { + "required": false, + "description": "An alphanumeric identifier for the term unique to its type.", + "type": "string" + }, + "meta": { + "required": false, + "description": "Meta fields.", + "type": "object" + } + } + }, + { + "methods": [ + "DELETE" + ], + "args": { + "id": { + "required": false, + "description": "Unique identifier for the term.", + "type": "integer" + }, + "force": { + "required": false, + "default": false, + "description": "Required to be true, as terms do not support trashing.", + "type": "boolean" + } + } + } + ] + }, + "/wp/v2/users": { + "namespace": "wp/v2", + "methods": [ + "GET", + "POST" + ], + "endpoints": [ + { + "methods": [ + "GET" + ], + "args": { + "context": { + "required": false, + "default": "view", + "enum": [ + "view", + "embed", + "edit" + ], + "description": "Scope under which the request is made; determines fields present in response.", + "type": "string" + }, + "page": { + "required": false, + "default": 1, + "description": "Current page of the collection.", + "type": "integer" + }, + "per_page": { + "required": false, + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "type": "integer" + }, + "search": { + "required": false, + "description": "Limit results to those matching a string.", + "type": "string" + }, + "exclude": { + "required": false, + "default": [], + "description": "Ensure result set excludes specific IDs.", + "type": "array", + "items": { + "type": "integer" + } + }, + "include": { + "required": false, + "default": [], + "description": "Limit result set to specific IDs.", + "type": "array", + "items": { + "type": "integer" + } + }, + "offset": { + "required": false, + "description": "Offset the result set by a specific number of items.", + "type": "integer" + }, + "order": { + "required": false, + "default": "asc", + "enum": [ + "asc", + "desc" + ], + "description": "Order sort attribute ascending or descending.", + "type": "string" + }, + "orderby": { + "required": false, + "default": "name", + "enum": [ + "id", + "include", + "name", + "registered_date", + "slug", + "email", + "url" + ], + "description": "Sort collection by object attribute.", + "type": "string" + }, + "slug": { + "required": false, + "description": "Limit result set to users with a specific slug.", + "type": "string" + }, + "roles": { + "required": false, + "description": "Limit result set to users matching at least one specific role provided. Accepts csv list or single role.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + { + "methods": [ + "POST" + ], + "args": { + "username": { + "required": true, + "description": "Login name for the user.", + "type": "string" + }, + "name": { + "required": false, + "description": "Display name for the user.", + "type": "string" + }, + "first_name": { + "required": false, + "description": "First name for the user.", + "type": "string" + }, + "last_name": { + "required": false, + "description": "Last name for the user.", + "type": "string" + }, + "email": { + "required": true, + "description": "The email address for the user.", + "type": "string" + }, + "url": { + "required": false, + "description": "URL of the user.", + "type": "string" + }, + "description": { + "required": false, + "description": "Description of the user.", + "type": "string" + }, + "locale": { + "required": false, + "enum": [ + "", + "en_US", + "de_DE", + "en_GB", + "es_ES" + ], + "description": "Locale for the user.", + "type": "string" + }, + "nickname": { + "required": false, + "description": "The nickname for the user.", + "type": "string" + }, + "slug": { + "required": false, + "description": "An alphanumeric identifier for the user.", + "type": "string" + }, + "roles": { + "required": false, + "description": "Roles assigned to the user.", + "type": "array", + "items": { + "type": "string" + } + }, + "password": { + "required": true, + "description": "Password for the user (never included).", + "type": "string" + }, + "meta": { + "required": false, + "description": "Meta fields.", + "type": "object" + } + } + } + ], + "_links": { + "self": "http://example.org/?rest_route=/wp/v2/users" + } + }, + "/wp/v2/users/(?P[\\d]+)": { + "namespace": "wp/v2", + "methods": [ + "GET", + "POST", + "PUT", + "PATCH", + "DELETE" + ], + "endpoints": [ + { + "methods": [ + "GET" + ], + "args": { + "id": { + "required": false, + "description": "Unique identifier for the user.", + "type": "integer" + }, + "context": { + "required": false, + "default": "view", + "enum": [ + "view", + "embed", + "edit" + ], + "description": "Scope under which the request is made; determines fields present in response.", + "type": "string" + } + } + }, + { + "methods": [ + "POST", + "PUT", + "PATCH" + ], + "args": { + "id": { + "required": false, + "description": "Unique identifier for the user.", + "type": "integer" + }, + "username": { + "required": false, + "description": "Login name for the user.", + "type": "string" + }, + "name": { + "required": false, + "description": "Display name for the user.", + "type": "string" + }, + "first_name": { + "required": false, + "description": "First name for the user.", + "type": "string" + }, + "last_name": { + "required": false, + "description": "Last name for the user.", + "type": "string" + }, + "email": { + "required": false, + "description": "The email address for the user.", + "type": "string" + }, + "url": { + "required": false, + "description": "URL of the user.", + "type": "string" + }, + "description": { + "required": false, + "description": "Description of the user.", + "type": "string" + }, + "locale": { + "required": false, + "enum": [ + "", + "en_US", + "de_DE", + "en_GB", + "es_ES" + ], + "description": "Locale for the user.", + "type": "string" + }, + "nickname": { + "required": false, + "description": "The nickname for the user.", + "type": "string" + }, + "slug": { + "required": false, + "description": "An alphanumeric identifier for the user.", + "type": "string" + }, + "roles": { + "required": false, + "description": "Roles assigned to the user.", + "type": "array", + "items": { + "type": "string" + } + }, + "password": { + "required": false, + "description": "Password for the user (never included).", + "type": "string" + }, + "meta": { + "required": false, + "description": "Meta fields.", + "type": "object" + } + } + }, + { + "methods": [ + "DELETE" + ], + "args": { + "id": { + "required": false, + "description": "Unique identifier for the user.", + "type": "integer" + }, + "force": { + "required": false, + "default": false, + "description": "Required to be true, as users do not support trashing.", + "type": "boolean" + }, + "reassign": { + "required": true, + "description": "Reassign the deleted user's posts and links to this user ID.", + "type": "integer" + } + } + } + ] + }, + "/wp/v2/users/me": { + "namespace": "wp/v2", + "methods": [ + "GET", + "POST", + "PUT", + "PATCH", + "DELETE" + ], + "endpoints": [ + { + "methods": [ + "GET" + ], + "args": { + "context": { + "required": false, + "default": "view", + "enum": [ + "view", + "embed", + "edit" + ], + "description": "Scope under which the request is made; determines fields present in response.", + "type": "string" + } + } + }, + { + "methods": [ + "POST", + "PUT", + "PATCH" + ], + "args": { + "username": { + "required": false, + "description": "Login name for the user.", + "type": "string" + }, + "name": { + "required": false, + "description": "Display name for the user.", + "type": "string" + }, + "first_name": { + "required": false, + "description": "First name for the user.", + "type": "string" + }, + "last_name": { + "required": false, + "description": "Last name for the user.", + "type": "string" + }, + "email": { + "required": false, + "description": "The email address for the user.", + "type": "string" + }, + "url": { + "required": false, + "description": "URL of the user.", + "type": "string" + }, + "description": { + "required": false, + "description": "Description of the user.", + "type": "string" + }, + "locale": { + "required": false, + "enum": [ + "", + "en_US", + "de_DE", + "en_GB", + "es_ES" + ], + "description": "Locale for the user.", + "type": "string" + }, + "nickname": { + "required": false, + "description": "The nickname for the user.", + "type": "string" + }, + "slug": { + "required": false, + "description": "An alphanumeric identifier for the user.", + "type": "string" + }, + "roles": { + "required": false, + "description": "Roles assigned to the user.", + "type": "array", + "items": { + "type": "string" + } + }, + "password": { + "required": false, + "description": "Password for the user (never included).", + "type": "string" + }, + "meta": { + "required": false, + "description": "Meta fields.", + "type": "object" + } + } + }, + { + "methods": [ + "DELETE" + ], + "args": { + "force": { + "required": false, + "default": false, + "description": "Required to be true, as users do not support trashing.", + "type": "boolean" + }, + "reassign": { + "required": true, + "description": "Reassign the deleted user's posts and links to this user ID.", + "type": "integer" + } + } + } + ], + "_links": { + "self": "http://example.org/?rest_route=/wp/v2/users/me" + } + }, + "/wp/v2/comments": { + "namespace": "wp/v2", + "methods": [ + "GET", + "POST" + ], + "endpoints": [ + { + "methods": [ + "GET" + ], + "args": { + "context": { + "required": false, + "default": "view", + "enum": [ + "view", + "embed", + "edit" + ], + "description": "Scope under which the request is made; determines fields present in response.", + "type": "string" + }, + "page": { + "required": false, + "default": 1, + "description": "Current page of the collection.", + "type": "integer" + }, + "per_page": { + "required": false, + "default": 10, + "description": "Maximum number of items to be returned in result set.", + "type": "integer" + }, + "search": { + "required": false, + "description": "Limit results to those matching a string.", + "type": "string" + }, + "after": { + "required": false, + "description": "Limit response to comments published after a given ISO8601 compliant date.", + "type": "string" + }, + "author": { + "required": false, + "description": "Limit result set to comments assigned to specific user IDs. Requires authorization.", + "type": "array", + "items": { + "type": "integer" + } + }, + "author_exclude": { + "required": false, + "description": "Ensure result set excludes comments assigned to specific user IDs. Requires authorization.", + "type": "array", + "items": { + "type": "integer" + } + }, + "author_email": { + "required": false, + "description": "Limit result set to that from a specific author email. Requires authorization.", + "type": "string" + }, + "before": { + "required": false, + "description": "Limit response to comments published before a given ISO8601 compliant date.", + "type": "string" + }, + "exclude": { + "required": false, + "default": [], + "description": "Ensure result set excludes specific IDs.", + "type": "array", + "items": { + "type": "integer" + } + }, + "include": { + "required": false, + "default": [], + "description": "Limit result set to specific IDs.", + "type": "array", + "items": { + "type": "integer" + } + }, + "offset": { + "required": false, + "description": "Offset the result set by a specific number of items.", + "type": "integer" + }, + "order": { + "required": false, + "default": "desc", + "enum": [ + "asc", + "desc" + ], + "description": "Order sort attribute ascending or descending.", + "type": "string" + }, + "orderby": { + "required": false, + "default": "date_gmt", + "enum": [ + "date", + "date_gmt", + "id", + "include", + "post", + "parent", + "type" + ], + "description": "Sort collection by object attribute.", + "type": "string" + }, + "parent": { + "required": false, + "default": [], + "description": "Limit result set to comments of specific parent IDs.", + "type": "array", + "items": { + "type": "integer" + } + }, + "parent_exclude": { + "required": false, + "default": [], + "description": "Ensure result set excludes specific parent IDs.", + "type": "array", + "items": { + "type": "integer" + } + }, + "post": { + "required": false, + "default": [], + "description": "Limit result set to comments assigned to specific post IDs.", + "type": "array", + "items": { + "type": "integer" + } + }, + "status": { + "required": false, + "default": "approve", + "description": "Limit result set to comments assigned a specific status. Requires authorization.", + "type": "string" + }, + "type": { + "required": false, + "default": "comment", + "description": "Limit result set to comments assigned a specific type. Requires authorization.", + "type": "string" + }, + "password": { + "required": false, + "description": "The password for the post if it is password protected.", + "type": "string" + } + } + }, + { + "methods": [ + "POST" + ], + "args": { + "author": { + "required": false, + "description": "The ID of the user object, if author was a user.", + "type": "integer" + }, + "author_email": { + "required": false, + "description": "Email address for the object author.", + "type": "string" + }, + "author_ip": { + "required": false, + "description": "IP address for the object author.", + "type": "string" + }, + "author_name": { + "required": false, + "description": "Display name for the object author.", + "type": "string" + }, + "author_url": { + "required": false, + "description": "URL for the object author.", + "type": "string" + }, + "author_user_agent": { + "required": false, + "description": "User agent for the object author.", + "type": "string" + }, + "content": { + "required": false, + "description": "The content for the object.", + "type": "object" + }, + "date": { + "required": false, + "description": "The date the object was published, in the site's timezone.", + "type": "string" + }, + "date_gmt": { + "required": false, + "description": "The date the object was published, as GMT.", + "type": "string" + }, + "parent": { + "required": false, + "default": 0, + "description": "The ID for the parent of the object.", + "type": "integer" + }, + "post": { + "required": false, + "default": 0, + "description": "The ID of the associated post object.", + "type": "integer" + }, + "status": { + "required": false, + "description": "State of the object.", + "type": "string" + }, + "meta": { + "required": false, + "description": "Meta fields.", + "type": "object" + } + } + } + ], + "_links": { + "self": "http://example.org/?rest_route=/wp/v2/comments" + } + }, + "/wp/v2/comments/(?P[\\d]+)": { + "namespace": "wp/v2", + "methods": [ + "GET", + "POST", + "PUT", + "PATCH", + "DELETE" + ], + "endpoints": [ + { + "methods": [ + "GET" + ], + "args": { + "id": { + "required": false, + "description": "Unique identifier for the object.", + "type": "integer" + }, + "context": { + "required": false, + "default": "view", + "enum": [ + "view", + "embed", + "edit" + ], + "description": "Scope under which the request is made; determines fields present in response.", + "type": "string" + }, + "password": { + "required": false, + "description": "The password for the post if it is password protected.", + "type": "string" + } + } + }, + { + "methods": [ + "POST", + "PUT", + "PATCH" + ], + "args": { + "id": { + "required": false, + "description": "Unique identifier for the object.", + "type": "integer" + }, + "author": { + "required": false, + "description": "The ID of the user object, if author was a user.", + "type": "integer" + }, + "author_email": { + "required": false, + "description": "Email address for the object author.", + "type": "string" + }, + "author_ip": { + "required": false, + "description": "IP address for the object author.", + "type": "string" + }, + "author_name": { + "required": false, + "description": "Display name for the object author.", + "type": "string" + }, + "author_url": { + "required": false, + "description": "URL for the object author.", + "type": "string" + }, + "author_user_agent": { + "required": false, + "description": "User agent for the object author.", + "type": "string" + }, + "content": { + "required": false, + "description": "The content for the object.", + "type": "object" + }, + "date": { + "required": false, + "description": "The date the object was published, in the site's timezone.", + "type": "string" + }, + "date_gmt": { + "required": false, + "description": "The date the object was published, as GMT.", + "type": "string" + }, + "parent": { + "required": false, + "description": "The ID for the parent of the object.", + "type": "integer" + }, + "post": { + "required": false, + "description": "The ID of the associated post object.", + "type": "integer" + }, + "status": { + "required": false, + "description": "State of the object.", + "type": "string" + }, + "meta": { + "required": false, + "description": "Meta fields.", + "type": "object" + } + } + }, + { + "methods": [ + "DELETE" + ], + "args": { + "id": { + "required": false, + "description": "Unique identifier for the object.", + "type": "integer" + }, + "force": { + "required": false, + "default": false, + "description": "Whether to bypass trash and force deletion.", + "type": "boolean" + }, + "password": { + "required": false, + "description": "The password for the post if it is password protected.", + "type": "string" + } + } + } + ] + }, + "/wp/v2/settings": { + "namespace": "wp/v2", + "methods": [ + "GET", + "POST", + "PUT", + "PATCH" + ], + "endpoints": [ + { + "methods": [ + "GET" + ], + "args": [] + }, + { + "methods": [ + "POST", + "PUT", + "PATCH" + ], + "args": { + "title": { + "required": false, + "description": "Site title.", + "type": "string" + }, + "description": { + "required": false, + "description": "Site tagline.", + "type": "string" + }, + "url": { + "required": false, + "description": "Site URL.", + "type": "string" + }, + "email": { + "required": false, + "description": "This address is used for admin purposes, like new user notification.", + "type": "string" + }, + "timezone": { + "required": false, + "description": "A city in the same timezone as you.", + "type": "string" + }, + "date_format": { + "required": false, + "description": "A date format for all date strings.", + "type": "string" + }, + "time_format": { + "required": false, + "description": "A time format for all time strings.", + "type": "string" + }, + "start_of_week": { + "required": false, + "description": "A day number of the week that the week should start on.", + "type": "integer" + }, + "language": { + "required": false, + "description": "WordPress locale code.", + "type": "string" + }, + "use_smilies": { + "required": false, + "description": "Convert emoticons like :-) and :-P to graphics on display.", + "type": "boolean" + }, + "default_category": { + "required": false, + "description": "Default post category.", + "type": "integer" + }, + "default_post_format": { + "required": false, + "description": "Default post format.", + "type": "string" + }, + "posts_per_page": { + "required": false, + "description": "Blog pages show at most.", + "type": "integer" + }, + "default_ping_status": { + "required": false, + "enum": [ + "open", + "closed" + ], + "description": "Allow link notifications from other blogs (pingbacks and trackbacks) on new articles.", + "type": "string" + }, + "default_comment_status": { + "required": false, + "enum": [ + "open", + "closed" + ], + "description": "Allow people to post comments on new articles.", + "type": "string" + } + } + } + ], + "_links": { + "self": "http://example.org/?rest_route=/wp/v2/settings" + } + } + } +}; + +mockedApiResponse.oembed = { + "namespace": "oembed/1.0", + "routes": { + "/oembed/1.0": { + "namespace": "oembed/1.0", + "methods": [ + "GET" + ], + "endpoints": [ + { + "methods": [ + "GET" + ], + "args": { + "namespace": { + "required": false, + "default": "oembed/1.0" + }, + "context": { + "required": false, + "default": "view" + } + } + } + ], + "_links": { + "self": "http://example.org/?rest_route=/oembed/1.0" + } + }, + "/oembed/1.0/embed": { + "namespace": "oembed/1.0", + "methods": [ + "GET" + ], + "endpoints": [ + { + "methods": [ + "GET" + ], + "args": { + "url": { + "required": true + }, + "format": { + "required": false, + "default": "json" + }, + "maxwidth": { + "required": false, + "default": 600 + } + } + } + ], + "_links": { + "self": "http://example.org/?rest_route=/oembed/1.0/embed" + } + } + } +}; + +mockedApiResponse.oembeds = { + "code": "rest_missing_callback_param", + "message": "Missing parameter(s): url", + "data": { + "status": 400, + "params": [ + "url" + ] + } +}; + +mockedApiResponse.PostsCollection = [ + { + "id": 3, + "date": "2017-02-14T00:00:00", + "date_gmt": "2017-02-14T00:00:00", + "guid": { + "rendered": "http://example.org/?p=3" + }, + "modified": "2017-02-14T00:00:00", + "modified_gmt": "2017-02-14T00:00:00", + "slug": "restapi-client-fixture-post", + "status": "publish", + "type": "post", + "link": "http://example.org/?p=3", + "title": { + "rendered": "REST API Client Fixture: Post" + }, + "content": { + "rendered": "

Updated post content.

\n", + "protected": false + }, + "excerpt": { + "rendered": "

REST API Client Fixture: Post

\n", + "protected": false + }, + "author": 0, + "featured_media": 0, + "comment_status": "open", + "ping_status": "open", + "sticky": false, + "template": "", + "format": "standard", + "meta": [], + "categories": [ + 1 + ], + "tags": [], + "_links": { + "self": [ + { + "href": "http://example.org/?rest_route=/wp/v2/posts/3" + } + ], + "collection": [ + { + "href": "http://example.org/?rest_route=/wp/v2/posts" + } + ], + "about": [ + { + "href": "http://example.org/?rest_route=/wp/v2/types/post" + } + ], + "replies": [ + { + "embeddable": true, + "href": "http://example.org/?rest_route=%2Fwp%2Fv2%2Fcomments&post=3" + } + ], + "version-history": [ + { + "href": "http://example.org/?rest_route=/wp/v2/posts/3/revisions" + } + ], + "wp:attachment": [ + { + "href": "http://example.org/?rest_route=%2Fwp%2Fv2%2Fmedia&parent=3" + } + ], + "wp:term": [ + { + "taxonomy": "category", + "embeddable": true, + "href": "http://example.org/?rest_route=%2Fwp%2Fv2%2Fcategories&post=3" + }, + { + "taxonomy": "post_tag", + "embeddable": true, + "href": "http://example.org/?rest_route=%2Fwp%2Fv2%2Ftags&post=3" + } + ], + "curies": [ + { + "name": "wp", + "href": "https://api.w.org/{rel}", + "templated": true + } + ] + } + } +]; + +mockedApiResponse.PostModel = { + "id": 3, + "date": "2017-02-14T00:00:00", + "date_gmt": "2017-02-14T00:00:00", + "guid": { + "rendered": "http://example.org/?p=3" + }, + "modified": "2017-02-14T00:00:00", + "modified_gmt": "2017-02-14T00:00:00", + "slug": "restapi-client-fixture-post", + "status": "publish", + "type": "post", + "link": "http://example.org/?p=3", + "title": { + "rendered": "REST API Client Fixture: Post" + }, + "content": { + "rendered": "

Updated post content.

\n", + "protected": false + }, + "excerpt": { + "rendered": "

REST API Client Fixture: Post

\n", + "protected": false + }, + "author": 0, + "featured_media": 0, + "comment_status": "open", + "ping_status": "open", + "sticky": false, + "template": "", + "format": "standard", + "meta": [], + "categories": [ + 1 + ], + "tags": [] +}; + +mockedApiResponse.postRevisions = [ + { + "author": "2", + "date": "2017-02-14T00:00:00", + "date_gmt": "2017-02-14T00:00:00", + "id": 4, + "modified": "2017-02-14T00:00:00", + "modified_gmt": "2017-02-14T00:00:00", + "parent": 3, + "slug": "3-revision-v1", + "guid": { + "rendered": "http://example.org/?p=4" + }, + "title": { + "rendered": "REST API Client Fixture: Post" + }, + "content": { + "rendered": "

Updated post content.

\n" + }, + "excerpt": { + "rendered": "

REST API Client Fixture: Post

\n" + }, + "_links": { + "parent": [ + { + "href": "http://example.org/?rest_route=/wp/v2/posts/3" + } + ] + } + } +]; + +mockedApiResponse.revision = { + "code": "rest_post_invalid_id", + "message": "Invalid revision ID.", + "data": { + "status": 404 + } +}; + +mockedApiResponse.PagesCollection = [ + { + "id": 5, + "date": "2017-02-14T00:00:00", + "date_gmt": "2017-02-14T00:00:00", + "guid": { + "rendered": "http://example.org/?page_id=5" + }, + "modified": "2017-02-14T00:00:00", + "modified_gmt": "2017-02-14T00:00:00", + "slug": "restapi-client-fixture-page", + "status": "publish", + "type": "page", + "link": "http://example.org/?page_id=5", + "title": { + "rendered": "REST API Client Fixture: Page" + }, + "content": { + "rendered": "

Updated page content.

\n", + "protected": false + }, + "excerpt": { + "rendered": "

REST API Client Fixture: Page

\n", + "protected": false + }, + "author": 0, + "featured_media": 0, + "parent": 0, + "menu_order": 0, + "comment_status": "closed", + "ping_status": "closed", + "template": "", + "meta": [], + "_links": { + "self": [ + { + "href": "http://example.org/?rest_route=/wp/v2/pages/5" + } + ], + "collection": [ + { + "href": "http://example.org/?rest_route=/wp/v2/pages" + } + ], + "about": [ + { + "href": "http://example.org/?rest_route=/wp/v2/types/page" + } + ], + "replies": [ + { + "embeddable": true, + "href": "http://example.org/?rest_route=%2Fwp%2Fv2%2Fcomments&post=5" + } + ], + "version-history": [ + { + "href": "http://example.org/?rest_route=/wp/v2/pages/5/revisions" + } + ], + "wp:attachment": [ + { + "href": "http://example.org/?rest_route=%2Fwp%2Fv2%2Fmedia&parent=5" + } + ], + "curies": [ + { + "name": "wp", + "href": "https://api.w.org/{rel}", + "templated": true + } + ] + } + } +]; + +mockedApiResponse.PageModel = { + "id": 5, + "date": "2017-02-14T00:00:00", + "date_gmt": "2017-02-14T00:00:00", + "guid": { + "rendered": "http://example.org/?page_id=5" + }, + "modified": "2017-02-14T00:00:00", + "modified_gmt": "2017-02-14T00:00:00", + "slug": "restapi-client-fixture-page", + "status": "publish", + "type": "page", + "link": "http://example.org/?page_id=5", + "title": { + "rendered": "REST API Client Fixture: Page" + }, + "content": { + "rendered": "

Updated page content.

\n", + "protected": false + }, + "excerpt": { + "rendered": "

REST API Client Fixture: Page

\n", + "protected": false + }, + "author": 0, + "featured_media": 0, + "parent": 0, + "menu_order": 0, + "comment_status": "closed", + "ping_status": "closed", + "template": "", + "meta": [] +}; + +mockedApiResponse.pageRevisions = [ + { + "author": "2", + "date": "2017-02-14T00:00:00", + "date_gmt": "2017-02-14T00:00:00", + "id": 6, + "modified": "2017-02-14T00:00:00", + "modified_gmt": "2017-02-14T00:00:00", + "parent": 5, + "slug": "5-revision-v1", + "guid": { + "rendered": "http://example.org/?p=6" + }, + "title": { + "rendered": "REST API Client Fixture: Page" + }, + "content": { + "rendered": "

Updated page content.

\n" + }, + "excerpt": { + "rendered": "

REST API Client Fixture: Page

\n" + }, + "_links": { + "parent": [ + { + "href": "http://example.org/?rest_route=/wp/v2/pages/5" + } + ] + } + } +]; + +mockedApiResponse.pageRevision = { + "code": "rest_post_invalid_id", + "message": "Invalid revision ID.", + "data": { + "status": 404 + } +}; + +mockedApiResponse.MediaCollection = [ + { + "id": 7, + "date": "2017-02-14T00:00:00", + "date_gmt": "2017-02-14T00:00:00", + "guid": { + "rendered": "http://example.org/?attachment_id=7" + }, + "modified": "2017-02-14T00:00:00", + "modified_gmt": "2017-02-14T00:00:00", + "slug": "restapi-client-fixture-attachment", + "status": "inherit", + "type": "attachment", + "link": "http://example.org/?attachment_id=7", + "title": { + "rendered": "REST API Client Fixture: Attachment" + }, + "author": 0, + "comment_status": "open", + "ping_status": "closed", + "template": "", + "meta": [], + "description": { + "rendered": "

\"\"

\n" + }, + "caption": { + "rendered": "

A sample caption

\n" + }, + "alt_text": "", + "media_type": "image", + "mime_type": "image/jpeg", + "media_details": {}, + "post": null, + "source_url": "http://example.org/wp-content/uploads//tmp/canola.jpg", + "_links": { + "self": [ + { + "href": "http://example.org/?rest_route=/wp/v2/media/7" + } + ], + "collection": [ + { + "href": "http://example.org/?rest_route=/wp/v2/media" + } + ], + "about": [ + { + "href": "http://example.org/?rest_route=/wp/v2/types/attachment" + } + ], + "replies": [ + { + "embeddable": true, + "href": "http://example.org/?rest_route=%2Fwp%2Fv2%2Fcomments&post=7" + } + ] + } + } +]; + +mockedApiResponse.MediaModel = { + "id": 7, + "date": "2017-02-14T00:00:00", + "date_gmt": "2017-02-14T00:00:00", + "guid": { + "rendered": "http://example.org/?attachment_id=7" + }, + "modified": "2017-02-14T00:00:00", + "modified_gmt": "2017-02-14T00:00:00", + "slug": "restapi-client-fixture-attachment", + "status": "inherit", + "type": "attachment", + "link": "http://example.org/?attachment_id=7", + "title": { + "rendered": "REST API Client Fixture: Attachment" + }, + "author": 0, + "comment_status": "open", + "ping_status": "closed", + "template": "", + "meta": [], + "description": { + "rendered": "

\"\"

\n" + }, + "caption": { + "rendered": "

A sample caption

\n" + }, + "alt_text": "", + "media_type": "image", + "mime_type": "image/jpeg", + "media_details": {}, + "post": null, + "source_url": "http://example.org/wp-content/uploads//tmp/canola.jpg" +}; + +mockedApiResponse.TypesCollection = { + "post": { + "description": "", + "hierarchical": false, + "name": "Posts", + "slug": "post", + "taxonomies": [ + "category", + "post_tag" + ], + "rest_base": "posts", + "_links": { + "collection": [ + { + "href": "http://example.org/?rest_route=/wp/v2/types" + } + ], + "wp:items": [ + { + "href": "http://example.org/?rest_route=/wp/v2/posts" + } + ], + "curies": [ + { + "name": "wp", + "href": "https://api.w.org/{rel}", + "templated": true + } + ] + } + }, + "page": { + "description": "", + "hierarchical": true, + "name": "Pages", + "slug": "page", + "taxonomies": [], + "rest_base": "pages", + "_links": { + "collection": [ + { + "href": "http://example.org/?rest_route=/wp/v2/types" + } + ], + "wp:items": [ + { + "href": "http://example.org/?rest_route=/wp/v2/pages" + } + ], + "curies": [ + { + "name": "wp", + "href": "https://api.w.org/{rel}", + "templated": true + } + ] + } + }, + "attachment": { + "description": "", + "hierarchical": false, + "name": "Media", + "slug": "attachment", + "taxonomies": [], + "rest_base": "media", + "_links": { + "collection": [ + { + "href": "http://example.org/?rest_route=/wp/v2/types" + } + ], + "wp:items": [ + { + "href": "http://example.org/?rest_route=/wp/v2/media" + } + ], + "curies": [ + { + "name": "wp", + "href": "https://api.w.org/{rel}", + "templated": true + } + ] + } + } +}; + +mockedApiResponse.TypeModel = { + "code": "rest_no_route", + "message": "No route was found matching the URL and request method", + "data": { + "status": 404 + } +}; + +mockedApiResponse.StatusesCollection = { + "publish": { + "name": "Published", + "public": true, + "queryable": true, + "slug": "publish", + "_links": { + "archives": [ + { + "href": "http://example.org/?rest_route=/wp/v2/posts" + } + ] + } + }, + "future": { + "name": "Scheduled", + "public": false, + "queryable": false, + "slug": "future", + "_links": { + "archives": [ + { + "href": "http://example.org/?rest_route=%2Fwp%2Fv2%2Fposts&status=future" + } + ] + } + }, + "draft": { + "name": "Draft", + "public": false, + "queryable": false, + "slug": "draft", + "_links": { + "archives": [ + { + "href": "http://example.org/?rest_route=%2Fwp%2Fv2%2Fposts&status=draft" + } + ] + } + }, + "pending": { + "name": "Pending", + "public": false, + "queryable": false, + "slug": "pending", + "_links": { + "archives": [ + { + "href": "http://example.org/?rest_route=%2Fwp%2Fv2%2Fposts&status=pending" + } + ] + } + }, + "private": { + "name": "Private", + "public": false, + "queryable": false, + "slug": "private", + "_links": { + "archives": [ + { + "href": "http://example.org/?rest_route=%2Fwp%2Fv2%2Fposts&status=private" + } + ] + } + }, + "trash": { + "name": "Trash", + "public": false, + "queryable": false, + "slug": "trash", + "_links": { + "archives": [ + { + "href": "http://example.org/?rest_route=%2Fwp%2Fv2%2Fposts&status=trash" + } + ] + } + } +}; + +mockedApiResponse.StatusModel = { + "name": "Published", + "public": true, + "queryable": true, + "slug": "publish" +}; + +mockedApiResponse.TaxonomiesCollection = { + "category": { + "name": "Categories", + "slug": "category", + "description": "", + "types": [ + "post" + ], + "hierarchical": true, + "rest_base": "categories", + "_links": { + "collection": [ + { + "href": "http://example.org/?rest_route=/wp/v2/taxonomies" + } + ], + "wp:items": [ + { + "href": "http://example.org/?rest_route=/wp/v2/categories" + } + ], + "curies": [ + { + "name": "wp", + "href": "https://api.w.org/{rel}", + "templated": true + } + ] + } + }, + "post_tag": { + "name": "Tags", + "slug": "post_tag", + "description": "", + "types": [ + "post" + ], + "hierarchical": false, + "rest_base": "tags", + "_links": { + "collection": [ + { + "href": "http://example.org/?rest_route=/wp/v2/taxonomies" + } + ], + "wp:items": [ + { + "href": "http://example.org/?rest_route=/wp/v2/tags" + } + ], + "curies": [ + { + "name": "wp", + "href": "https://api.w.org/{rel}", + "templated": true + } + ] + } + } +}; + +mockedApiResponse.TaxonomyModel = { + "name": "Categories", + "slug": "category", + "description": "", + "types": [ + "post" + ], + "hierarchical": true, + "rest_base": "categories" +}; + +mockedApiResponse.CategoriesCollection = [ + { + "id": 1, + "count": 1, + "description": "", + "link": "http://example.org/?cat=1", + "name": "Uncategorized", + "slug": "uncategorized", + "taxonomy": "category", + "parent": 0, + "meta": [], + "_links": { + "self": [ + { + "href": "http://example.org/?rest_route=/wp/v2/categories/1" + } + ], + "collection": [ + { + "href": "http://example.org/?rest_route=/wp/v2/categories" + } + ], + "about": [ + { + "href": "http://example.org/?rest_route=/wp/v2/taxonomies/category" + } + ], + "wp:post_type": [ + { + "href": "http://example.org/?rest_route=%2Fwp%2Fv2%2Fposts&categories=1" + } + ], + "curies": [ + { + "name": "wp", + "href": "https://api.w.org/{rel}", + "templated": true + } + ] + } + } +]; + +mockedApiResponse.CategoryModel = { + "id": 1, + "count": 1, + "description": "", + "link": "http://example.org/?cat=1", + "name": "Uncategorized", + "slug": "uncategorized", + "taxonomy": "category", + "parent": 0, + "meta": [] +}; + +mockedApiResponse.TagsCollection = [ + { + "id": 2, + "count": 0, + "description": "REST API Client Fixture: Tag", + "link": "http://example.org/?tag=restapi-client-fixture-tag", + "name": "REST API Client Fixture: Tag", + "slug": "restapi-client-fixture-tag", + "taxonomy": "post_tag", + "meta": [], + "_links": { + "self": [ + { + "href": "http://example.org/?rest_route=/wp/v2/tags/2" + } + ], + "collection": [ + { + "href": "http://example.org/?rest_route=/wp/v2/tags" + } + ], + "about": [ + { + "href": "http://example.org/?rest_route=/wp/v2/taxonomies/post_tag" + } + ], + "wp:post_type": [ + { + "href": "http://example.org/?rest_route=%2Fwp%2Fv2%2Fposts&tags=2" + } + ], + "curies": [ + { + "name": "wp", + "href": "https://api.w.org/{rel}", + "templated": true + } + ] + } + } +]; + +mockedApiResponse.TagModel = { + "id": 2, + "count": 0, + "description": "REST API Client Fixture: Tag", + "link": "http://example.org/?tag=restapi-client-fixture-tag", + "name": "REST API Client Fixture: Tag", + "slug": "restapi-client-fixture-tag", + "taxonomy": "post_tag", + "meta": [] +}; + +mockedApiResponse.UsersCollection = [ + { + "id": 1, + "name": "admin", + "url": "", + "description": "", + "link": "http://example.org/?author=1", + "slug": "admin", + "avatar_urls": { + "24": "http://0.gravatar.com/avatar/96614ec98aa0c0d2ee75796dced6df54?s=24&d=mm&r=g", + "48": "http://0.gravatar.com/avatar/96614ec98aa0c0d2ee75796dced6df54?s=48&d=mm&r=g", + "96": "http://0.gravatar.com/avatar/96614ec98aa0c0d2ee75796dced6df54?s=96&d=mm&r=g" + }, + "meta": [], + "_links": { + "self": [ + { + "href": "http://example.org/?rest_route=/wp/v2/users/1" + } + ], + "collection": [ + { + "href": "http://example.org/?rest_route=/wp/v2/users" + } + ] + } + }, + { + "id": 2, + "name": "REST API Client Fixture: User", + "url": "", + "description": "", + "link": "http://example.org/?author=2", + "slug": "restapiclientfixtureuser", + "avatar_urls": { + "24": "http://2.gravatar.com/avatar/57cbd982c963c7eb2294e2eee1b4448e?s=24&d=mm&r=g", + "48": "http://2.gravatar.com/avatar/57cbd982c963c7eb2294e2eee1b4448e?s=48&d=mm&r=g", + "96": "http://2.gravatar.com/avatar/57cbd982c963c7eb2294e2eee1b4448e?s=96&d=mm&r=g" + }, + "meta": [], + "_links": { + "self": [ + { + "href": "http://example.org/?rest_route=/wp/v2/users/2" + } + ], + "collection": [ + { + "href": "http://example.org/?rest_route=/wp/v2/users" + } + ] + } + } +]; + +mockedApiResponse.UserModel = { + "id": 2, + "name": "REST API Client Fixture: User", + "url": "", + "description": "", + "link": "http://example.org/?author=2", + "slug": "restapiclientfixtureuser", + "avatar_urls": { + "24": "http://2.gravatar.com/avatar/57cbd982c963c7eb2294e2eee1b4448e?s=24&d=mm&r=g", + "48": "http://2.gravatar.com/avatar/57cbd982c963c7eb2294e2eee1b4448e?s=48&d=mm&r=g", + "96": "http://2.gravatar.com/avatar/57cbd982c963c7eb2294e2eee1b4448e?s=96&d=mm&r=g" + }, + "meta": [] +}; + +mockedApiResponse.me = { + "id": 2, + "name": "REST API Client Fixture: User", + "url": "", + "description": "", + "link": "http://example.org/?author=2", + "slug": "restapiclientfixtureuser", + "avatar_urls": { + "24": "http://2.gravatar.com/avatar/57cbd982c963c7eb2294e2eee1b4448e?s=24&d=mm&r=g", + "48": "http://2.gravatar.com/avatar/57cbd982c963c7eb2294e2eee1b4448e?s=48&d=mm&r=g", + "96": "http://2.gravatar.com/avatar/57cbd982c963c7eb2294e2eee1b4448e?s=96&d=mm&r=g" + }, + "meta": [] +}; + +mockedApiResponse.CommentsCollection = [ + { + "id": 2, + "post": 3, + "parent": 0, + "author": 0, + "author_name": "Internet of something or other", + "author_url": "http://lights.example.org/", + "date": "2017-02-14T00:00:00", + "date_gmt": "2017-02-14T00:00:00", + "content": { + "rendered": "

This is a comment

\n" + }, + "link": "http://example.org/?p=3#comment-2", + "status": "approved", + "type": "comment", + "author_avatar_urls": { + "24": "http://2.gravatar.com/avatar/bd7c2b505bcf39cc71cfee564c614956?s=24&d=mm&r=g", + "48": "http://2.gravatar.com/avatar/bd7c2b505bcf39cc71cfee564c614956?s=48&d=mm&r=g", + "96": "http://2.gravatar.com/avatar/bd7c2b505bcf39cc71cfee564c614956?s=96&d=mm&r=g" + }, + "meta": [], + "_links": { + "self": [ + { + "href": "http://example.org/?rest_route=/wp/v2/comments/2" + } + ], + "collection": [ + { + "href": "http://example.org/?rest_route=/wp/v2/comments" + } + ], + "up": [ + { + "embeddable": true, + "post_type": "post", + "href": "http://example.org/?rest_route=/wp/v2/posts/3" + } + ] + } + } +]; + +mockedApiResponse.CommentModel = { + "code": "rest_comment_invalid_id", + "message": "Invalid comment ID.", + "data": { + "status": 404 + } +}; + +mockedApiResponse.settings = { + "title": "Test Blog", + "description": "Just another WordPress site", + "url": "http://example.org", + "email": "admin@example.org", + "timezone": "", + "date_format": "F j, Y", + "time_format": "g:i a", + "start_of_week": 1, + "language": "en_US", + "use_smilies": true, + "default_category": 1, + "default_post_format": "0", + "posts_per_page": 10, + "default_ping_status": "open", + "default_comment_status": "open" +}; diff --git a/tests/qunit/fixtures/wp-api.js b/tests/qunit/fixtures/wp-api.js new file mode 100644 index 0000000000..cbbc484174 --- /dev/null +++ b/tests/qunit/fixtures/wp-api.js @@ -0,0 +1,55 @@ +/* global mockedApiResponse, Backbone */ +/** + * @var mockedApiResponse defined in wp-api-generated.js + */ + +var pathToData = { + 'wp-json/wp/v2/': mockedApiResponse.Schema, + 'wp-json/wp/v2/categories': mockedApiResponse.CategoriesCollection, + 'wp-json/wp/v2/comments': mockedApiResponse.CommentsCollection, + 'wp-json/wp/v2/media': mockedApiResponse.MediaCollection, + 'wp-json/wp/v2/pages': mockedApiResponse.PagesCollection, + 'wp-json/wp/v2/posts': mockedApiResponse.PostsCollection, + 'wp-json/wp/v2/statuses': mockedApiResponse.StatusesCollection, + 'wp-json/wp/v2/tags': mockedApiResponse.TagsCollection, + 'wp-json/wp/v2/taxonomies': mockedApiResponse.TaxonomiesCollection, + 'wp-json/wp/v2/types': mockedApiResponse.TypesCollection, + 'wp-json/wp/v2/users': mockedApiResponse.UsersCollection, + 'wp-json/wp/v2/category': mockedApiResponse.CategoryModel, + 'wp-json/wp/v2/media1': mockedApiResponse.MediaModel, + 'wp-json/wp/v2/page': mockedApiResponse.PageModel, + 'wp-json/wp/v2/post': mockedApiResponse.PostModel, + 'wp-json/wp/v2/tag': mockedApiResponse.TagModel, + 'wp-json/wp/v2/user': mockedApiResponse.UserModel, + 'wp-json/wp/v2/taxonomy': mockedApiResponse.TaxonomyModel, + 'wp-json/wp/v2/status': mockedApiResponse.StatusModel, + 'wp-json/wp/v2/type': mockedApiResponse.TypeModel +}; + +/** + * Mock the ajax callbacks for our tests. + * + * @param {object} param The parameters sent to the ajax request. + * + * @return {Object} A jQuery defered object that resolves with the mapped data. + */ +Backbone.ajax = function ( param ) { + + var data, + request = param.url.replace( 'http://localhost/', '' ); + + if ( pathToData[ request ] ) { + data = pathToData[ request ]; + } + + // Call success handler. + param.success( data ); + var deferred = jQuery.Deferred(); + + // Resolve the deferred with the mocked data + deferred.resolve( data ); + + // Return the deferred promise that will resolve with the expected data. + return deferred.promise(); + +}; diff --git a/tests/qunit/index.html b/tests/qunit/index.html index 9a17ec23b8..22004e3711 100644 --- a/tests/qunit/index.html +++ b/tests/qunit/index.html @@ -17,6 +17,11 @@ } }; + @@ -34,6 +39,8 @@ + +

TinyMCE tests

@@ -43,6 +50,7 @@ + @@ -61,6 +69,7 @@ + diff --git a/tests/qunit/wp-includes/js/wp-api.js b/tests/qunit/wp-includes/js/wp-api.js new file mode 100644 index 0000000000..5225d9e254 --- /dev/null +++ b/tests/qunit/wp-includes/js/wp-api.js @@ -0,0 +1,195 @@ +/* global wp */ +( function( QUnit ) { + module( 'wpapi' ); + + QUnit.test( 'API Loaded correctly', function( assert ) { + var done = assert.async(); + assert.expect( 2 ); + + assert.ok( wp.api.loadPromise ); + + wp.api.loadPromise.done( function() { + assert.ok( wp.api.models ); + done(); + } ); + + } ); + + // The list of collections we should check. + var collectionClassNames = [ + 'Categories', + 'Comments', + 'Media', + 'Pages', + 'Posts', + 'Statuses', + 'Tags', + 'Taxonomies', + 'Types', + 'Users' + ]; + + // Collections that should get helpers tested. + var collectionHelperTests = [ + { + 'collectionType': 'Posts', + 'returnsModelType': 'post', + 'supportsMethods': { + 'getDate': 'getDate', + 'getRevisions': 'getRevisions', + 'getTags': 'getTags', + 'getCategories': 'getCategories', + 'getAuthorUser': 'getAuthorUser', + 'getFeaturedMedia': 'getFeaturedMedia' + /*'getMeta': 'getMeta', currently not supported */ + } + }, + { + 'collectionType': 'Pages', + 'returnsModelType': 'page', + 'supportsMethods': { + 'getDate': 'getDate', + 'getRevisions': 'getRevisions', + 'getAuthorUser': 'getAuthorUser', + 'getFeaturedMedia': 'getFeaturedMedia' + } + } + ]; + + _.each( collectionClassNames, function( className ) { + QUnit.test( 'Testing ' + className + ' collection.', function( assert ) { + var done = assert.async(); + + wp.api.loadPromise.done( function() { + var theCollection = new wp.api.collections[ className ](); + assert.ok( + theCollection, + 'We can instantiate wp.api.collections.' + className + ); + theCollection.fetch().done( function() { + assert.equal( + 1, + theCollection.state.currentPage, + 'We should be on page 1 of the collection in ' + className + ); + + // Should this collection have helper methods? + var collectionHelperTest = _.findWhere( collectionHelperTests, { 'collectionType': className } ); + + // If we found a match, run the tests against it. + if ( ! _.isUndefined( collectionHelperTest ) ) { + + // Test the first returned model. + var firstModel = theCollection.at( 0 ); + + // Is the model the right type? + assert.equal( + collectionHelperTest.returnsModelType, + firstModel.get( 'type' ), + 'The wp.api.collections.' + className + ' is of type ' + collectionHelperTest.returnsModelType + ); + + // Does the model have all of the expected supported methods? + _.each( collectionHelperTest.supportsMethods, function( method ) { + assert.equal( + 'function', + typeof firstModel[ method ], + className + '.' + method + ' is a function.' + ); + } ); + } + + // Trigger Qunit async completion. + done(); + } ); + + } ); + + } ); + } ); + + // The list of models we should check. + var modelsWithIdsClassNames = [ + 'Category', + 'Media', + 'Page', + 'Post', + 'Tag', + 'User' + ]; + + _.each( modelsWithIdsClassNames, function( className ) { + + QUnit.test( 'Checking ' + className + ' model.' , function( assert ) { + var done = assert.async(); + + assert.expect( 2 ); + + wp.api.loadPromise.done( function() { + var theModel = new wp.api.models[ className ](); + assert.ok( theModel, 'We can instantiate wp.api.models.' + className ); + theModel.fetch().done( function( ) { + var theModel2 = new wp.api.models[ className ](); + theModel2.set( 'id', theModel.attributes[0].id ); + theModel2.fetch().done( function() { + + // We were able to retrieve the model. + assert.equal( + theModel.attributes[0].id, + theModel2.get( 'id' ) , + 'We should be able to get a ' + className + ); + + // Trigger Qunit async completion. + done(); + } ); + } ); + + } ); + + } ); + } ); + + var modelsWithIndexes = [ + 'Taxonomy', + 'Status', + 'Type' + ]; + + _.each( modelsWithIndexes, function( className ) { + + QUnit.test( 'Testing ' + className + ' model.' , function( assert ) { + var done = assert.async(); + + assert.expect( 2 ); + + wp.api.loadPromise.done( function( ) { + + var theModel = new wp.api.models[ className ](); + assert.ok( theModel, 'We can instantiate wp.api.models.' + className ); + theModel.fetch().done( function( ) { + var theModel2 = new wp.api.models[ className ](); + + if ( ! _.isUndefined( theModel.attributes[0] ) ) { + theModel2.set( 'id', theModel.attributes[0].id ); + } + + theModel2.fetch().done( function() { + // We were able to retrieve the model. + assert.notEqual( + 0, + _.keys( theModel2.attributes ).length , + 'We should be able to get a ' + className + ); + + // Trigger Qunit async completion. + done(); + } ); + } ); + + } ); + + } ); + } ); + +} )( window.QUnit );