Wappalyzer · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Wappalyzer Public Lists API

6 actions 6 updates phrasing extends openapi/wappalyzer-lists-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for Wappalyzer's API. It is a proposal applied on top of the contract, not a document Wappalyzer publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info

$.paths['/lists'].get

$.paths['/lists'].post

$.paths['/lists/{id}'].get

$.paths['/lists/{id}'].post

$.paths['/lists/{id}'].delete

OpenAPI Overlay

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Wappalyzer Public Lists API
  version: 1.0.0
extends: openapi/wappalyzer-lists-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/lists'].get
  update:
    x-apievangelist-phrasing:
      intent: List the lead lists I have created
      effect: read
      questions:
      - Which lead lists have I already created?
      - Can I see all my lead lists and their status in one place?
      - Where do I find every lead list on my Wappalyzer account?
      instructions:
      - text: List all the lead lists I've created.
      - text: Show me every lead list on my account.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/lists'].post
  update:
    x-apievangelist-phrasing:
      intent: Build a new lead list of websites by technology
      effect: write
      questions:
      - How do I build a list of websites that use a particular technology?
      - Can I narrow a new lead list by country, industry or company size?
      - Is it possible to get a callback when a new lead list is ready?
      instructions:
      - text: Create a lead list of websites using {technologies} in {countries}.
        slots:
          technologies: requestBody.technologies
          countries: requestBody.countries
      - text: Build a new lead list for {industries} companies of size {companySizes}.
        slots:
          industries: requestBody.industries
          companySizes: requestBody.companySizes
      - text: Start a lead list of sites in category {categories} and notify {callbackUrl} when it's ready.
        slots:
          categories: requestBody.categories
          callbackUrl: requestBody.callbackUrl
      - text: Create a lead list from {baseListId} excluding sites already in {excludeListId}.
        slots:
          baseListId: requestBody.baseListId
          excludeListId: requestBody.excludeListId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/lists/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Fetch one lead list and its status
      effect: read
      questions:
      - Is my lead list ready yet?
      - How do I get the details of a single lead list by its id?
      instructions:
      - text: Fetch lead list {id}.
        slots:
          id: path.id
      - text: Check whether lead list {id} has finished building.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/lists/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Spend credits to finalize a ready lead list
      effect: destructive
      questions:
      - How do I pay credits to unlock a lead list once it's ready?
      - What do I need to do to finalize a lead list so I can download it?
      instructions:
      - text: Finalize lead list {id} and spend {spendCredits} credits on it.
        slots:
          id: path.id
          spendCredits: requestBody.spendCredits
      - text: Spend the credits to complete ready lead list {id}, confirming with {spendCredits}.
        slots:
          id: path.id
          spendCredits: requestBody.spendCredits
      method: generated
      generated: '2026-10-01'
- target: $.paths['/lists/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a lead list
      effect: destructive
      questions:
      - Can I remove a lead list I no longer need?
      - What happens if I delete one of my lead lists?
      instructions:
      - text: Delete lead list {id}.
        slots:
          id: path.id
      - text: Remove the lead list {id} from my account.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'