Planable · OpenAPI Overlay 1.0.0

API Evangelist enhancements — Planable Competitors API

7 actions 7 updates documentation extends openapi/planable-competitors-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Planable's API. It is a proposal applied on top of the contract, not a document Planable publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

operationIdx-rate-limitsx-error-catalogx-conventionsx-idempotencyx-plan-gatex-docs

Targets 7

$.paths['/pages/{id}/competitors'].get
$.paths['/pages/{id}/competitors'].post
$.paths['/pages/{id}/competitors/comparison'].get
$.paths['/pages/{id}/competitors/metrics'].get
$.paths['/pages/{id}/competitors/top-posts'].get
$.paths['/pages/{id}/competitors/{scrapedPageId}'].delete
$.info

OpenAPI Overlay

Raw ↑ 
overlay: 1.0.0
info:
  title: API Evangelist enhancements — Planable Competitors API
  version: 1.0.0
extends: openapi/planable-competitors-api-openapi.yml
x-generated: '2026-08-13'
x-method: generated
x-source: openapi/_original/planable-openapi.json
x-note: Non-destructive enhancement of Planable's published contract. Planable declares no operationId on any of
  its 51 operations, which forces every generator and MCP tool-forge to synthesize names. This overlay assigns deterministic
  verb+path operationIds and documents the runtime semantics Planable states in prose but does not encode in the
  spec. The operationIds are API EVANGELIST's, not Planable's — do not cite them as published. The original spec
  is never mutated.
actions:
- target: $.paths['/pages/{id}/competitors'].get
  description: Assign a stable operationId for GET /pages/{id}/competitors — the published spec declares none.
  update:
    operationId: getPagesByIdCompetitors
- target: $.paths['/pages/{id}/competitors'].post
  description: Assign a stable operationId for POST /pages/{id}/competitors — the published spec declares none.
  update:
    operationId: createPagesByIdCompetitors
- target: $.paths['/pages/{id}/competitors/comparison'].get
  description: Assign a stable operationId for GET /pages/{id}/competitors/comparison — the published spec declares
    none.
  update:
    operationId: getPagesByIdCompetitorsComparison
- target: $.paths['/pages/{id}/competitors/metrics'].get
  description: Assign a stable operationId for GET /pages/{id}/competitors/metrics — the published spec declares
    none.
  update:
    operationId: getPagesByIdCompetitorsMetrics
- target: $.paths['/pages/{id}/competitors/top-posts'].get
  description: Assign a stable operationId for GET /pages/{id}/competitors/top-posts — the published spec declares
    none.
  update:
    operationId: getPagesByIdCompetitorsTopPosts
- target: $.paths['/pages/{id}/competitors/{scrapedPageId}'].delete
  description: Assign a stable operationId for DELETE /pages/{id}/competitors/{scrapedPageId} — the published spec
    declares none.
  update:
    operationId: deletePagesByIdCompetitorsByScrapedPageId
- target: $.info
  description: Record the runtime semantics Planable publishes in its developer guide but omits from the spec.
  update:
    x-rate-limits:
      read: 600 requests/minute per token
      write: 120 requests/minute per token
      algorithm: Redis-backed sliding window
      headers:
      - X-RateLimit-Limit
      - X-RateLimit-Remaining
      - X-RateLimit-Reset
      retry_after: false
      source: https://planable.io/guides/planable-public-api/
    x-error-catalog: errors/planable-problem-types.yml
    x-conventions: conventions/planable-conventions.yml
    x-idempotency:
      header: null
      mechanism: natural-key semantic idempotency on 4 operations
      detail: conventions/planable-conventions.yml
    x-plan-gate: API token generation requires a Pro or Enterprise plan
    x-docs: https://api.planable.io/api/v1/docs