Green Button Alliance · OpenAPI Overlay 1.0.0

API Evangelist enhancements for the Green Button ApplicationInformation API

3 actions 3 updates update extends openapi/green-button-alliance-application-information-openapi.yml

Derived by API Evangelist Built from the contracts Green Button Alliance publishes. Green Button Alliance did not publish this file.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-providerx-apievangelist-rolex-apievangelist-artifactsx-apievangelist-server-statusx-apievangelist-deprecated-fieldsx-apievangelist-sensitive-fieldsx-apievangelist-scope-field-notex-apievangelist-push-field

Targets 3

$.info

$.servers

$.components.schemas.ApplicationInformation

OpenAPI Overlay

overlay: 1.0.0
info:
  title: API Evangelist enhancements for the Green Button ApplicationInformation API
  version: 1.0.0
extends: openapi/green-button-alliance-application-information-openapi.yml
x-generated: '2026-07-27'
x-method: generated
x-source: API Evangelist enrichment round 2026-07-27.
actions:
- target: $.info
  update:
    x-apievangelist-provider: green-button-alliance
    x-apievangelist-role: >-
      ApplicationInformation is Green Button's discovery document AND its RFC 7591 /
      RFC 7592 dynamic client registration record. Read it before integrating with any
      certified Data Custodian.
    x-apievangelist-artifacts:
      data_model: data-model/green-button-alliance-data-model.yml
      scopes: scopes/green-button-alliance-scopes.yml
      webhooks: asyncapi/green-button-alliance-webhooks.yml
- target: $.servers
  update:
    x-apievangelist-server-status:
    - {url: 'https://virtserver.swaggerhub.com/GreenButtonAlliance/Green_Button_Resource_Server', kind: mock, live: false}
    - {url: 'https://sandbox.greenbuttonalliance.org:8443/DataCustodian', probed: '2026-07-27', http_status: 403, live: false}
    - {url: 'https://sandboxdev.greenbuttonalliance.org:8443/DataCustodian', probed: '2026-07-27', http_status: 403, live: false}
- target: $.components.schemas.ApplicationInformation
  update:
    x-apievangelist-deprecated-fields:
    - thirdPartyScopeSelectionURI
    - dataCustodianScopeSelectionScreenURI
    x-apievangelist-sensitive-fields:
    - client_secret
    - registration_access_token
    x-apievangelist-scope-field-note: >-
      scope[] holds full ESPI function-block scope strings, one per supported
      capability set - not individual scope words. Decode against
      vocabulary/green-button-alliance-function-blocks.yml.
    x-apievangelist-push-field: thirdPartyNotifyUri is the webhook target for the FB_39 BatchList push notification.

Work with this as data

Every overlay here is available over the APIs.io API and to AI agents over MCP.

MCP server

One button, every client — Claude, Cursor, VS Code and the rest.

https://apis.io/mcp

Tools for openapi overlays

4 MCP tools reach this

find_overlaysBrowse and filter every overlay in the catalog.
apis_io_searchSTART HERE — APIs, providers and tags for one query, each with its total.
resolveTurn a domain, URL or GitHub org into the provider it belongs to.
find_cohortsEvery scored population of providers in the catalog.

All 92 tools →

Call it yourself

curl for this page

This overlay

curl "https://apis.io/api/v1/overlays/green-button-alliance-application-information-overlay"

All openapi overlays

curl "https://apis.io/api/v1/overlays?limit=25"

Calls without X-API-Key need no key. Calls with it need a paid plan — get a key.

Get an API key

Free tier, no form to fill in. Signing in shares your email address with us — we store it to create your key and to recognise you if you sign in with another provider. See our Privacy Policy and Terms.

GitHub Google LinkedIn

A second provider on the same verified email joins the account you already have.