overlay: 1.0.0
info:
title: API Evangelist enhancements for the PlantPredict Performance API
version: 1.0.0
extends: openapi/terabase-energy-plantpredict-openapi-original.yaml
x-generated: '2026-08-05'
x-method: generated
x-source: >-
Enhancements derived from artifacts in this repo. The original harvested spec is never mutated; apply this overlay
to reproduce our annotations.
actions:
- target: $.info
update:
x-apievangelist-provider: terabase-energy
x-apievangelist-product: PlantPredict
x-apievangelist-artifacts:
authentication: authentication/terabase-energy-authentication.yml
scopes: scopes/terabase-energy-scopes.yml
conventions: conventions/terabase-energy-conventions.yml
errors: errors/terabase-energy-problem-types.yml
rate_limits: rate-limits/terabase-energy-rate-limits.yml
lifecycle: lifecycle/terabase-energy-lifecycle.yml
changelog: changelog/terabase-energy-changelog.yml
data_model: data-model/terabase-energy-data-model.yml
conformance: conformance/terabase-energy-conformance.yml
mcp: mcp/terabase-energy-mcp.yml
a2a: a2a/terabase-energy-a2a.yml
skills: skills/_index.yml
- target: $.info
update:
x-error-format: vendor
x-error-format-note: >-
Not RFC 9457. Errors arrive as ASP.NET model-state JSON, free-form text/plain, or an empty body; branch on
Content-Type.
x-idempotency: none
x-idempotency-note: >-
No idempotency key mechanism is published. A repeated create produces a second entity and an X-Message warning.
x-rate-limit-signal:
status: 429
retry_after: false
backoff: exponential from 30s
- target: $.components.securitySchemes
update:
plantPredictOAuth:
type: oauth2
description: >-
The upstream spec advertises only a bearer scheme, but the API description documents an OAuth 2.0 client
credentials exchange against AWS Cognito. Declared here so generated clients can perform the token exchange.
flows:
clientCredentials:
tokenUrl: https://terabase-prd.auth.us-west-2.amazoncognito.com/oauth2/token
scopes:
transactions/get: Read access to the PlantPredict API surface.
transactions/post: Write access to the PlantPredict API surface.
- target: $.servers
update:
- url: https://api.plantpredict.terabase.energy
description: Production
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.