Netlify · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Netlify's API documentation Build Log Msg API

2 actions 2 updates phrasing extends openapi/netlify-buildlogmsg-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Netlify's API. It is a proposal applied on top of the contract, not a document Netlify publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 2

$.info
$.paths['/builds/{build_id}/log'].post

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 Netlify's API documentation Build Log Msg API
  version: 1.0.0
extends: openapi/netlify-buildlogmsg-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-09-26'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 1
- target: $.paths['/builds/{build_id}/log'].post
  update:
    x-apievangelist-phrasing:
      intent: Append a message to a build log
      effect: write
      questions:
      - Can I write a custom message into a build's log?
      - Is it possible to flag a build log line as an error?
      instructions:
      - text: Add {message} to the log of build {build}.
        slots:
          message: requestBody.message
          build: path.build_id
      - text: Write {message} to build {build}'s log under section {section}.
        slots:
          message: requestBody.message
          build: path.build_id
          section: requestBody.section
      method: generated
      generated: '2026-09-26'