Auth0 · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Auth0 Management Rules Configs API

4 actions 4 updates phrasing extends openapi/auth0-rules-configs-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Auth0's API. It is a proposal applied on top of the contract, not a document Auth0 publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 4

$.info
$.paths['/rules-configs'].get
$.paths['/rules-configs/{key}'].put
$.paths['/rules-configs/{key}'].delete

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 Auth0 Management Rules Configs API
  version: 1.0.0
extends: openapi/auth0-rules-configs-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 3
- target: $.paths['/rules-configs'].get
  update:
    x-apievangelist-phrasing:
      intent: List rule config variable keys
      effect: read
      questions:
      - Which config variable keys are available to my rules?
      - Can I read the values of rule config variables?
      instructions:
      - text: List rule config keys.
      - text: Show the config variable names used by rules.
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rules-configs/{key}'].put
  update:
    x-apievangelist-phrasing:
      intent: Set a rule config variable
      effect: write
      questions:
      - How do I store a secret value for my rules to use?
      - Can I overwrite an existing rule config variable?
      instructions:
      - text: Set rule config {key} to {value}.
        slots:
          key: path.key
          value: requestBody.value
      - text: Store secret {value} under rules config key {key}.
        slots:
          value: requestBody.value
          key: path.key
      method: generated
      generated: '2026-10-01'
- target: $.paths['/rules-configs/{key}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a rule config variable
      effect: destructive
      questions:
      - How do I delete a rule config variable?
      - Can I remove a secret my rules no longer use?
      instructions:
      - text: Delete rule config {key}.
        slots:
          key: path.key
      - text: Remove the rules config variable {key}.
        slots:
          key: path.key
      method: generated
      generated: '2026-10-01'