HERE · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Authorization API v1.1 Cross Realm Trusts API

5 actions 5 updates phrasing extends openapi/here-cross-realm-trusts-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 5

$.info

$.paths['/crossRealmTrusts'].get

$.paths['/crossRealmTrusts/sources/{sourceProjectOrRealm}/targets/{targetProjectOrRealm}'].get

$.paths['/crossRealmTrusts/sources/{sourceProjectOrRealm}/targets/{targetProjectOrRealm}'].post

$.paths['/crossRealmTrusts/sources/{sourceProjectOrRealm}/targets/{targetProjectOrRealm}'].delete

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 Authorization API v1.1 Cross Realm Trusts API
  version: 1.0.0
extends: openapi/here-cross-realm-trusts-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-02'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 4
- target: $.paths['/crossRealmTrusts'].get
  update:
    x-apievangelist-phrasing:
      intent: List cross-realm trusts
      effect: read
      questions:
      - Which realms or projects is my realm trusting to share linkable resources?
      - Can I list cross-realm trusts by source or target realm?
      instructions:
      - text: List the cross-realm trusts for my realm.
      - text: List all cross-realm trusts, filtered to source realm {sourceRealm} and target realm {targetRealm}.
        slots:
          sourceRealm: query.sourceRealm
          targetRealm: query.targetRealm
      method: generated
      generated: '2026-10-02'
- target: $.paths['/crossRealmTrusts/sources/{sourceProjectOrRealm}/targets/{targetProjectOrRealm}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get one cross-realm trust
      effect: read
      questions:
      - Is there a trust set up between a specific source and target realm?
      - How do I view a single cross-realm trust?
      instructions:
      - text: Get the cross-realm trust from {sourceProjectOrRealm} to {targetProjectOrRealm}.
        slots:
          sourceProjectOrRealm: path.sourceProjectOrRealm
          targetProjectOrRealm: path.targetProjectOrRealm
      - text: Check whether {targetProjectOrRealm} trusts {sourceProjectOrRealm}.
        slots:
          targetProjectOrRealm: path.targetProjectOrRealm
          sourceProjectOrRealm: path.sourceProjectOrRealm
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crossRealmTrusts/sources/{sourceProjectOrRealm}/targets/{targetProjectOrRealm}'].post
  update:
    x-apievangelist-phrasing:
      intent: Create or update a cross-realm trust
      effect: write
      questions:
      - How do I allow another realm to share linkable resources into mine?
      - Can I require linkable resources to target a specific project in the trust?
      instructions:
      - text: Create a trust letting {sourceProjectOrRealm} share resources into {targetProjectOrRealm}.
        slots:
          sourceProjectOrRealm: path.sourceProjectOrRealm
          targetProjectOrRealm: path.targetProjectOrRealm
      - text: Set up trust from {sourceProjectOrRealm} to {targetProjectOrRealm} requiring a target project {requiresLinkableResourceWithTargetProject}.
        slots:
          sourceProjectOrRealm: path.sourceProjectOrRealm
          targetProjectOrRealm: path.targetProjectOrRealm
          requiresLinkableResourceWithTargetProject: requestBody.requiresLinkableResourceWithTargetProject
      method: generated
      generated: '2026-09-26'
- target: $.paths['/crossRealmTrusts/sources/{sourceProjectOrRealm}/targets/{targetProjectOrRealm}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Delete a cross-realm trust
      effect: destructive
      questions:
      - How do I stop another realm from offering resources into my realm?
      - Can I revoke a cross-realm trust I set up earlier?
      instructions:
      - text: Delete the cross-realm trust from {sourceProjectOrRealm} to {targetProjectOrRealm}.
        slots:
          sourceProjectOrRealm: path.sourceProjectOrRealm
          targetProjectOrRealm: path.targetProjectOrRealm
      - text: Revoke the trust that lets {sourceProjectOrRealm} share into {targetProjectOrRealm}.
        slots:
          sourceProjectOrRealm: path.sourceProjectOrRealm
          targetProjectOrRealm: path.targetProjectOrRealm
      method: generated
      generated: '2026-09-26'