HERE · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Authorization API v1.1 Access Filters API

7 actions 7 updates phrasing extends openapi/here-access-filters-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['/filters'].get
$.paths['/filters'].post
$.paths['/filters/{filterHrn}'].get
$.paths['/filters/{filterHrn}'].post
$.paths['/filters/{filterHrn}'].delete
$.paths['/filters/{filterHrn}/members'].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 Authorization API v1.1 Access Filters API
  version: 1.0.0
extends: openapi/here-access-filters-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['/filters'].get
  update:
    x-apievangelist-phrasing:
      intent: List access filters
      effect: read
      questions:
      - What access filters are defined in my realm?
      - Can I list access filters for a single project or by external ID?
      instructions:
      - text: List the access filters in realm {realm}.
        slots:
          realm: query.realm
      - text: Find access filters of type {type} in project {project}.
        slots:
          type: query.type
          project: query.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filters'].post
  update:
    x-apievangelist-phrasing:
      intent: Create an access filter
      effect: write
      questions:
      - How do I create an access filter to restrict what a user or app can reach?
      - Is there a limit on how many access filters a realm can have?
      instructions:
      - text: Create a new access filter in my realm.
      - text: Set up an access filter I can attach to users and apps.
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filters/{filterHrn}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an access filter's details
      effect: read
      questions:
      - How do I view the definition of one access filter?
      - What does a particular access filter restrict?
      instructions:
      - text: Get access filter {filterHrn}.
        slots:
          filterHrn: path.filterHrn
      - text: Show the details of the access filter with HRN {filterHrn}.
        slots:
          filterHrn: path.filterHrn
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filters/{filterHrn}'].post
  update:
    x-apievangelist-phrasing:
      intent: Update an access filter
      effect: write
      questions:
      - Can I change an existing access filter's definition?
      - How do I edit an access filter that's already attached to users?
      instructions:
      - text: Update access filter {filterHrn}.
        slots:
          filterHrn: path.filterHrn
      - text: Modify the definition of existing access filter {filterHrn}.
        slots:
          filterHrn: path.filterHrn
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filters/{filterHrn}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete an access filter
      effect: destructive
      questions:
      - How do I delete an access filter I no longer need?
      - Can I remove an access filter from my realm entirely?
      instructions:
      - text: Delete access filter {filterHrn}.
        slots:
          filterHrn: path.filterHrn
      - text: Remove the access filter {filterHrn} from the realm.
        slots:
          filterHrn: path.filterHrn
      method: generated
      generated: '2026-09-26'
- target: $.paths['/filters/{filterHrn}/members'].get
  update:
    x-apievangelist-phrasing:
      intent: List members assigned an access filter
      effect: read
      questions:
      - Which users and apps have a given access filter assigned?
      - Can I list only the apps, not users, that carry an access filter?
      instructions:
      - text: List the members assigned access filter {filterHrn}.
        slots:
          filterHrn: path.filterHrn
      - text: Show members of type {entityType} that have access filter {filterHrn}.
        slots:
          entityType: query.entityType
          filterHrn: path.filterHrn
      method: generated
      generated: '2026-09-26'