HERE · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for v1 Rate Limit Rules API

7 actions 7 updates phrasing extends openapi/here-rate-limit-rules-api-openapi.yml

Generated by API Evangelist Written by API Evangelist tooling for HERE's API. It is a proposal applied on top of the contract, not a document HERE publishes.

View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 7

$.info

$.paths['/identities/me/rules'].get

$.paths['/identities/default/rules'].get

$.paths['/identities/{identityHrn}/rules'].get

$.paths['/identities/me/rules/{ruleHrn}'].get

$.paths['/identities/default/rules/{ruleHrn}'].get

$.paths['/identities/{identityHrn}/rules/{ruleHrn}'].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 v1 Rate Limit Rules API
  version: 1.0.0
extends: openapi/here-rate-limit-rules-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: 6
- target: $.paths['/identities/me/rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List the rate limits enforced on me
      effect: read
      questions:
      - What rate limits currently apply to my own identity?
      - Can I see my rate limit rules for one specific endpoint?
      instructions:
      - text: List the rate limit rules enforced on me.
      - text: Show my own rate limit rules for endpoint {endpoint_id}.
        slots:
          endpoint_id: query.endpointId
      - text: List my rate limits that apply within project {project_hrn}.
        slots:
          project_hrn: query.projectHrn
      method: generated
      generated: '2026-09-26'
- target: $.paths['/identities/default/rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List my realm's default rate limits
      effect: read
      questions:
      - What are the default rate limits for identities in my realm?
      - Which limits apply to users in my realm without a custom tier?
      instructions:
      - text: List the default rate limit rules for my realm.
      - text: Show realm default rate limits for URL {url}.
        slots:
          url: query.url
      method: generated
      generated: '2026-09-26'
- target: $.paths['/identities/{identityHrn}/rules'].get
  update:
    x-apievangelist-phrasing:
      intent: List rate limits for a specific identity
      effect: read
      questions:
      - What rate limits are enforced on a particular app or user?
      - Can an admin check another identity's rate limit rules?
      instructions:
      - text: List the rate limit rules for identity {identity_hrn}.
        slots:
          identity_hrn: path.identityHrn
      - text: Show rate limits on identity {identity_hrn} for endpoint {endpoint_id}.
        slots:
          identity_hrn: path.identityHrn
          endpoint_id: query.endpointId
      method: generated
      generated: '2026-09-26'
- target: $.paths['/identities/me/rules/{ruleHrn}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one rate limit rule applied to me
      effect: read
      questions:
      - What exactly does one of my own rate limit rules allow?
      - Can I look up a single rule that throttles my identity?
      instructions:
      - text: Get my rate limit rule {rule_hrn}.
        slots:
          rule_hrn: path.ruleHrn
      - text: Show the details of rule {rule_hrn} as enforced on me.
        slots:
          rule_hrn: path.ruleHrn
      method: generated
      generated: '2026-09-26'
- target: $.paths['/identities/default/rules/{ruleHrn}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one default rate limit rule for my realm
      effect: read
      questions:
      - What does a specific realm default rate limit rule allow?
      - Can I inspect one default rule that applies across my realm?
      instructions:
      - text: Get realm default rate limit rule {rule_hrn}.
        slots:
          rule_hrn: path.ruleHrn
      - text: Show default rule {rule_hrn} for generic identities in my realm.
        slots:
          rule_hrn: path.ruleHrn
      method: generated
      generated: '2026-09-26'
- target: $.paths['/identities/{identityHrn}/rules/{ruleHrn}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one rate limit rule for an identity
      effect: read
      questions:
      - Is a specific rate limit rule enforced on a given app?
      - How do I read one rule applied to another identity?
      instructions:
      - text: Get rate limit rule {rule_hrn} for identity {identity_hrn}.
        slots:
          rule_hrn: path.ruleHrn
          identity_hrn: path.identityHrn
      - text: Show how rule {rule_hrn} applies to identity {identity_hrn}.
        slots:
          rule_hrn: path.ruleHrn
          identity_hrn: path.identityHrn
      method: generated
      generated: '2026-09-26'