skills/ycloud-balance/references/openapi.md

<!-- Generated by scripts/build_openapi_skill_references.py; do not edit. -->
# OpenAPI contract: Account balance

## Provenance

- Source: `ycloud-api-v2.yaml` (pinned release snapshot).
- Source SHA-256: `8592bd4cc37186655a480dd86ce6bac6731543727327a2871d9103a0b8ed9e81`
- OpenAPI version: `3.0.0`
- API info.version: `v2`
- This derived reference does not replace the upstream API Owner's canonical source.
- Generated deterministically from normalized JSON; do not edit this file by hand.

## Scope and handoff

- This read operation reports account balance. Balance evidence is a readiness input, not a send, acceptance, or delivery guarantee.
- Operation coverage: `1`

## Operations

### `GET /balance` — `balance-retrieve`

- Summary: Retrieve balance
- Description:
  > Retrieves the current account balance.
- Parameters: none
- Request body: none
- Responses:
  - `200`: Successfully retrieved balance.
    - `application/json`: `#/components/schemas/Balance`
      - `$ref`: `#/components/schemas/Balance`

## Referenced schema and parameter shapes

### `Balance`

- Reference: `#/components/schemas/Balance`
- Shape: `object`
  - Required properties: `amount`, `currency`
  - Properties:
    - `amount`: `number (double)` (required)
      - Description:
        > Balance of current account.
      - Constraints: example=190.0765
    - `currency`: `string` (required)
      - Description:
        > Price currency. [ISO 4217 currency code](https://en.wikipedia.org/wiki/ISO_4217).
      - Constraints: example="USD"

## Codegen interpretation and unknowns

- `operationId` identifies the OpenAPI operation; it is not an SDK method name.
- `allOf` is wire-level schema composition. Response adapters must merge inherited and local properties; generated model inheritance/flattening is only a codegen shape, not additional API behavior.
- `x-group-parameters`, `x-enum-varnames`, and `x-enum-descriptions` are generator hints, not business rules.
- Description-only constraints (including conditional fields, precedence, and endpoint-specific behavior) remain verbatim above.
- This OpenAPI snapshot does not confirm cross-cutting error, retry/`Retry-After`, rate-limit, idempotency, delivery, or webhook-signature behavior. Consult the reviewed `runtime.md`; if neither source confirms a fact, do not fill it in.