Button · OpenAPI Overlay 1.0.0

API Evangelist enhancements for Button Brands API

2 actions 2 updates documentation extends openapi/usebutton-brands-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Button's API. It is a proposal applied on top of the contract, not a document Button publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelistdescriptiontagsx-apievangelist-notes

Targets 2

$.info
$.paths['/'].get

OpenAPI Overlay

Raw ↑ 
# generated: '2026-07-21'
# method: generated
# source: API Evangelist enrichment pipeline (enhancements over the harvested spec; original left unmutated)
overlay: 1.0.0
info:
  title: API Evangelist enhancements for Button Brands API
  version: 1.0.0
extends: openapi/usebutton-brands-openapi.yml
actions:
  - target: $.info
    update:
      x-apievangelist:
        provider: usebutton
        artifacts:
          authentication: authentication/usebutton-authentication.yml
          errors: errors/usebutton-problem-types.yml
          conventions: conventions/usebutton-conventions.yml
      description: Retrieve details for the Brands partnered with your organization via Button, including app schemes, supported hostnames, and commission terms and conditions.
  - target: $.paths['/'].get
    update:
      tags:
        - Brands
      x-apievangelist-notes: Static brand metadata; Button advises against calling this in the critical path of routing a user to a Brand.