Home Connect (BSH appliances) · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Home Connect Settings API

5 actions 5 updates phrasing extends openapi/home-connect-settings-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Home Connect (BSH appliances)'s API. It is a proposal applied on top of the contract, not a document Home Connect (BSH appliances) publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 5

$.info
$.paths['/homeappliances/{haId}/settings'].get
$.paths['/homeappliances/{haId}/settings'].put
$.paths['/homeappliances/{haId}/settings/{settingkey}'].get
$.paths['/homeappliances/{haId}/settings/{settingkey}'].put

OpenAPI Overlay

Raw ↑
# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Home Connect Settings API
  version: 1.0.0
extends: openapi/home-connect-settings-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-11-19'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/homeappliances/{haId}/settings'].get
  update:
    x-apievangelist-phrasing:
      intent: List a home appliance's settings
      effect: read
      questions:
      - What settings can I read from a home appliance?
      - Which setting keys are available on a washer or oven?
      instructions:
      - text: List the settings of home appliance {haId}.
        slots:
          haId: path.haId
      - text: Show all configurable settings on {haId}.
        slots:
          haId: path.haId
      method: generated
      generated: '2026-11-19'
- target: $.paths['/homeappliances/{haId}/settings'].put
  update:
    x-apievangelist-phrasing:
      intent: Set several settings on a home appliance
      effect: write
      questions:
      - How do I change multiple settings on a home appliance at once?
      - Can I send several setting values in one request?
      instructions:
      - text: 'Set these settings on home appliance {haId}: {data}.'
        slots:
          haId: path.haId
          data: requestBody.data
      - text: Update several settings on {haId} in one call.
        slots:
          haId: path.haId
      method: generated
      generated: '2026-11-19'
- target: $.paths['/homeappliances/{haId}/settings/{settingkey}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one setting value
      effect: read
      questions:
      - What is the current value of a single setting on a home appliance?
      - Can I read one setting key by its name?
      instructions:
      - text: Get setting {settingkey} on home appliance {haId}.
        slots:
          settingkey: path.settingkey
          haId: path.haId
      - text: Show the value of {settingkey} for {haId}.
        slots:
          settingkey: path.settingkey
          haId: path.haId
      method: generated
      generated: '2026-11-19'
- target: $.paths['/homeappliances/{haId}/settings/{settingkey}'].put
  update:
    x-apievangelist-phrasing:
      intent: Set one setting value
      effect: write
      questions:
      - How do I change a single setting on a home appliance?
      - Can I set one setting key to a new value?
      instructions:
      - text: Set setting {settingkey} on home appliance {haId} to {data}.
        slots:
          settingkey: path.settingkey
          haId: path.haId
          data: requestBody.data
      - text: Change only {settingkey} on {haId}.
        slots:
          settingkey: path.settingkey
          haId: path.haId
      method: generated
      generated: '2026-11-19'

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/home-connect-settings-api-phrasing-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. By signing up you are subscribing to the APIs.io and API Evangelist newsletters — you can unsubscribe from any issue. See our Privacy Policy and Terms.

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