Clerk · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Clerk Frontend Environment API

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

What the actions change

x-apievangelist-phrasing

Targets 3

$.info
$.paths['/v1/environment'].get
$.paths['/v1/environment'].patch

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 Clerk Frontend Environment API
  version: 1.0.0
extends: openapi/clerk-com-environment-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: 2
- target: $.paths['/v1/environment'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the instance environment settings
      effect: read
      questions:
      - Which sign-in features and settings are enabled for this instance's frontend?
      - How does the browser SDK learn the instance's configuration?
      instructions:
      - text: Get the current environment.
      - text: Show the enabled features for this instance.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/v1/environment'].patch
  update:
    x-apievangelist-phrasing:
      intent: Update the environment from the request origin
      effect: write
      questions:
      - How do I refresh the environment record using the calling origin?
      - Which header does the environment update rely on?
      instructions:
      - text: Update the environment for origin {Origin}.
        slots:
          Origin: header.Origin
      - text: Refresh environment settings using request origin {Origin}.
        slots:
          Origin: header.Origin
      method: generated
      generated: '2026-09-26'