People Data Labs · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for api.peopledatalabs.com Cleaner Endpoints API

7 actions 7 updates phrasing extends openapi/peopledatalabs-cleaner-endpoints-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for People Data Labs's API. It is a proposal applied on top of the contract, not a document People Data Labs publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/v5/company/clean'].get
$.paths['/v5/company/clean'].post
$.paths['/v5/school/clean'].get
$.paths['/v5/school/clean'].post
$.paths['/v5/location/clean'].get
$.paths['/v5/location/clean'].post

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 api.peopledatalabs.com Cleaner Endpoints API
  version: 1.0.0
extends: openapi/peopledatalabs-cleaner-endpoints-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: 6
- target: $.paths['/v5/company/clean'].get
  update:
    x-apievangelist-phrasing:
      intent: Clean and standardize a company name
      effect: read
      questions:
      - How do I normalize a messy company name into its canonical form?
      - Can I clean a company record using just its website?
      instructions:
      - text: Clean the company name {name}.
        slots:
          name: query.name
      - text: Standardize the company behind website {website} with a GET cleaner call.
        slots:
          website: query.website
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v5/company/clean'].post
  update:
    x-apievangelist-phrasing:
      intent: Clean a company record from a POST body
      effect: read
      questions:
      - Can I send a company's social profile in a JSON body to get its cleaned record?
      - Is there a POST form of the company cleaner?
      instructions:
      - text: POST company name {name} to the company cleaner.
        slots:
          name: requestBody.name
      - text: Clean the company whose social profile is {profile} using the POST body.
        slots:
          profile: requestBody.profile
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v5/school/clean'].get
  update:
    x-apievangelist-phrasing:
      intent: Clean and standardize a school name
      effect: read
      questions:
      - What does the canonical version of a university name look like after cleaning?
      - Can I standardize a college using its website address?
      instructions:
      - text: Clean the school name {name}.
        slots:
          name: query.name
      - text: Standardize the university with website {website} through a GET request.
        slots:
          website: query.website
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v5/school/clean'].post
  update:
    x-apievangelist-phrasing:
      intent: Clean a school record from a POST body
      effect: read
      questions:
      - Can I clean a university by sending its LinkedIn page in a request body?
      - Is there a POST version of the school cleaner?
      instructions:
      - text: POST school name {name} to the school cleaner.
        slots:
          name: requestBody.name
      - text: Clean the college whose social profile is {profile} with the POST body.
        slots:
          profile: requestBody.profile
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v5/location/clean'].get
  update:
    x-apievangelist-phrasing:
      intent: Clean and standardize a raw location
      effect: read
      questions:
      - How do I turn a free-text location like 'sf ca' into a standardized place?
      - Can I parse a raw address string into locality, region and country?
      instructions:
      - text: Clean the raw location {location}.
        slots:
          location: query.location
      - text: Standardize {location} into a structured place with a GET request.
        slots:
          location: query.location
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v5/location/clean'].post
  update:
    x-apievangelist-phrasing:
      intent: Clean a raw location from a POST body
      effect: read
      questions:
      - Can I send a raw location in a JSON body to have it cleaned?
      - Is there a POST form of the location cleaner?
      instructions:
      - text: POST the raw location {location} to the location cleaner.
        slots:
          location: requestBody.location
      - text: Send {location} in a request body and return the cleaned location.
        slots:
          location: requestBody.location
      method: generated
      generated: '2026-10-01'