Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Update REST API Handbook: Replace _filter with _fields in Pages Schema Section #1812

Open
dhruvang21 opened this issue Jan 3, 2025 · 1 comment
Labels
[Status] To do Issue marked as Todo

Comments

@dhruvang21
Copy link

dhruvang21 commented Jan 3, 2025

Created issue on contribution day at Wordcamp Ahmedabad.

Issue Description

In the REST API handbook page for "Pages," under the Schema section, the _filter parameter is incorrectly documented. This parameter has been removed from the WordPress REST API and replaced with _fields.

URL of the Page with the Issue

https://developer.wordpress.org/rest-api/reference/pages/

Section of Page with the issue

The "Schema" section where _filter is mentioned.

Why is this a problem?

The documentation contains outdated information about the _filter parameter, which may mislead developers into using a parameter that no longer exists. The correct parameter, _fields, needs to be documented to ensure accurate and up-to-date guidance.

Suggested Fix

Replace all instances of _filter in the Schema section with _fields, reflecting the current REST API implementation. Additionally, ensure that any examples or descriptions associated with _filter are updated to _fields.

@dhruvang21 dhruvang21 added the [Status] To do Issue marked as Todo label Jan 3, 2025
Copy link

github-actions bot commented Jan 3, 2025

Heads up @WordPress/docs-issues-coordinators, we have a new issue open. Time to use 'em labels.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
[Status] To do Issue marked as Todo
Projects
None yet
Development

No branches or pull requests

1 participant