OutSystems · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Code Quality Code Analyses API

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

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/code-analyses/{analysisKey}'].get
$.paths['/code-analyses'].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 Code Quality Code Analyses API
  version: 1.0.0
extends: openapi/outsystems-code-analyses-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: 2
- target: $.paths['/code-analyses/{analysisKey}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the result of a code analysis request
      effect: read
      questions:
      - Has the code analysis I submitted finished, and what score did it get?
      - Can I page through the findings returned by one code analysis request?
      instructions:
      - text: Get the status and results of code analysis {analysisKey}.
        slots:
          analysisKey: path.analysisKey
      - text: Show the quality score and findings from analysis {analysisKey}.
        slots:
          analysisKey: path.analysisKey
      method: generated
      generated: '2026-10-01'
- target: $.paths['/code-analyses'].post
  update:
    x-apievangelist-phrasing:
      intent: Run a code analysis on an asset revision
      effect: write
      questions:
      - How do I request a code quality scan of one revision of my app?
      - What do I get back after submitting a code analysis so I can track it?
      instructions:
      - text: Run a code analysis on revision {assetRevision} of asset {assetKey}.
        slots:
          assetRevision: requestBody.assetRevision
          assetKey: requestBody.assetKey
      - text: Submit asset {assetKey} at revision {assetRevision} for code quality analysis.
        slots:
          assetKey: requestBody.assetKey
          assetRevision: requestBody.assetRevision
      method: generated
      generated: '2026-10-01'