GitDealFlow · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Gitdealflow Com Badges API

4 actions 4 updates phrasing extends openapi/gitdealflow-com-badges-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 4

$.info
$.paths['/api/badge/scout/{username}/svg'].get
$.paths['/api/badge/built-with/svg'].get
$.paths['/api/badge/momentum/{org}/{repo}/svg'].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 Badges API
  version: 1.0.0
extends: openapi/gitdealflow-com-badges-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: 3
- target: $.paths['/api/badge/scout/{username}/svg'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Scout Score badge for a GitHub user
      effect: read
      questions:
      - Can I show a GitHub user's Scout Score as an SVG badge?
      - How do I embed a scout badge in my GitHub profile README?
      instructions:
      - text: Generate the Scout Score SVG badge for {username}.
        slots:
          username: path.username
      - text: Get the scout badge image for GitHub user {username}.
        slots:
          username: path.username
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/badge/built-with/svg'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the Built with VC Deal Flow Signal badge
      effect: read
      questions:
      - Is there a 'Built with VC Deal Flow Signal' badge I can put on my project?
      - Where do I get the attribution badge for projects using this data?
      instructions:
      - text: Get the Built with VC Deal Flow Signal SVG badge.
      - text: Give me the attribution badge for my README.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/api/badge/momentum/{org}/{repo}/svg'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a momentum badge for a repository
      effect: read
      questions:
      - Can I display a repo's engineering momentum as a badge?
      - How do I add a momentum SVG badge to a GitHub repository README?
      instructions:
      - text: Generate the momentum badge for {org}/{repo}.
        slots:
          org: path.org
          repo: path.repo
      - text: Get the repo momentum SVG for repository {repo} in org {org}.
        slots:
          org: path.org
          repo: path.repo
      method: generated
      generated: '2026-10-01'