Efí Pay (Gerencianet) · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Efí Pay Pix Locations API

5 actions 5 updates phrasing extends openapi/gerencianet-locations-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Efí Pay (Gerencianet)'s API. It is a proposal applied on top of the contract, not a document Efí Pay (Gerencianet) publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/v2/loc'].get
$.paths['/v2/loc'].post
$.paths['/v2/loc/{id}'].get
$.paths['/v2/loc/{id}/txid'].delete

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 Efí Pay Pix Locations API
  version: 1.0.0
extends: openapi/gerencianet-locations-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: 4
- target: $.paths['/v2/loc'].get
  update:
    x-apievangelist-phrasing:
      intent: List Pix payload locations
      effect: read
      questions:
      - Which Pix locations have I created for QR codes?
      - Can I see all my loc entries?
      instructions:
      - text: List my Pix locations.
      - text: Show all payload locations on my account.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/loc'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a Pix payload location
      effect: write
      questions:
      - How do I create a location to attach to a Pix charge?
      - Can I reserve a reusable payload URL for a QR code?
      instructions:
      - text: Create a new Pix location.
      - text: Reserve a payload location for a future charge.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/loc/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a Pix payload location
      effect: read
      questions:
      - Can I look up a Pix location and see which txid it's linked to?
      - What does a loc entry contain?
      instructions:
      - text: Show Pix location {id}.
        slots:
          id: path.id
      - text: Get the details of location {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v2/loc/{id}/txid'].delete
  update:
    x-apievangelist-phrasing:
      intent: Detach a charge from a Pix location
      effect: destructive
      questions:
      - Can I unlink a txid from a location so it can be reused?
      - What removes the charge bound to a loc?
      instructions:
      - text: Unlink the txid from location {id}.
        slots:
          id: path.id
      - text: Detach the charge from Pix location {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'