4chems Operations API

openapi: 3.2.0
info:
  title: platform-api Operations API
  description: 'Platform API: infrastructure, operational, and customer tiers.'
  version: 0.12.1
tags:
- name: Operations
paths:
  /ops/notifications/email:
    post:
      tags:
      - Operations
      summary: Send Email
      description: 'Queue a plain-text email for delivery and return the operation envelope. Call

        this from a service that needs to notify a user with a one-off, pre-composed

        message; supply an Idempotency-Key to avoid sending duplicates on retry.'
      operationId: send_email
      security:
      - HTTPBearer: []
      parameters:
      - name: Idempotency-Key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Idempotency-Key
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EmailNotification'
      responses:
        '202':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /ops/notifications/email/templated:
    post:
      tags:
      - Operations
      summary: Send Templated Email
      description: 'Render a named template with the given context and queue the resulting email

        for delivery, returning the operation envelope. Call this from a service that

        needs to send a standard notification (e.g. invite, welcome) rather than a

        one-off message.'
      operationId: send_templated_email
      security:
      - HTTPBearer: []
      parameters:
      - name: Idempotency-Key
        in: header
        required: false
        schema:
          anyOf:
          - type: string
          - type: 'null'
          title: Idempotency-Key
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/TemplatedEmailNotification'
      responses:
        '202':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /ops/operations/{operation_id}:
    get:
      tags:
      - Operations
      summary: Get Operation
      description: 'Return one operation''s status, result, and error detail for the calling

        service. Call this to poll a 202-accepted operation to completion.'
      operationId: get_operation
      security:
      - HTTPBearer: []
      parameters:
      - name: operation_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Operation Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
  /v1/operations/{operation_id}:
    get:
      tags:
      - Operations
      summary: Get My Operation
      description: 'Return the status, result and error of an operation the caller started, such as

        the `Location` of a `202` from `complete_billing`. Call this to poll it to completion.'
      operationId: get_my_operation
      security:
      - HTTPBearer: []
      parameters:
      - name: operation_id
        in: path
        required: true
        schema:
          type: string
          format: uuid
          title: Operation Id
      responses:
        '200':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/OperationOut'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
components:
  schemas:
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
            - type: string
            - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
      - loc
      - msg
      - type
      title: ValidationError
    ErrorDetail:
      properties:
        code:
          type: string
          title: Code
        message:
          type: string
          title: Message
      type: object
      required:
      - code
      - message
      title: ErrorDetail
    TemplatedEmailNotification:
      properties:
        to:
          type: string
          format: email
          title: To
        template_name:
          type: string
          title: Template Name
        context:
          additionalProperties: true
          type: object
          title: Context
      type: object
      required:
      - to
      - template_name
      - context
      title: TemplatedEmailNotification
    EmailNotification:
      properties:
        to:
          type: string
          format: email
          title: To
        subject:
          type: string
          title: Subject
        body:
          type: string
          title: Body
      type: object
      required:
      - to
      - subject
      - body
      title: EmailNotification
    OperationOut:
      properties:
        operation_id:
          type: string
          format: uuid
          title: Operation Id
        status:
          type: string
          title: Status
        type:
          type: string
          title: Type
        target_type:
          anyOf:
          - type: string
          - type: 'null'
          title: Target Type
        target_id:
          anyOf:
          - type: string
          - type: 'null'
          title: Target Id
        result:
          anyOf:
          - {}
          - type: 'null'
          title: Result
        error:
          anyOf:
          - $ref: '#/components/schemas/ErrorDetail'
          - type: 'null'
        created_at:
          type: string
          format: date-time
          title: Created At
        finished_at:
          anyOf:
          - type: string
            format: date-time
          - type: 'null'
          title: Finished At
      type: object
      required:
      - operation_id
      - status
      - type
      - created_at
      title: OperationOut
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
  securitySchemes:
    HTTPBearer:
      type: http
      scheme: bearer