# Generated by API Evangelist (build-phrasing.py). Our phrasing, not observed demand.
overlay: 1.0.0
info:
  title: API Evangelist conversational phrasing for One Access API
  version: 1.0.0
extends: openapi/integration-os-access-api-openapi.yml
actions:
- target: $.info
  update:
    x-apievangelist-phrasing:
      method: generated
      generated: '2026-10-01'
      generator: build-phrasing.py
      label: Generated by API Evangelist
      operations: 10
- target: $.paths['/v1/access/organizations/{org_id}/projects/{project_id}/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: View a project key's connection restrictions
      effect: read
      questions:
      - What connection restrictions are set on a project-level access key?
      - Can I see which methods and rules limit a key that belongs to a project?
      instructions:
      - text: Show the connection restrictions on project {project_id} access key {id} in org {org_id}.
        slots:
          project_id: path.project_id
          id: path.id
          org_id: path.org_id
      - text: Read the access rules for key {id} under project {project_id}, organization {org_id}.
        slots:
          id: path.id
          project_id: path.project_id
          org_id: path.org_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/access/organizations/{org_id}/projects/{project_id}/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Set connection restrictions on a project key
      effect: write
      questions:
      - How do I limit a project access key to certain connections or HTTP methods?
      - What permission do I need to change the restrictions on a project-level key?
      instructions:
      - text: Restrict project {project_id} key {id} in org {org_id} to the methods {methods}.
        slots:
          project_id: path.project_id
          id: path.id
          org_id: path.org_id
          methods: requestBody.methods
      - text: Apply access rules {rules} to project key {id} in project {project_id}, org {org_id}.
        slots:
          rules: requestBody.rules
          id: path.id
          project_id: path.project_id
          org_id: path.org_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/access/organizations/{org_id}/projects/{project_id}/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Clear all restrictions from a project key
      effect: destructive
      questions:
      - How do I remove every connection restriction from a project-level access key?
      - Can I lift the limits on a project key so it reaches all connections again?
      instructions:
      - text: Remove all connection restrictions from project {project_id} key {id} in org {org_id}.
        slots:
          project_id: path.project_id
          id: path.id
          org_id: path.org_id
      - text: Lift every access limit on key {id} in project {project_id} of organization {org_id}.
        slots:
          id: path.id
          project_id: path.project_id
          org_id: path.org_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/access/organizations/{org_id}/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: View an org key's connection restrictions
      effect: read
      questions:
      - Which connection restrictions apply to an organization-level access key?
      - Can I check what an org-wide key is still allowed to call?
      instructions:
      - text: Show the connection restrictions on organization {org_id} access key {id}.
        slots:
          org_id: path.org_id
          id: path.id
      - text: Read the org-level access rules for key {id} in {org_id}.
        slots:
          id: path.id
          org_id: path.org_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/access/organizations/{org_id}/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Set connection restrictions on an org key
      effect: write
      questions:
      - How do I restrict an organization-level key to specific connections?
      - Do I need the access:update permission in the organization to change an org key's rules?
      instructions:
      - text: Restrict organization {org_id} key {id} to the methods {methods}.
        slots:
          org_id: path.org_id
          id: path.id
          methods: requestBody.methods
      - text: Apply rules {rules} to the org-level key {id} in organization {org_id}.
        slots:
          rules: requestBody.rules
          id: path.id
          org_id: path.org_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/access/organizations/{org_id}/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Clear all restrictions from an org key
      effect: destructive
      questions:
      - How do I strip every connection restriction from an organization-level key?
      - Can I reset an org key back to unrestricted connection access?
      instructions:
      - text: Remove all connection restrictions from organization {org_id} key {id}.
        slots:
          org_id: path.org_id
          id: path.id
      - text: Lift every limit on the org-level key {id} in {org_id}.
        slots:
          id: path.id
          org_id: path.org_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/access/{id}'].get
  update:
    x-apievangelist-phrasing:
      intent: View my personal key's connection restrictions
      effect: read
      questions:
      - What restrictions are currently applied to my own user-level access key?
      - Will I get null back if my personal key has no restrictions yet?
      instructions:
      - text: Show the connection restrictions on my user key {id}.
        slots:
          id: path.id
      - text: Check which methods and rules limit personal access key {id}.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/access/{id}'].put
  update:
    x-apievangelist-phrasing:
      intent: Replace restrictions on my personal key
      effect: write
      questions:
      - How do I replace the access rules on my own user-level key?
      - Must I send methods or rules, or can I leave both out when updating my personal key?
      instructions:
      - text: Replace the restrictions on my user key {id} with methods {methods}.
        slots:
          id: path.id
          methods: requestBody.methods
      - text: Overwrite personal key {id}'s access rules with {rules}.
        slots:
          id: path.id
          rules: requestBody.rules
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/access/{id}'].post
  update:
    x-apievangelist-phrasing:
      intent: Set key restrictions with automatic scoping
      effect: write
      questions:
      - Can I set restrictions on any access key without saying whether it's a user, org or project key?
      - Which permission check applies when the key's scope is detected automatically?
      instructions:
      - text: Set restrictions on access key {id}, whatever its scope, to methods {methods}.
        slots:
          id: path.id
          methods: requestBody.methods
      - text: Auto-scope and apply rules {rules} to key {id}.
        slots:
          rules: requestBody.rules
          id: path.id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/v1/access/{id}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Clear all restrictions from my personal key
      effect: destructive
      questions:
      - How do I give my own user key unrestricted access to every connection again?
      - What happens to my personal key's reach once its restrictions are revoked?
      instructions:
      - text: Remove all connection restrictions from my user key {id}.
        slots:
          id: path.id
      - text: Make personal access key {id} unrestricted again.
        slots:
          id: path.id
      method: generated
      generated: '2026-10-01'