Bitly · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Bitly User API

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

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/user'].get
$.paths['/user'].patch
$.paths['/user/platform_limits'].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 Bitly User API
  version: 1.0.0
extends: openapi/bitly-user-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['/user'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the current user's profile
      effect: read
      questions:
      - How do I find out which Bitly user my access token belongs to?
      - What is my default group and account name?
      instructions:
      - text: Show my Bitly user profile.
      - text: Tell me who the authenticated user is and what their default group is.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update the current user's name or default group
      effect: write
      questions:
      - Can I change the display name on my own user account?
      - How do I switch which group new links go into by default?
      instructions:
      - text: Change my user name to {name}.
        slots:
          name: requestBody.name
      - text: Set my default group to {default_group_guid}.
        slots:
          default_group_guid: requestBody.default_group_guid
      method: generated
      generated: '2026-09-26'
- target: $.paths['/user/platform_limits'].get
  update:
    x-apievangelist-phrasing:
      intent: Check API platform limits and usage counts
      effect: read
      questions:
      - What API rate limits apply to my account and how much have I used?
      - Can I check the platform limit for one specific endpoint path?
      instructions:
      - text: Show all my platform limits and current counts.
      - text: Check the platform limit for the {path} endpoint.
        slots:
          path: query.path
      method: generated
      generated: '2026-09-26'