API Evangelist conversational phrasing for Flagsmith SDK API

# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for Flagsmith SDK API
  version: 1.0.0
extends: openapi/flagsmith-sdk-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: 5
- target: $.paths['/api/v1/environment-document/'].get
  update:
    x-apievangelist-phrasing:
      intent: Download the environment document for local evaluation
      effect: read
      questions:
      - How do I get the full environment document my SDK needs for local evaluation mode?
      - What does the Edge Proxy download to evaluate flags without calling the API each time?
      instructions:
      - text: Fetch the environment document for my server-side environment key.
      - text: Download the environment document so the SDK can evaluate flags locally.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/flags/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get the feature flags for an environment
      effect: read
      questions:
      - Which feature flags are on in this environment right now?
      - Can I fetch the state of just one feature instead of every flag in the environment?
      - What happens if I ask for a single feature that doesn't exist in the environment?
      instructions:
      - text: List every feature flag and its value for this environment.
      - text: Get the environment-level state of feature {feature}.
        slots:
          feature: query.feature
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/flags/{identifier}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get flags for an identifier (deprecated path)
      effect: read
      questions:
      - Can I still fetch flags with the identifier in the URL path of the flags endpoint?
      - Is the older flags-by-identifier path deprecated in favour of the identities endpoint?
      instructions:
      - text: Get flags for identifier {identifier} using the deprecated identifier-in-path flags route.
        slots:
          identifier: path.identifier
      - text: Check feature {feature} for user {identifier} through the legacy flags path.
        slots:
          feature: query.feature
          identifier: path.identifier
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/identities/'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an identity's flags and traits
      effect: read
      questions:
      - How do I read the flags and traits a specific user sees without changing anything?
      - Can I evaluate a user's flags transiently so the identity isn't stored?
      instructions:
      - text: Get the flags and traits for identity {identifier}.
        slots:
          identifier: query.identifier
      - text: Look up flags for {identifier} as a transient identity ({transient}).
        slots:
          identifier: query.identifier
          transient: query.transient
      method: generated
      generated: '2026-09-26'
- target: $.paths['/api/v1/identities/'].post
  update:
    x-apievangelist-phrasing:
      intent: Identify a user, set traits and get their flags
      effect: write
      questions:
      - Can I set a user's traits and get their flags back in the same call?
      - What's the way to identify a user and store traits like plan or country in one request?
      instructions:
      - text: Identify user {identifier} with traits {traits} and return their flags.
        slots:
          identifier: requestBody.identifier
          traits: requestBody.traits
      - text: Identify {identifier} and save their traits, then give me the resulting flags.
        slots:
          identifier: requestBody.identifier
      method: generated
      generated: '2026-09-26'