Skip to content

Update copies for the registration of the new abilities - #23598

Open
leonidasmi wants to merge 4 commits into
feature/yoast-abilities-part-2from
1441-finalize-registration-copies-for-the-getset-data-abilities
Open

Update copies for the registration of the new abilities#23598
leonidasmi wants to merge 4 commits into
feature/yoast-abilities-part-2from
1441-finalize-registration-copies-for-the-getset-data-abilities

Conversation

@leonidasmi

Copy link
Copy Markdown
Contributor

Context

Summary

This PR can be summarized in the following changelog entry:

  • Changes some of the copies of the input and output schemas for the new abilities.

Relevant technical choices:

Test instructions

Test instructions for the acceptance test before the PR gets merged

This PR can be acceptance tested by following these steps:

  • Run the GET request of /wp-json/wp-abilities/v1/abilities
    • Confirm that the input and output schema of the two abilities matches what's in the PRD (here's the input schema and here's the output schema.)
  • Regression test using the abilities with Claude.
    • Specifically see if you can still retrieve the following fields:
      • canonical of a post
      • whether it's cornerstone
      • the robots data (noindex, nofollow, etc.)
      • the SEO title and meta description
      • the OG and Twitter title and description
      • the schema page/article type
    • Also see if you can still update the following fields
      • canonical of a post
      • whether it's cornerstone
      • the robots data (noindex, nofollow, etc.)

Relevant test scenarios

  • Changes should be tested with the browser console open
  • Changes should be tested on different posts/pages/taxonomies/custom post types/custom taxonomies
  • Changes should be tested on different editors (Default Block/Gutenberg/Classic/Elementor/other)
  • Changes should be tested on different browsers
  • Changes should be tested on multisite

Test instructions for QA when the code is in the RC

  • QA should use the same steps as above.

Impact check

This PR affects the following parts of the plugin, which may require extra testing:

Other environments

  • This PR also affects Shopify. I have added a changelog entry starting with [shopify-seo], added test instructions for Shopify and attached the Shopify label to this PR.
  • This PR also affects Yoast SEO for Google Docs. I have added a changelog entry starting with [yoast-doc-extension], added test instructions for Yoast SEO for Google Docs and attached the Google Docs Add-on label to this PR.

Documentation

  • I have written documentation for this change. For example, comments in the Relevant technical choices, comments in the code, documentation on Confluence / shared Google Drive / Yoast developer portal, or other.

Quality assurance

  • I have tested this code to the best of my abilities.
  • During testing, I had activated all plugins that Yoast SEO provides integrations for.
  • I have added unit tests to verify the code works as intended.
  • If any part of the code is behind a feature flag, my test instructions also cover cases where the feature flag is switched off.
  • I have written this PR in accordance with my team's definition of done.
  • I have checked that the base branch is correctly set.
  • I have run grunt build:images and committed the results, if my PR introduces or edits images or SVGs.

Innovation

  • No innovation project is applicable for this PR.
  • This PR falls under an innovation project. I have attached the innovation label.
  • I have added my hours to the WBSO document.

Fixes #

@leonidasmi leonidasmi added the changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog label Sep 7, 2026
@leonidasmi
leonidasmi marked this pull request as ready for review September 7, 2026 12:41
@coveralls-official

coveralls-official Bot commented Sep 7, 2026

Copy link
Copy Markdown

Coverage Report for CI Build 3

Coverage decreased (-0.09%) to 56.714%

Details

  • Coverage decreased (-0.09%) from the base build.
  • Patch coverage: 59 of 59 lines across 1 file are fully covered (100%).
  • No coverage regressions found.

Uncovered Changes

No uncovered changes found.

Coverage Regressions

No coverage regressions found.


Coverage Stats

Coverage Status
Relevant Lines: 70409
Covered Lines: 39958
Line Coverage: 56.75%
Relevant Branches: 17761
Covered Branches: 10047
Branch Coverage: 56.57%
Branches in Coverage %: Yes
Coverage Strength: 42745.1 hits per line

💛 - Coveralls

@leonidasmi
leonidasmi requested a review from a team as a code owner September 8, 2026 09:50
…stration-copies-for-the-getset-data-abilities
Comment thread src/abilities/user-interface/abilities-integration.php Outdated
Comment thread src/abilities/user-interface/abilities-integration.php Outdated

return [
'type' => 'object',
'properties' => [

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is there a reason we don't keep the title/description format here?

Copy link
Copy Markdown
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah that was on purpose.

Output descriptions are not added when the keys are pretty self-explanatory and adding them would add length without adding information. I've seen agents reading both schemas when deciding how to use each ability so not adding self-explanatory stuff probably makes our abilities a bit more friendly to agent token costs.

The same keys have descriptions in the input because it's arguably more important for agents to understand what to send when using the abilities than the final results.

I'd keep as is and we can revisit in the future.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

changelog: non-user-facing Needs to be included in the 'Non-userfacing' category in the changelog

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants