FreeAppStore API

openapi: 3.1.0
info:
  title: FreeAppStore API
  version: '2026-11-09'
  description: 'GENERATED FROM DOCUMENTATION by API Evangelist on 2026-11-09: 9 operation(s) read from 5 public documentation page(s) (each operation
    names its page in x-source). This is not the provider''s published contract; FreeAppStore has published no machine-readable contract that
    the pipeline could find. Engine: local.'
  x-evidence-tiers:
    code-example: 0
    documentation: 9
    pages-with-code: 0
    pages-read: 5
  x-generated-from: documentation
  x-provenance: generated
  x-authored-by: API Evangelist
  x-generated: '2026-11-09'
  x-generator: generate-contract-from-docs.py
  x-engine: local
  x-sources:
  - https://freeappstore.online/skills.md
  - https://docs.freeappstore.online/composable-starter-contract
  - https://docs.freeappstore.online/publishing
  - https://docs.freeappstore.online/platform-limits
  - https://docs.freeappstore.online/architecture
servers:
- url: https://api.freeappstore.online
paths:
  /session/{id}/capabilities:
    post:
      operationId: post_session_id_capabilities
      tags:
      - Session
      summary: Builder and CLI adoption
      x-source: https://docs.freeappstore.online/composable-starter-contract
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostSessionIdCapabilitiesRequest'
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/apps/{appid}/push/schedules/{reminderid}:
    put:
      operationId: put_v1_apps_appid_push_schedules_reminderid
      tags:
      - Apps
      summary: Create or update a reminder schedule for push notifications.
      x-source: https://docs.freeappstore.online/platform-limits
      parameters:
      - name: appid
        in: path
        required: true
        schema:
          type: string
      - name: reminderid
        in: path
        required: true
        schema:
          type: string
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PutV1AppsAppidPushSchedulesReminderidRequest'
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PutV1AppsAppidPushSchedulesReminderidResponse'
      x-evidence:
        kind: documentation
  /v1/apps/{appid}/push/subscriptions:
    delete:
      operationId: delete_v1_apps_appid_push_subscriptions
      tags:
      - Apps
      summary: Delete a push subscription for a device.
      x-source: https://docs.freeappstore.online/platform-limits
      parameters:
      - name: appid
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DeleteV1AppsAppidPushSubscriptionsResponse'
      x-evidence:
        kind: documentation
  /v1/apps/{id}/quality:
    get:
      operationId: get_v1_apps_id_quality
      tags:
      - Apps
      summary: Quality API
      description: Returns a JSON report with the VCQA code health score for the specified app.
      x-source: https://freeappstore.online/skills.md
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1AppsIdQualityResponse'
      x-evidence:
        kind: documentation
  /v1/apps/{id}/quality/badge:
    get:
      operationId: get_v1_apps_id_quality_badge
      tags:
      - Apps
      summary: Quality API
      description: Returns an SVG badge for the app's code quality score.
      x-source: https://freeappstore.online/skills.md
      parameters:
      - name: id
        in: path
        required: true
        schema:
          type: string
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1AppsIdQualityBadgeResponse'
      x-evidence:
        kind: documentation
  /v1/audit/apps:
    get:
      operationId: get_v1_audit_apps
      tags:
      - Audit
      summary: GET /v1/audit/apps ( routes/fleet-audit.ts ) gives the daily fleet consistency audit read access to the apps and routes tables
      description: Provides read‑only audit data for the fleet; requires a GitHub Actions OIDC bearer token with specific claims and is limited
        to 30 reads per hour.
      x-source: https://docs.freeappstore.online/architecture
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1AuditAppsResponse'
      x-evidence:
        kind: documentation
  /v1/auth/logout:
    post:
      operationId: post_v1_auth_logout
      tags:
      - Auth
      summary: Revocable per account from the console via POST /v1/auth/logout ( users.sessions_valid_after )
      description: Endpoint used to revoke sessions for a user; it updates the `users.sessions_valid_after` field.
      x-source: https://docs.freeappstore.online/architecture
      responses:
        '201':
          description: Success (status as documented)
      x-evidence:
        kind: documentation
  /v1/push/vapid-public-key:
    get:
      operationId: get_v1_push_vapid_public_key
      tags:
      - Push
      summary: Retrieve the platform VAPID public key.
      x-source: https://docs.freeappstore.online/platform-limits
      responses:
        '200':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/GetV1PushVapidPublicKeyResponse'
      x-evidence:
        kind: documentation
  /v1/unpublish:
    post:
      operationId: post_v1_unpublish
      tags:
      - Unpublish
      summary: Unpublishing
      x-source: https://docs.freeappstore.online/publishing
      requestBody:
        required: false
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PostV1UnpublishRequest'
      responses:
        '201':
          description: Success (status as documented)
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PostV1UnpublishResponse'
      x-evidence:
        kind: documentation
components:
  schemas:
    PostSessionIdCapabilitiesRequest:
      type: object
      properties:
        dryRun:
          type: boolean
          description: When true, preview the capability installation without applying changes
    PutV1AppsAppidPushSchedulesReminderidRequest:
      type: object
      properties:
        body:
          type: string
          description: 'Reminder definition. Limits: up to 20 reminders per user per app, 4 KB request body (413 on breach), must reference a
            registered device (409 if missing).'
      required:
      - body
    PutV1AppsAppidPushSchedulesReminderidResponse:
      type: object
      properties:
        '200':
          type: string
          description: Reminder schedule created or updated.
        '400':
          type: string
          description: Invalid lead time, repeat interval, or other validation error.
        '403':
          type: string
          description: Missing required registered device.
        '409':
          type: string
          description: Device not registered for the user/app.
        '413':
          type: string
          description: Request exceeds size or count limits.
    DeleteV1AppsAppidPushSubscriptionsResponse:
      type: object
      properties:
        '200':
          type: string
          description: Subscription deleted successfully.
        '413':
          type: string
          description: Request body exceeds 4 KB limit.
    GetV1AppsIdQualityResponse:
      type: object
      properties:
        JSON report:
          type: string
          description: Code health score and related metrics
    GetV1AppsIdQualityBadgeResponse:
      type: object
      properties:
        SVG badge:
          type: string
          description: Badge image representing the code quality
    GetV1AuditAppsResponse:
      type: object
      properties:
        apps:
          type: array
          description: Array of app objects with fields id, repo, r2Prefix
        routesWithoutApps:
          type: array
          description: Array of slugs for routes that have no associated app
    GetV1PushVapidPublicKeyResponse:
      type: object
      properties:
        '200':
          type: string
          description: Returns the VAPID public key.
        '503':
          type: string
          description: Platform VAPID key not configured.
    PostV1UnpublishRequest:
      type: object
      properties:
        deleteRepo:
          type: boolean
          description: Pass true to delete the GitHub repository instead of archiving it.
    PostV1UnpublishResponse:
      type: object
      properties:
        archive_repo:
          type: boolean
          description: Indicates whether the repository was archived (true) or deleted (false).
  securitySchemes:
    Bearer_token:
      type: http
      scheme: bearer
      x-source: https://docs.freeappstore.online/mcp/#authentication
tags:
- name: Apps
- name: Audit
- name: Auth
- name: Push
- name: Session
- name: Unpublish
security:
- Bearer_token: []