Amazon FreeRTOS · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Amazon FreeRTOS Management Software Configurations API

6 actions 6 updates phrasing extends openapi/amazon-freertos-software-configurations-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Amazon FreeRTOS's API. It is a proposal applied on top of the contract, not a document Amazon FreeRTOS publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 6

$.info
$.paths['/software-configuration-records'].get
$.paths['/software-configuration-records'].post
$.paths['/software-configuration-records/{configId}'].get
$.paths['/software-configuration-records/{configId}'].put
$.paths['/software-configuration-records/{configId}'].delete

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 Amazon FreeRTOS Management Software Configurations API
  version: 1.0.0
extends: openapi/amazon-freertos-software-configurations-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 5
- target: $.paths['/software-configuration-records'].get
  update:
    x-apievangelist-phrasing:
      intent: List FreeRTOS software configurations
      effect: read
      questions:
      - Which FreeRTOS software configurations have I saved so far?
      - Is there a way to page through all my FreeRTOS library configurations?
      instructions:
      - text: List my FreeRTOS software configurations.
      - text: Show the next {maxResults} software configurations after token {nextToken}.
        slots:
          maxResults: query.maxResults
          nextToken: query.nextToken
      method: generated
      generated: '2026-10-01'
- target: $.paths['/software-configuration-records'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a FreeRTOS configuration for a board
      effect: write
      questions:
      - How do I set up a FreeRTOS configuration of libraries for my microcontroller board?
      - Can I save a new FreeRTOS library setup targeted at a specific hardware platform?
      instructions:
      - text: Create a FreeRTOS software configuration named {name} for hardware platform {hardwarePlatform}.
        slots:
          name: requestBody.name
          hardwarePlatform: requestBody.hardwarePlatform
      - text: Make a new configuration {name} for {hardwarePlatform} described as {description}.
        slots:
          name: requestBody.name
          hardwarePlatform: requestBody.hardwarePlatform
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/software-configuration-records/{configId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one FreeRTOS software configuration
      effect: read
      questions:
      - What libraries and hardware platform does a particular FreeRTOS configuration use?
      - Can I pull up the full record for one saved software configuration by its ID?
      instructions:
      - text: Show software configuration {configId}.
        slots:
          configId: path.configId
      - text: Describe the FreeRTOS configuration with ID {configId}.
        slots:
          configId: path.configId
      method: generated
      generated: '2026-10-01'
- target: $.paths['/software-configuration-records/{configId}'].put
  update:
    x-apievangelist-phrasing:
      intent: Rename or redescribe a software configuration
      effect: write
      questions:
      - How do I rename an existing FreeRTOS software configuration?
      - Can I change the description on a configuration I already created?
      instructions:
      - text: Rename software configuration {configId} to {name}.
        slots:
          configId: path.configId
          name: requestBody.name
      - text: Update the description of configuration {configId} to {description}.
        slots:
          configId: path.configId
          description: requestBody.description
      method: generated
      generated: '2026-10-01'
- target: $.paths['/software-configuration-records/{configId}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a FreeRTOS software configuration
      effect: destructive
      questions:
      - How do I get rid of a FreeRTOS software configuration I don't use anymore?
      - Is deleting a saved FreeRTOS configuration record permanent?
      instructions:
      - text: Delete software configuration {configId}.
        slots:
          configId: path.configId
      - text: Remove the FreeRTOS configuration record {configId}.
        slots:
          configId: path.configId
      method: generated
      generated: '2026-10-01'