ASAP Apps API

openapi: 3.2.0
info:
  title: ASAP Platform Apps API
  description: 'Public HTTP API for ASAP Platform (api.asap.cool).


    All `/v1` responses are wrapped in a standard envelope. Success responses are `{ "data": , "meta": { "request_id", "next_cursor"?, "has_more"? } }` — the schema documented for each operation describes the inner `data` value. Errors are `{ "error": { "code", "message", "field"?, "request_id" } }`. Every response also carries an `X-Request-Id` header matching `meta.request_id` / `error.request_id`.'
  license:
    name: BUSL-1.1
  version: 0.0.0
servers:
- url: https://api.asap.cool
  description: Production
tags:
- name: Apps
  description: Per-org module activation and availability.
paths:
  /v1/apps:
    get:
      tags:
      - Apps
      summary: GET /v1/apps
      operationId: list
      responses:
        '200':
          description: Apps and their availability for the active org.
          content:
            application/json:
              schema:
                type: array
                items:
                  $ref: '#/components/schemas/AppView'
        '401':
          description: Caller is not authenticated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
  /v1/apps/{slug}/activate:
    post:
      tags:
      - Apps
      summary: POST /v1/apps/{slug}/activate
      operationId: activate
      parameters:
      - name: slug
        in: path
        description: App slug to activate
        required: true
        schema:
          type: string
      responses:
        '204':
          description: App activated (optional) or installed (core) for the org.
        '401':
          description: Caller is not authenticated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '402':
          description: App requires a higher plan.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: Caller is not an org admin, or the app is always installed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '404':
          description: Unknown app.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
  /v1/apps/{slug}/deactivate:
    post:
      tags:
      - Apps
      summary: POST /v1/apps/{slug}/deactivate
      operationId: deactivate
      parameters:
      - name: slug
        in: path
        description: App slug to deactivate
        required: true
        schema:
          type: string
      responses:
        '204':
          description: App deactivated (optional) or removed from the workspace (core) for the org.
        '401':
          description: Caller is not authenticated.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '403':
          description: Caller is not an org admin, or the app is always installed.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
        '404':
          description: Unknown app.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorBody'
components:
  schemas:
    ErrorBody:
      type: object
      description: 'Generic error body returned by API handlers when they fail. `code` is a

        stable machine-readable token; `message` is human-friendly and meant for

        surfacing to end users.'
      required:
      - code
      - message
      properties:
        code:
          type: string
          description: Stable machine token (e.g. `invalid_credentials`).
        field:
          type:
          - string
          - 'null'
          description: Offending request field for validation errors, when known.
        message:
          type: string
          description: Human-readable message.
    AppView:
      type: object
      description: One app entry in `GET /v1/apps`.
      required:
      - slug
      - tier
      - min_plan
      - availability
      - installed
      - name
      - description
      - category
      - icon
      - order
      properties:
        availability:
          type: string
          description: 'Availability for the caller''s org: `available`, `not_activated`,

            or `plan_locked`.'
        category:
          type: string
          description: Functional category (`finance`, `documents`, …).
        description:
          type: string
          description: One-line description (FR).
        icon:
          type: string
          description: Stable icon identifier the SPA maps to a component.
        installed:
          type: boolean
          description: 'Whether the app shows in the org''s workspace (sidebar, dashboard).

            A core app stays usable when not installed.'
        min_plan:
          type: string
          description: Minimum plan for an optional app (`starter`/`solo`/`studio`).
        name:
          type: string
          description: Display name (FR).
        order:
          type: integer
          format: int32
          description: Sort order in the store and sidebar (lower first).
          minimum: 0
        slug:
          type: string
          description: App slug (`contacts`, `invoice`, …).
        tier:
          type: string
          description: '`core` (always on) or `optional` (opt-in).'
  securitySchemes:
    api_key:
      type: http
      scheme: bearer
    session:
      type: apiKey
      in: cookie
      name: asap_session