GitLab · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for GitLab Applications API

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

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/api/v4/applications/{id}'].delete
$.paths['/api/v4/applications'].get
$.paths['/api/v4/applications'].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 GitLab Applications API
  version: 1.0.0
extends: openapi/gitlab-applications-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: 3
- target: $.paths['/api/v4/applications/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an OAuth application
      effect: destructive
      questions:
      - How do I remove an OAuth application registered on the instance?
      - Can an admin delete an instance-wide OAuth app by its ID?
      instructions:
      - text: Delete OAuth application {id}.
        slots:
          id: path.id
      - text: Remove the registered application {id} from the instance.
        slots:
          id: path.id
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v4/applications'].get
  update:
    x-apievangelist-phrasing:
      intent: List registered OAuth applications
      effect: read
      questions:
      - Which OAuth applications are registered on my GitLab instance?
      - Where can I see the redirect URIs of every instance application?
      instructions:
      - text: List all registered OAuth applications.
      - text: Show every instance-wide application and its callback URL.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v4/applications'].post
  update:
    x-apievangelist-phrasing:
      intent: Register a new OAuth application
      effect: write
      questions:
      - How do I register an instance-wide OAuth app so I get a client ID and secret?
      - Can I create a non-confidential application for a mobile or single-page client?
      instructions:
      - text: Register an application named {name} with redirect URI {redirect_uri} and scopes {scopes}.
        slots:
          name: requestBody.name
          redirect_uri: requestBody.redirect_uri
          scopes: requestBody.scopes
      - text: Create OAuth app {name} for {redirect_uri} requesting {scopes}, confidential set to {confidential}.
        slots:
          name: requestBody.name
          redirect_uri: requestBody.redirect_uri
          scopes: requestBody.scopes
          confidential: requestBody.confidential
      method: generated
      generated: '2026-09-26'