Yoast · OpenAPI Overlay 1.0.0

API Evangelist enhancements for Yoast Schema Aggregator API

5 actions 5 updates update extends openapi/yoast-schema-aggregator-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Yoast's API. It is a proposal applied on top of the contract, not a document Yoast publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-action-classx-apievangelist-consequencex-apievangelist-providerx-apievangelist-artifactsx-apievangelist-deliveryx-apievangelist-note

Targets 5

$.info
$.servers[0]
$.paths['/yoast/v1/schema-aggregator/get-schema/{post_type}'].get
$.paths['/yoast/v1/schema-aggregator/get-schema/{post_type}/{page}'].get
$.paths['/yoast/v1/schema-aggregator/get-xml'].get

OpenAPI Overlay

Raw ↑ 
overlay: 1.0.0
info:
  title: API Evangelist enhancements for Yoast Schema Aggregator API
  version: 1.0.0
extends: openapi/yoast-schema-aggregator-openapi.yml
x-generated: '2026-08-13'
x-method: generated
x-source: API Evangelist enrichment pipeline; annotations only, the underlying spec is not mutated
actions:
- target: $.info
  update:
    x-apievangelist-provider: yoast
    x-apievangelist-artifacts:
      authentication: authentication/yoast-authentication.yml
      conventions: conventions/yoast-conventions.yml
      errors: errors/yoast-problem-types.yml
      lifecycle: lifecycle/yoast-lifecycle.yml
      rate-limits: rate-limits/yoast-rate-limits.yml
      data-model: data-model/yoast-data-model.yml
    x-apievangelist-delivery: self-hosted-plugin
- target: $.servers[0]
  update:
    x-apievangelist-note: 'Templated host: Yoast ships plugin code, so the server is the customer''s own
      WordPress install. Auth, TLS and throttling belong to that install, not to Yoast.'
- target: $.paths['/yoast/v1/schema-aggregator/get-schema/{post_type}'].get
  update:
    x-apievangelist-action-class: read
    x-apievangelist-consequence: read-only
- target: $.paths['/yoast/v1/schema-aggregator/get-schema/{post_type}/{page}'].get
  update:
    x-apievangelist-action-class: read
    x-apievangelist-consequence: read-only
- target: $.paths['/yoast/v1/schema-aggregator/get-xml'].get
  update:
    x-apievangelist-action-class: read
    x-apievangelist-consequence: read-only