# 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 Resource Policies API
  version: 1.0.0
extends: openapi/here-resource-policies-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: 11
- target: $.paths['/resourcePolicies'].get
  update:
    x-apievangelist-phrasing:
      intent: List resource policies
      effect: read
      questions:
      - Which resource policies exist in my HERE realm?
      - Can I find the resource policies that include a particular resource?
      instructions:
      - text: List all resource policies I can see.
      - text: List resource policies that contain resource {resource}.
        slots:
          resource: query.resource
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resourcePolicies'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a resource policy
      effect: write
      questions:
      - How do I package resources so they can be made linkable to other realms?
      - What do I need to provide to create a new resource policy?
      instructions:
      - text: Create a resource policy with id {id} named {name}.
        slots:
          id: requestBody.id
          name: requestBody.name
      - text: Create resource policy {id} called {name} described as {description}.
        slots:
          id: requestBody.id
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resourcePolicies/{resourcePolicy}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a resource policy
      effect: read
      questions:
      - What are the details of one specific resource policy?
      - Can I look up a resource policy by its identifier?
      instructions:
      - text: Get resource policy {resourcePolicy}.
        slots:
          resourcePolicy: path.resourcePolicy
      - text: Show the name and description of resource policy {resourcePolicy}.
        slots:
          resourcePolicy: path.resourcePolicy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resourcePolicies/{resourcePolicy}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a resource policy
      effect: destructive
      questions:
      - How do I remove a resource policy I no longer need?
      - Can a whole resource policy be deleted at once?
      instructions:
      - text: Delete resource policy {resourcePolicy}.
        slots:
          resourcePolicy: path.resourcePolicy
      - text: Remove the entire resource policy {resourcePolicy}.
        slots:
          resourcePolicy: path.resourcePolicy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resourcePolicies/{resourcePolicy}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or redescribe a resource policy
      effect: write
      questions:
      - Can I rename an existing resource policy?
      - How do I change the description of a resource policy?
      instructions:
      - text: Rename resource policy {resourcePolicy} to {name}.
        slots:
          resourcePolicy: path.resourcePolicy
          name: requestBody.name
      - text: Update the description of resource policy {resourcePolicy} to {description}.
        slots:
          resourcePolicy: path.resourcePolicy
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resourcePolicies/{resourcePolicy}/resources'].get
  update:
    x-apievangelist-phrasing:
      intent: List resources in a resource policy
      effect: read
      questions:
      - Which resources are included in a resource policy?
      - Can I list only resources of one type inside a resource policy?
      instructions:
      - text: List the resources in resource policy {resourcePolicy}.
        slots:
          resourcePolicy: path.resourcePolicy
      - text: Show {type} resources in resource policy {resourcePolicy}.
        slots:
          type: query.type
          resourcePolicy: path.resourcePolicy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resourcePolicies/{resourcePolicy}/resources'].post
  update:
    x-apievangelist-phrasing:
      intent: Batch-add resources to a resource policy
      effect: write
      questions:
      - How do I add many resources to a resource policy in one request?
      - What is the cap on resources in a single resource policy?
      instructions:
      - text: Add resources {items} to resource policy {resourcePolicy} in one batch.
        slots:
          items: requestBody.items
          resourcePolicy: path.resourcePolicy
      - text: 'Batch-load this list of resources with their allowed actions into resource policy {resourcePolicy}: {items}.'
        slots:
          resourcePolicy: path.resourcePolicy
          items: requestBody.items
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resourcePolicies/{resourcePolicy}/resources/status/{statusId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Check the status of a batch resource addition
      effect: read
      questions:
      - Did my batch of resources finish being added to the resource policy?
      - How can I track progress of a bulk resource addition?
      instructions:
      - text: Check batch status {statusId} for resource policy {resourcePolicy}.
        slots:
          statusId: path.statusId
          resourcePolicy: path.resourcePolicy
      - text: Get the progress of the resource batch {statusId} added to {resourcePolicy}.
        slots:
          statusId: path.statusId
          resourcePolicy: path.resourcePolicy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resourcePolicies/{resourcePolicy}/resources/{resource}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one resource in a resource policy
      effect: read
      questions:
      - Which actions are allowed on a specific resource in a resource policy?
      - Is a particular catalog part of this resource policy?
      instructions:
      - text: Get resource {resource} in resource policy {resourcePolicy}.
        slots:
          resource: path.resource
          resourcePolicy: path.resourcePolicy
      - text: Show allowed actions for {resource} within resource policy {resourcePolicy}.
        slots:
          resource: path.resource
          resourcePolicy: path.resourcePolicy
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resourcePolicies/{resourcePolicy}/resources/{resource}'].put
  update:
    x-apievangelist-phrasing:
      intent: Add a single resource to a resource policy
      effect: write
      questions:
      - How do I add one resource with specific allowed actions to a resource policy?
      - Must the allowed actions match the resource's service when adding it?
      instructions:
      - text: Add resource {resource} to resource policy {resourcePolicy}.
        slots:
          resource: path.resource
          resourcePolicy: path.resourcePolicy
      - text: Put {resource} into resource policy {resourcePolicy} allowing actions {allowedActions}.
        slots:
          resource: path.resource
          resourcePolicy: path.resourcePolicy
          allowedActions: requestBody.allowedActions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/resourcePolicies/{resourcePolicy}/resources/{resource}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove resources from a resource policy
      effect: destructive
      questions:
      - How do I take a resource out of a resource policy?
      - Can I remove several resources from a resource policy with one comma-separated call?
      instructions:
      - text: Remove resource {resource} from resource policy {resourcePolicy}.
        slots:
          resource: path.resource
          resourcePolicy: path.resourcePolicy
      - text: Delete resources {resource} (comma-separated) from resource policy {resourcePolicy}.
        slots:
          resource: path.resource
          resourcePolicy: path.resourcePolicy
      method: generated
      generated: '2026-09-26'