API Evangelist enhancements for EnergyAustralia CDR Common Data Holder Customers API

overlay: 1.0.0
info:
  title: API Evangelist enhancements for EnergyAustralia CDR Common Data Holder Customers API
  version: 1.0.0
extends: openapi/energyaustralia-data-holder-customers-api-openapi.yml
x-apievangelist:
  generated: '2026-10-21'
  method: generated
  source: Regenerated for the split contract openapi/energyaustralia-data-holder-customers-api-openapi.yml
    from the superseded overlay for the combined CDR common contract (2026-07-27 live probes of the EnergyAustralia
    CDR brand path). Verification dates inside actions are the original probe dates; nothing was re-probed
    in this pass.
actions:
- target: $.info
  update:
    x-apievangelist-provider: energyaustralia
    x-apievangelist-provider-name: EnergyAustralia
    x-apievangelist-spec-provenance: Split by the refine step (2026-10-18) from the verbatim Data Standards
      Body contract in openapi/_original/energyaustralia-cds-common-api-openapi.yml; not authored by EnergyAustralia.
    x-apievangelist-verified: '2026-07-27'
- target: $.servers
  update:
  - url: https://authncdr.energyaustralia.com.au/cds-au/v1
    description: EnergyAustralia's registered CDR publicBaseUri. Serves the two authenticated Customer
      operations. ACCREDITED-ONLY; HTTP 404 on every anonymous probe.
    x-access: accredited-only
    x-verified: false
  - url: https://mtls.dh.example.com/cds-au/v1
    description: MTLS (original Data Standards Body placeholder, retained for reference)
- target: $.components
  update:
    securitySchemes:
      cdrOAuth2:
        type: oauth2
        description: CDR Information Security profile — FAPI 1.0 Advanced. Not declared in the source
          document; added so the customer operations carry a machine-checkable contract. Endpoint URLs
          are unverified (OIDC discovery is not anonymously reachable).
        flows:
          authorizationCode:
            authorizationUrl: https://authncdr.energyaustralia.com.au/authorize
            tokenUrl: https://authncdr.energyaustralia.com.au/token
            x-unverified: true
            scopes:
              openid: Mandatory OpenID Connect base scope
              common:customer.basic:read: Name and occupation, or organisation name and ABN/ACN
              common:customer.detail:read: Basic customer data plus phone, email and addresses
      cdrMutualTLS:
        type: mutualTLS
        description: CDR Register-issued client transport certificate.
- target: $.paths['/common/customer'].get
  update:
    x-access: accredited-only
    x-apievangelist-note: Not reachable on the AER gateway — the gateway serves product data only. Served
      by authncdr.energyaustralia.com.au to accredited Data Recipients under consent.
- target: $.paths['/common/customer/detail'].get
  update:
    x-access: accredited-only
    x-apievangelist-note: Not reachable on the AER gateway. Accredited-only under CDR consent.