GitLab · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for GitLab OAuth 2.0 User Info API

2 actions 2 updates phrasing extends openapi/gitlab-user-info-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['/oauth/userinfo'].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 GitLab OAuth 2.0 User Info API
  version: 1.0.0
extends: openapi/gitlab-user-info-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['/oauth/userinfo'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the signed-in user's OpenID profile
      effect: read
      questions:
      - How do I get the name and email of the user who signed in with OpenID Connect?
      - What profile claims come back from the userinfo endpoint for my token?
      instructions:
      - text: Get the OpenID userinfo for the signed-in user.
      - text: Show who my OAuth token belongs to.
      method: generated
      generated: '2026-09-26'