AI Applyd · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Aiapplyd Public Competitors API

4 actions 4 updates phrasing extends openapi/aiapplyd-public-competitors-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for AI Applyd's API. It is a proposal applied on top of the contract, not a document AI Applyd publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/public/competitors'].get
$.paths['/public/competitors/{slug}'].get
$.paths['/public/competitors/{slug}/alternatives'].get

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Aiapplyd Public Competitors API
  version: 1.0.0
extends: openapi/aiapplyd-public-competitors-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/public/competitors'].get
  update:
    x-apievangelist-phrasing:
      intent: List published comparison pages
      effect: read
      questions:
      - Which tools does AIApplyd publish comparison pages for?
      - What entries appear on the compare index?
      instructions:
      - text: List all published comparison pages.
      - text: Show the compare index with names, logos and taglines.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/public/competitors/{slug}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a comparison page by slug
      effect: read
      questions:
      - What does the full head-to-head comparison page for one tool contain?
      - Can I get the FAQs and comparison rows for a single comparison page?
      instructions:
      - text: Get the comparison page for {slug}.
        slots:
          slug: path.slug
      - text: Show the pillars, comparison rows and FAQs for {slug}.
        slots:
          slug: path.slug
      method: generated
      generated: '2026-09-26'
- target: $.paths['/public/competitors/{slug}/alternatives'].get
  update:
    x-apievangelist-phrasing:
      intent: List alternatives to a compared tool
      effect: read
      questions:
      - What alternatives are listed for a given compared tool, with pros and cons?
      - Why would an alternatives page return not found?
      instructions:
      - text: List alternatives to {slug}.
        slots:
          slug: path.slug
      - text: Show pros and cons of the alternatives page for {slug}.
        slots:
          slug: path.slug
      method: generated
      generated: '2026-09-26'