Laravel · OpenAPI Overlay 1.0.0

API Evangelist conversational phrasing for Forge Server Credentials API

4 actions 4 updates phrasing extends openapi/laravel-server-credentials-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 4

$.info

$.paths['/orgs/{organization}/teams/{team}/server-credentials'].get

$.paths['/orgs/{organization}/teams/{team}/server-credentials'].post

$.paths['/orgs/{organization}/teams/{team}/server-credentials/{credential}'].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 Forge Server Credentials API
  version: 1.0.0
extends: openapi/laravel-server-credentials-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: 3
- target: $.paths['/orgs/{organization}/teams/{team}/server-credentials'].get
  update:
    x-apievangelist-phrasing:
      intent: List server credentials shared with a team
      effect: read
      questions:
      - Which server provider credentials can my team use?
      - Can I page through the credentials shared with a team?
      instructions:
      - text: List the server credentials shared with team {team} in {organization}.
        slots:
          team: path.team
          organization: path.organization
      - text: Show which credentials team {team} in organization {organization} has access to.
        slots:
          team: path.team
          organization: path.organization
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/teams/{team}/server-credentials'].post
  update:
    x-apievangelist-phrasing:
      intent: Share a server credential with a team
      effect: write
      questions:
      - How do I let a team provision servers with one of my provider credentials?
      - Can I share an existing server credential with another team?
      instructions:
      - text: Share credential {credential_id} with team {team} in {organization}.
        slots:
          credential_id: requestBody.credential_id
          team: path.team
          organization: path.organization
      - text: Give team {team} ({organization}) access to server credential {credential_id}.
        slots:
          team: path.team
          organization: path.organization
          credential_id: requestBody.credential_id
      method: generated
      generated: '2026-10-01'
- target: $.paths['/orgs/{organization}/teams/{team}/server-credentials/{credential}'].delete
  update:
    x-apievangelist-phrasing:
      intent: Unshare a server credential from a team
      effect: destructive
      questions:
      - Can I stop a team from using one of my server credentials?
      - What revokes a team's access to a shared credential?
      instructions:
      - text: Unshare credential {credential} from team {team} in {organization}.
        slots:
          credential: path.credential
          team: path.team
          organization: path.organization
      - text: Revoke team {team}'s access to server credential {credential}, org {organization}.
        slots:
          team: path.team
          credential: path.credential
          organization: path.organization
      method: generated
      generated: '2026-10-01'