GitLab · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for GitLab Application API

5 actions 5 updates phrasing extends openapi/gitlab-application-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 5

$.info
$.paths['/api/v4/application/appearance'].get
$.paths['/api/v4/application/appearance'].put
$.paths['/api/v4/application/plan_limits'].get
$.paths['/api/v4/application/plan_limits'].put

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 Application API
  version: 1.0.0
extends: openapi/gitlab-application-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: 4
- target: $.paths['/api/v4/application/appearance'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the instance's appearance settings
      effect: read
      questions:
      - What title, logo and header message is my GitLab instance currently using?
      - How can I read the current branding settings of the instance?
      instructions:
      - text: Show the current instance appearance settings.
      - text: Get the sign-in title, logos and system header message.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v4/application/appearance'].put
  update:
    x-apievangelist-phrasing:
      intent: Change the instance's branding and appearance
      effect: write
      questions:
      - How do I set a custom logo and sign-in title for my self-managed GitLab?
      - Can I add a system-wide header or footer message?
      - Is it possible to change the progressive web app name?
      instructions:
      - text: Set the instance sign-in title to {title}.
        slots:
          title: requestBody.title
      - text: Show the header message {header_message} on every page.
        slots:
          header_message: requestBody.header_message
      - text: Upload {logo} as the instance logo.
        slots:
          logo: requestBody.logo
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v4/application/plan_limits'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a plan's limits
      effect: read
      questions:
      - What limits apply to a plan on my GitLab instance, like max pipeline size?
      - How do I check the package file size limits for the default plan?
      instructions:
      - text: Show the current plan limits.
      - text: Get the limits for plan {plan_name}.
        slots:
          plan_name: query.plan_name
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v4/application/plan_limits'].put
  update:
    x-apievangelist-phrasing:
      intent: Change a plan's limits
      effect: write
      questions:
      - How do I raise the maximum npm package size for a plan?
      - Can I cap the number of active CI jobs or pipeline schedules per plan?
      instructions:
      - text: Set the maximum active CI jobs on plan {plan_name} to {ci_active_jobs}.
        slots:
          plan_name: requestBody.plan_name
          ci_active_jobs: requestBody.ci_active_jobs
      - text: Raise the npm package size limit on {plan_name} to {npm_max_file_size} bytes.
        slots:
          plan_name: requestBody.plan_name
          npm_max_file_size: requestBody.npm_max_file_size
      - text: Limit plan {plan_name} to {ci_pipeline_schedules} pipeline schedules.
        slots:
          plan_name: requestBody.plan_name
          ci_pipeline_schedules: requestBody.ci_pipeline_schedules
      method: generated
      generated: '2026-09-26'