overlay: 1.0.0
info:
  title: API Evangelist enhancements for the Offerpad WordPress REST API
  version: 1.0.0
extends: openapi/offerpad-wordpress-wp-v2-openapi.yml
x-apievangelist:
  generated: '2026-07-26'
  method: generated
  source: >-
    Live probes of https://www.offerpad.com/wp-json/ plus the artifacts in this repository.
    The base document is itself derived from the WordPress route discovery document; this
    overlay carries only the annotations API Evangelist adds on top of it.
actions:
  - target: $.info
    update:
      x-apievangelist-provider: offerpad
      x-apievangelist-provider-kind: company
      x-apievangelist-surface-class: cms
      x-apievangelist-not-a-product: >-
        Offerpad does not document, support or advertise this API. It is the stock WordPress REST
        API of the marketing site, catalogued because it is the only publicly callable API on any
        Offerpad host.
      x-apievangelist-artifacts:
        conventions: conventions/offerpad-conventions.yml
        errors: errors/offerpad-problem-types.yml
        authentication: authentication/offerpad-authentication.yml
        data_model: data-model/offerpad-data-model.yml
        lifecycle: lifecycle/offerpad-lifecycle.yml
        conformance: conformance/offerpad-conformance.yml
        skills: skills/_index.yml
        mcp: mcp/offerpad-mcp.yml
  - target: $.info
    update:
      x-rate-limit-signalling: none-observed
      x-idempotency: not-supported
      x-error-format: wordpress-rest-error
  - target: $.servers[0]
    update:
      x-edge: WP Engine origin behind Cloudflare
      x-cache-control: 'max-age=600, must-revalidate'
  - target: $.components.securitySchemes.applicationPasswords
    update:
      x-self-serve: false
      x-issuance: >-
        Requires an Offerpad WordPress account. No third-party credential is obtainable, so every
        authenticated route is effectively closed.
  - target: $.paths['/wp/v2/posts'].get
    update:
      x-observed-total: 471
      x-pagination-headers: [X-WP-Total, X-WP-TotalPages, Link]
      x-example-response: examples/offerpad-wp-v2-posts-response.json
  - target: $.paths['/wp/v2/pages'].get
    update:
      x-pagination-headers: [X-WP-Total, X-WP-TotalPages, Link]
      x-example-response: examples/offerpad-wp-v2-pages-response.json
      x-note: >-
        Offerpad's per-market sell landing pages live in this collection under the /sell/ parent.
  - target: $.paths['/wp/v2/categories'].get
    update:
      x-example-response: examples/offerpad-wp-v2-categories-response.json
  - target: $.paths['/wp/v2/types'].get
    update:
      x-example-response: examples/offerpad-wp-v2-types-response.json
  - target: $.paths['/wp/v2/search'].get
    update:
      x-example-response: examples/offerpad-wp-v2-search-response.json
  - target: $.paths['/wp/v2/settings'].get
    update:
      x-observed-status: 401
      x-observed-body: '{"code":"rest_forbidden","message":"Sorry, you are not allowed to do that.","data":{"status":401}}'