HERE · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Authorization API v1.1 Project Resource Management API

6 actions 6 updates phrasing extends openapi/here-project-resource-management-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 6

$.info
$.paths['/projects/{project}/resources'].get
$.paths['/projects/{project}/resources'].post
$.paths['/projects/{project}/resources/{resource}'].get
$.paths['/projects/{project}/resources/{resource}'].post
$.paths['/projects/{project}/resources/{resource}'].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 Authorization API v1.1 Project Resource Management API
  version: 1.0.0
extends: openapi/here-project-resource-management-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['/projects/{project}/resources'].get
  update:
    x-apievangelist-phrasing:
      intent: List the resources in a project
      effect: read
      questions:
      - Which catalogs and pipelines belong to or are linked into my project?
      - Can I list only the resources linked to a project, not homed there?
      instructions:
      - text: List the resources in project {project}.
        slots:
          project: path.project
      - text: Show {type} resources in project {project} with relation {relation}.
        slots:
          type: query.type
          project: path.project
          relation: query.relation
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project}/resources'].post
  update:
    x-apievangelist-phrasing:
      intent: Add several resources to a project
      effect: write
      questions:
      - How do I add multiple resources to a project at once?
      - Can I link a batch of existing resources into a project as references?
      instructions:
      - text: Add resources {items} to project {project} as {relation}.
        slots:
          items: requestBody.items
          project: path.project
          relation: query.relation
      - text: Link the resources {items} into project {project} with relation {relation}.
        slots:
          items: requestBody.items
          project: path.project
          relation: query.relation
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project}/resources/{resource}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one resource in a project
      effect: read
      questions:
      - Is a particular resource homed in or linked to my project?
      - How is a given resource related to a project?
      instructions:
      - text: Get resource {resource} in project {project}.
        slots:
          resource: path.resource
          project: path.project
      - text: Show how resource {resource} is related to project {project}.
        slots:
          resource: path.resource
          project: path.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project}/resources/{resource}'].post
  update:
    x-apievangelist-phrasing:
      intent: Add one resource to a project as home or link
      effect: write
      questions:
      - How do I link a single catalog into my project?
      - Can I set a project as a resource's home?
      instructions:
      - text: Add resource {resource} to project {project} as {relation}.
        slots:
          resource: path.resource
          project: path.project
          relation: query.relation
      - text: Link resource {resource} into project {project} as {relation} with actions {allowed_actions}.
        slots:
          resource: path.resource
          project: path.project
          relation: query.relation
          allowed_actions: requestBody.allowedActions
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project}/resources/{resource}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Remove a resource from a project
      effect: destructive
      questions:
      - Can I unlink a resource from my project?
      - Why can't I remove a resource that lives in a project as its home?
      instructions:
      - text: Remove resource {resource} from project {project} where it is a {relation}.
        slots:
          resource: path.resource
          project: path.project
          relation: query.relation
      - text: Unlink the {relation} resource {resource} from project {project}.
        slots:
          relation: query.relation
          resource: path.resource
          project: path.project
      method: generated
      generated: '2026-09-26'