OutSystems · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Code Quality Findings API

2 actions 2 updates phrasing extends openapi/outsystems-findings-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 2

$.info

$.paths['/findings'].get

OpenAPI Overlay

# 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 Findings API
  version: 1.0.0
extends: openapi/outsystems-findings-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: 1
- target: $.paths['/findings'].get
  update:
    x-apievangelist-phrasing:
      intent: List code quality findings
      effect: read
      questions:
      - What code quality findings does OutSystems report for my apps?
      - Can I filter findings by severity, category or status?
      - Which findings were detected by a particular code pattern?
      instructions:
      - text: List the code quality findings for assets {AssetKeys}.
        slots:
          AssetKeys: query.AssetKeys
      - text: Show findings with severity {Severities} and status {Status}.
        slots:
          Severities: query.Severities
          Status: query.Status
      - text: List findings raised by pattern {PatternIds}.
        slots:
          PatternIds: query.PatternIds
      method: generated
      generated: '2026-10-01'