overlay: 1.0.0
info:
title: API Evangelist enhancements — Fermyon device-codes-api API
version: 1.0.0
extends: fermyon-device-codes-api-openapi.yml
x-generated: '2026-09-09'
x-method: generated
x-source: API Evangelist enrichment pipeline; targets openapi/fermyon-device-codes-api-openapi.yml
x-note: Fermyon publishes the Cloud API contract without a single operationId (verified against https://raw.githubusercontent.com/fermyon/cloud-openapi/main/swagger.json
on 2026-09-09). These operationIds are computed deterministically from HTTP method + path by API Evangelist and
are NOT names Fermyon publishes. They are kept in this overlay rather than written into the spec so the provider
contract stays unmodified.
actions:
- target: $.paths['/api/device-codes'].post
description: Add a stable operationId for POST /api/device-codes; the published contract declares none.
update:
operationId: createDeviceCodes
- target: $.paths['/api/device-codes/{userCode}'].get
description: Add a stable operationId for GET /api/device-codes/{userCode}; the published contract declares none.
update:
operationId: getDeviceCodesByUsercode
- target: $.paths['/api/device-codes/activate'].post
description: Add a stable operationId for POST /api/device-codes/activate; the published contract declares none.
update:
operationId: createDeviceCodesActivate
- target: $.info
description: Attach the provider documentation and contract source that the published document omits.
update:
contact:
name: Fermyon Cloud documentation
url: https://developer.fermyon.com/cloud/index
- target: $
description: Attach externalDocs pointing at the Fermyon Cloud REST API reference page.
update:
externalDocs:
description: Fermyon Cloud REST API reference
url: https://developer.fermyon.com/cloud/rest-api
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.