Laravel · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Forge Organizations API

8 actions 8 updates phrasing extends openapi/laravel-organizations-api-openapi.yml
Generated by API Evangelist Written by API Evangelist tooling for Laravel's API. It is a proposal applied on top of the contract, not a document Laravel publishes.
View Overlay File View on GitHub Overlay Specification

What the actions change

x-apievangelist-phrasing

Targets 8

$.info
$.paths['/orgs'].get
$.paths['/orgs/{organization}'].get
$.paths['/orgs/{organization}/server-credentials'].get
$.paths['/orgs/{organization}/server-credentials/{credential}'].get
$.paths['/orgs/{organization}/server-credentials/{credential}/regions/{region}/vpcs'].get
$.paths['/orgs/{organization}/server-credentials/{credential}/regions/{region}/vpcs'].post
$.paths['/orgs/{organization}/server-credentials/{credential}/regions/{region}/vpcs/{vpcId}'].get

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 Forge Organizations API
  version: 1.0.0
extends: openapi/laravel-organizations-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: 7
- target: $.paths['/orgs'].get
  update:
    x-apievangelist-phrasing:
      intent: List my organizations
      effect: read
      questions:
      - Which Forge organizations does my account belong to?
      - Can I page through all the organizations I have access to?
      instructions:
      - text: List all organizations I have access to.
      - text: Show the next {size} organizations from cursor {cursor}.
        slots:
          size: query.page[size]
          cursor: query.page[cursor]
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get an organization
      effect: read
      questions:
      - What are the details of one organization I belong to?
      - Can I look up an organization by its slug?
      instructions:
      - text: Show organization {organization}.
        slots:
          organization: path.organization
      - text: Get the details for the {organization} organization.
        slots:
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/server-credentials'].get
  update:
    x-apievangelist-phrasing:
      intent: List an organization's server provider credentials
      effect: read
      questions:
      - Which cloud provider credentials are linked to my organization?
      - Can I see every server credential an organization uses to provision servers?
      instructions:
      - text: List the server credentials in organization {organization}.
        slots:
          organization: path.organization
      - text: Show the cloud provider accounts linked to {organization}.
        slots:
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/server-credentials/{credential}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a server provider credential
      effect: read
      questions:
      - Which provider is a particular server credential for?
      - Can I fetch one server credential from my organization by ID?
      instructions:
      - text: Show server credential {credential} in organization {organization}.
        slots:
          credential: path.credential
          organization: path.organization
      - text: Get details of provider credential {credential} for {organization}.
        slots:
          credential: path.credential
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/server-credentials/{credential}/regions/{region}/vpcs'].get
  update:
    x-apievangelist-phrasing:
      intent: List VPCs for a provider credential in a region
      effect: read
      questions:
      - What private networks exist in a region for my cloud provider credential?
      - Can I see the VPCs available before I provision a server?
      instructions:
      - text: List the VPCs in region {region} for credential {credential} in {organization}.
        slots:
          region: path.region
          credential: path.credential
          organization: path.organization
      - text: Show private networks in {region} available through provider credential {credential} of {organization}.
        slots:
          region: path.region
          credential: path.credential
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/server-credentials/{credential}/regions/{region}/vpcs'].post
  update:
    x-apievangelist-phrasing:
      intent: Create a VPC with a provider credential
      effect: write
      questions:
      - How do I create a new private network in a region for my servers?
      - Can I make a VPC through my linked cloud provider account?
      instructions:
      - text: Create a VPC named {name} in region {region} using credential {credential} in {organization}.
        slots:
          name: requestBody.name
          region: path.region
          credential: path.credential
          organization: path.organization
      - text: Set up private network {name} in {region} through provider credential {credential} of {organization}.
        slots:
          name: requestBody.name
          region: path.region
          credential: path.credential
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/server-credentials/{credential}/regions/{region}/vpcs/{vpcId}'].get
  update:
    x-apievangelist-phrasing:
      intent: Get a VPC for a provider credential
      effect: read
      questions:
      - What are the details of one VPC in my provider account?
      - Can I look up a specific private network by its VPC ID?
      instructions:
      - text: Show VPC {vpcId} in region {region} for credential {credential} in {organization}.
        slots:
          vpcId: path.vpcId
          region: path.region
          credential: path.credential
          organization: path.organization
      - text: Get private network {vpcId} ({region}) via credential {credential} of {organization}.
        slots:
          vpcId: path.vpcId
          region: path.region
          credential: path.credential
          organization: path.organization
      method: generated
      generated: '2026-10-01'