openapi: 3.2.0
info:
  title: Saperly Workspace Invitations API
  version: 0.1.0
  description: 'Operations tagged workspace-invitations across 2 of this provider''s published API definitions: api-saperly-com-openapi.json, saperly-openapi.yml. Each path carries the servers of the definition it was published in.'
servers:
- url: /
  description: This worker
- url: https://api.saperly.com
  description: Production
security: []
tags:
- name: workspace-invitations
  description: Invite teammates to a workspace by email address.
paths:
  /workspaces/{slug}/invitations:
    post:
      tags:
      - workspace-invitations
      operationId: workspace-invitations.send
      parameters:
      - name: slug
        in: path
        schema:
          type: string
          description: The workspace's URL slug.
        required: true
      security: []
      responses:
        '202':
          description: Success
          content:
            application/json:
              schema:
                type: object
                properties:
                  status:
                    type: string
                    enum:
                    - queued
                  delivery: {}
                required:
                - status
                - delivery
                additionalProperties: false
        '401':
          description: Unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Unauthorized'
        '403':
          description: AuthorizationDenied
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AuthorizationDenied'
        '404':
          description: WorkspaceNotFound
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkspaceNotFound'
        '429':
          description: RateLimited
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RateLimited'
        '500':
          description: InternalError
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/InternalError'
      summary: Invite a member by email
      requestBody:
        content:
          application/json:
            schema:
              type: object
              properties:
                to:
                  type: string
                  allOf:
                  - minLength: 3
                  - maxLength: 320
                  - pattern: ^[^\s@]+@[^\s@]+$
                    description: The email address to send the workspace invitation to.
              required:
              - to
              additionalProperties: false
              description: The invitee for a new workspace invitation.
        required: true
    servers:
    - url: /
      description: This worker
components:
  schemas:
    RateLimited:
      type: object
      properties:
        _tag:
          type: string
          enum:
          - RateLimited
        bucket:
          type: string
          description: The rate-limit bucket that was exhausted.
      required:
      - _tag
      - bucket
      additionalProperties: false
    Unauthorized:
      type: object
      properties:
        _tag:
          type: string
          enum:
          - Unauthorized
        message:
          type: string
          description: Why the request was rejected (missing, invalid, or insufficient credentials).
      required:
      - _tag
      - message
      additionalProperties: false
    WorkspaceNotFound:
      type: object
      properties:
        _tag:
          type: string
          enum:
          - WorkspaceNotFound
        slug:
          type: string
      required:
      - _tag
      - slug
      additionalProperties: false
    InternalError:
      type: object
      properties:
        _tag:
          type: string
          enum:
          - InternalError
        traceId:
          type: string
          description: A correlation id for this failure — quote it when reporting the problem so the request can be traced.
      required:
      - _tag
      - traceId
      additionalProperties: false
    AuthorizationDenied:
      type: object
      properties:
        _tag:
          type: string
          enum:
          - AuthorizationDenied
        reason:
          type: string
      required:
      - _tag
      - reason
      additionalProperties: false
x-refined-from:
- api-saperly-com-openapi.json
- saperly-openapi.yml