OutSystems · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Code Quality Patterns API

3 actions 3 updates phrasing extends openapi/outsystems-patterns-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['/patterns'].get
$.paths['/patterns/{patternId}'].get

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 Patterns API
  version: 1.0.0
extends: openapi/outsystems-patterns-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['/patterns'].get
  update:
    x-apievangelist-phrasing:
      intent: List code quality patterns
      effect: read
      questions:
      - Which code patterns can the OutSystems code analysis detect?
      - Can I page through the full catalog of code quality rules?
      instructions:
      - text: List all code quality patterns.
      - text: Show the first {Limit} code analysis patterns.
        slots:
          Limit: query.Limit
      method: generated
      generated: '2026-10-01'
- target: $.paths['/patterns/{patternId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a code quality pattern
      effect: read
      questions:
      - What does a specific code pattern detect, and how severe is it?
      - How do I read the detection rules for one pattern?
      instructions:
      - text: Get code pattern {patternId}.
        slots:
          patternId: path.patternId
      - text: Explain the category and severity of pattern {patternId}.
        slots:
          patternId: path.patternId
      method: generated
      generated: '2026-10-01'