Apache OpenWhisk Activations API

openapi: 3.0.3
info:
  title: Apache OpenWhisk REST Actions Activations API
  description: Apache OpenWhisk is an open-source serverless cloud platform. The REST API provides endpoints for managing actions, triggers, rules, packages, and activations for serverless function development.
  version: 1.0.0
  license:
    name: Apache 2.0
    url: https://www.apache.org/licenses/LICENSE-2.0
  contact:
    url: https://openwhisk.apache.org/
servers:
- url: https://{host}/api/v1
  description: Apache OpenWhisk API server
  variables:
    host:
      default: localhost:443
security:
- basicAuth: []
tags:
- name: Activations
paths:
  /namespaces/{namespace}/activations:
    get:
      operationId: listActivations
      summary: Apache OpenWhisk List Activations
      description: List activations in the namespace.
      tags:
      - Activations
      parameters:
      - $ref: '#/components/parameters/namespace'
      - name: limit
        in: query
        schema:
          type: integer
          default: 30
        description: Maximum number of activations to return
      - name: skip
        in: query
        schema:
          type: integer
        description: Number of activations to skip
      - name: since
        in: query
        schema:
          type: integer
        description: Return activations since this epoch milliseconds timestamp
      - name: upto
        in: query
        schema:
          type: integer
        description: Return activations up to this epoch milliseconds timestamp
      responses:
        '200':
          description: List of activations
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/ActivationSummary'
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
  /namespaces/{namespace}/activations/{activationId}:
    get:
      operationId: getActivation
      summary: Apache OpenWhisk Get Activation
      description: Get details of a specific activation.
      tags:
      - Activations
      parameters:
      - $ref: '#/components/parameters/namespace'
      - name: activationId
        in: path
        required: true
        schema:
          type: string
        description: Activation identifier
        example: 44794bd6aab74415b4e42a308d880727
      responses:
        '200':
          description: Activation details
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Activation'
        '404':
          description: Activation not found
      x-microcks-operation:
        delay: 0
        dispatcher: FALLBACK
components:
  schemas:
    Activation:
      type: object
      properties:
        activationId:
          type: string
          description: Unique activation identifier
          example: 44794bd6aab74415b4e42a308d880727
        namespace:
          type: string
          example: guest
        name:
          type: string
          description: Name of invoked action/trigger
          example: hello
        version:
          type: string
          example: 0.0.1
        subject:
          type: string
          description: Subject who invoked the action
          example: guest
        start:
          type: integer
          description: Start time epoch ms
          example: 1718153645993
        end:
          type: integer
          description: End time epoch ms
          example: 1718153646050
        duration:
          type: integer
          description: Duration in milliseconds
          example: 57
        response:
          $ref: '#/components/schemas/ActivationResponse'
        logs:
          type: array
          items:
            type: string
          description: Activation log output
        annotations:
          type: array
          items:
            $ref: '#/components/schemas/KeyValue'
    KeyValue:
      type: object
      properties:
        key:
          type: string
          description: Parameter key
          example: name
        value:
          description: Parameter value
          example: World
    ActivationSummary:
      type: object
      properties:
        activationId:
          type: string
          example: 44794bd6aab74415b4e42a308d880727
        name:
          type: string
          example: hello
        version:
          type: string
          example: 0.0.1
        start:
          type: integer
          example: 1718153645993
        end:
          type: integer
          example: 1718153646050
    ActivationResponse:
      type: object
      properties:
        status:
          type: string
          description: Activation status
          example: success
          enum:
          - success
          - application error
          - developer error
          - whisk internal error
        statusCode:
          type: integer
          description: HTTP status code equivalent
          example: 0
        success:
          type: boolean
          example: true
        result:
          type: object
          description: Action result payload
  parameters:
    namespace:
      name: namespace
      in: path
      required: true
      description: OpenWhisk namespace
      schema:
        type: string
        example: guest
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
      description: HTTP Basic authentication using OpenWhisk credentials
x-generated-from: documentation