HERE · OpenAPI Overlay 1.0.0

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

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

$.info
$.paths['/projects'].get
$.paths['/projects'].post
$.paths['/projects/me'].get
$.paths['/projects/{project}'].get
$.paths['/projects/{project}'].delete
$.paths['/projects/{project}'].patch
$.paths['/projects/{project}'].head

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 Management API
  version: 1.0.0
extends: openapi/here-project-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: 7
- target: $.paths['/projects'].get
  update:
    x-apievangelist-phrasing:
      intent: List all projects in the organization
      effect: read
      questions:
      - What projects exist across my entire HERE organization?
      - Can I search every project in the org by name?
      instructions:
      - text: List all projects in my organization.
      - text: Search organization projects matching {q}.
        slots:
          q: query.q
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a project
      effect: write
      questions:
      - How do I set up a new project in my realm?
      - What ID and name rules apply when creating a project?
      instructions:
      - text: Create a project with id {id} named {name}.
        slots:
          id: requestBody.id
          name: requestBody.name
      - text: Create project {id} called {name} with description {description}.
        slots:
          id: requestBody.id
          name: requestBody.name
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/me'].get
  update:
    x-apievangelist-phrasing:
      intent: List projects I belong to or manage
      effect: read
      questions:
      - Which projects am I a member of?
      - Can I list only the projects I am an admin for?
      instructions:
      - text: List the projects I'm a member of.
      - text: Show my projects where canManage is {canManage}.
        slots:
          canManage: query.canManage
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a project
      effect: read
      questions:
      - What are the details of a specific project?
      - Can I view one project's name and description by its HRN?
      instructions:
      - text: Get project {project}.
        slots:
          project: path.project
      - text: Show the details of project {project}.
        slots:
          project: path.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a project
      effect: destructive
      questions:
      - How do I delete a project that is no longer used?
      - Who is allowed to remove a project?
      instructions:
      - text: Delete project {project}.
        slots:
          project: path.project
      - text: Remove project {project} from the organization.
        slots:
          project: path.project
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project}'].patch
  update:
    x-apievangelist-phrasing:
      intent: Rename or redescribe a project
      effect: write
      questions:
      - Can I rename an existing project?
      - How do I update a project's description?
      instructions:
      - text: Rename project {project} to {name}.
        slots:
          project: path.project
          name: requestBody.name
      - text: Set the description of project {project} to {description}.
        slots:
          project: path.project
          description: requestBody.description
      method: generated
      generated: '2026-09-26'
- target: $.paths['/projects/{project}'].head
  update:
    x-apievangelist-phrasing:
      intent: Check whether a project exists
      effect: read
      questions:
      - Is there already a project with this HRN in my realm?
      - Can I test that a project exists without fetching its details?
      instructions:
      - text: Check whether project {project} exists in my realm.
        slots:
          project: path.project
      - text: Confirm project {project} exists.
        slots:
          project: path.project
      method: generated
      generated: '2026-09-26'