GitDealFlow · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Gitdealflow Com Signals API

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

What the actions change

x-apievangelist-phrasing

Targets 7

$.info
$.paths['/api/signals.json'].get
$.paths['/api/signals.csv'].get
$.paths['/api/signal'].get
$.paths['/api/dataset.jsonl'].get
$.paths['/api/v1/signals.json'].get
$.paths['/api/v1/dataset.jsonl'].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 Gitdealflow Com Signals API
  version: 1.0.0
extends: openapi/gitdealflow-com-signals-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['/api/signals.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the current startup signals snapshot
      effect: read
      questions:
      - Which startups are trending this period by commit velocity?
      - What are the per-sector rankings of startup engineering signals?
      instructions:
      - text: Get the current startup signals snapshot as JSON.
      - text: Show the top-20 trending startups and sector rankings.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/signals.csv'].get
  update:
    x-apievangelist-phrasing:
      intent: Download the signals snapshot as CSV
      effect: read
      questions:
      - Can I get the startup signals snapshot as a spreadsheet-friendly CSV?
      - Is there a CSV export of this period's signals?
      instructions:
      - text: Download the signals snapshot as CSV.
      - text: Export this period's startup signals to a CSV file.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/signal'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the signal for one startup
      effect: read
      questions:
      - What's the engineering signal for a specific startup?
      - Does the company lookup accept a GitHub org slug or fuzzy name?
      instructions:
      - text: Get the engineering signal for {company}.
        slots:
          company: query.company
      - text: Look up {company}'s commit velocity and contributor growth.
        slots:
          company: query.company
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/dataset.jsonl'].get
  update:
    x-apievangelist-phrasing:
      intent: Download the per-startup NDJSON dataset
      effect: read
      questions:
      - Can I stream the full per-startup dataset into pandas or DuckDB?
      - Is there an NDJSON dump of every startup for a training pipeline?
      instructions:
      - text: Download the full per-startup dataset as NDJSON.
      - text: Stream the unversioned JSONL dataset.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/signals.json'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the signals snapshot from the v1 path
      effect: read
      questions:
      - Is there a versioned v1 URL for the signals JSON snapshot?
      - Can my procurement automation pin to the v1 signals path?
      instructions:
      - text: Fetch the signals snapshot from the versioned v1 path.
      - text: Pull the v1 alias of the signals JSON.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/v1/dataset.jsonl'].get
  update:
    x-apievangelist-phrasing:
      intent: Download the NDJSON dataset from the v1 path
      effect: read
      questions:
      - Can I pin to a versioned v1 URL for the NDJSON dataset?
      - Where's the v1 alias of the per-startup JSONL dump?
      instructions:
      - text: Download the per-startup NDJSON dataset from the v1 path.
      - text: Pull the v1 alias of the JSONL dataset.
      method: generated
      generated: '2026-10-01'