GitLab · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for GitLab Metadata API

2 actions 2 updates phrasing extends openapi/gitlab-metadata-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 2

$.info

$.paths['/api/v4/metadata'].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 GitLab Metadata API
  version: 1.0.0
extends: openapi/gitlab-metadata-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: 1
- target: $.paths['/api/v4/metadata'].get
  update:
    x-apievangelist-phrasing:
      intent: Get metadata about the GitLab instance
      effect: read
      questions:
      - What version and revision is this GitLab instance running?
      - Where can I read the descriptive metadata of the instance I'm connected to?
      instructions:
      - text: Show the instance metadata.
      - text: Retrieve the version and other metadata details of this instance.
      method: generated
      generated: '2026-09-26'