Create API endpoints for SEO and readability scores #21847
Merged
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
…-the-seoreadability-score
…er of the given content type
thijsoo
requested changes
Nov 21, 2024
src/dashboard/application/content-types/content-types-repository.php
Outdated
Show resolved
Hide resolved
src/dashboard/application/scores/readability-scores/readability-scores-repository.php
Outdated
Show resolved
Hide resolved
18 tasks
42a613d to
4c786a5
Compare
18 tasks
This was referenced Nov 27, 2024
18 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Context
Summary
This PR can be summarized in the following changelog entry:
Relevant technical choices:
wpseo_{$content_type}_filtering_taxonomyfilter or because it's a hardoced filtering pair, described in this PR)query_var, there will be noViewURLs returned, because there can't be a URL that filters the CPT page on that taxonomy. In those cases, we will have noViewbuttons in the UITest instructions
Test instructions for the acceptance test before the PR gets merged
This PR can be acceptance tested by following these steps:
Note: We're going to use POSTMAN to test the API endpoint, so use this post to learn how to authenticate.
For posts and categories:
primary_focus_keyword_score, to have a view on what to expect/wp-json/yoast/v1/seo_scores?contentType=postand confirm that you get a response similar to the below, with the amounts representing what you have in the database:primary_focus_keyword_scoreover 70, 1 post withprimary_focus_keyword_scorebetween 41 and 70, 2 posts with under 40 and 1 post without keyphrase.primary_focus_keyword_scoreover 70 into a draft and repeat the request -> you should get one lessamountin thegoodobject.primary_focus_keyword_scoreover 70 into anoindexedpost and repeat the request -> you should get one lessamountin thegoodobject and when visiting the link you get the same amount of posts in the filtered posts page. - Note: there's no need to do that for readability scores/wp-json/yoast/v1/seo_scores?contentType=post&taxonomy=category&term=<TERM_ID>(replaceTERM_IDwith the correct term ID)/wp-json/yoast/v1/seo_scores?contentType=product&taxonomy=product_cat&term=<TERM_ID>- pay extra focus on the links to confirm that they get you to the right filtered state in the products page/wp-json/yoast/v1/seo_scores?contentType=<CPT_NAME>&taxonomy=<TAX_NAME>&term=<TERM_ID>- pay extra focus on the links to confirm that they get you to the right filtered state in the CPT pageAdded filter via hook, for a taxonomy with custom REST API URLin order to be able to create a CPT and connect it to a filtering taxonomy.For when SEO scores are at the end of the ranges:
40,41,70,71, to make sure they are categorized asbad,ok,okandgoodrespectivelyprimary_focus_keywordto to40,41,70,71._yoast_wpseo_linkdexcolumn to the same/wp-json/yoast/v1/seo_scores?contentType=postand when you click on each score's link, confirm that you get the same amount of posts with theamountattribute of each post.For when the post type requested is excluded from indexable creation:
/wp-json/yoast/v1/seo_scores?contentType=pageInvalid content typeerror.For when the term requested is not part of the taxonomy:
/wp-json/yoast/v1/seo_scores?contentType=post&taxonomy=category&term=<TERM_ID>(replaceTERM_IDwith an ID that doesn't exist in terms)Invalid termerror.For a custom taxonomy that doesn't have links because it has a false
query_var:query_varattribute and assign it to books:/wp-json/yoast/v1/seo_scores?contentType=book&taxonomy=alternative-genre&term=<TERM_ID>(replaceTERM_IDwith the correct term ID)Invalid taxonomyerroralternative-genretaxonomy as filter for books and repeat the GET request:1):linksattributes - In those cases, we will have noViewbuttons in the UI.For when Yoast SEO is not enabled and a post is created:
not analyzedoneReadability scores:
Needs improvement/badscores. Posts that have never been saved from the editor once, they are consideredNot analyzed/wp-json/yoast/v1/readability_scores?contentType=instead of/wp-json/yoast/v1/seo_scores?contentType=For when SEO scores are at the end of the ranges, we have to change thereadability_scorecolumn in the indexable table and the_yoast_wpseo_content_scorecolumn in the postmeta tablenoindexedposts (the relevant step is already mentioning that, so you can ignore it)Relevant test scenarios
Test instructions for QA when the code is in the RC
Impact check
This PR affects the following parts of the plugin, which may require extra testing:
UI changes
Other environments
[shopify-seo], added test instructions for Shopify and attached theShopifylabel to this PR.Documentation
Quality assurance
Innovation
innovationlabel.Fixes https://github.com/Yoast/roadmap/issues/529