SparkyFitness Exercise Entries API

openapi: 3.2.0
info:
  title: SparkyFitness Exercise Entries API
  version: 1.0.0
  description: API documentation for the SparkyFitness application, providing a comprehensive guide to all available endpoints. Have caution using the API directly, as improper use may lead to data loss or corruption.  Also note that the API is subject to change without notice due to heavy development, so always refer to the latest documentation for up-to-date information. It might have flaw and due to vite/nginx internal proxy actual end point accessed via front end URL might be different than hitting them directly on the server.
  contact:
    name: SparkyFitness Support
servers:
- url: https://{host}/api
  description: Self-hosted SparkyFitness instance (the operator supplies the host). The upstream spec declares the relative base "/api".
  variables:
    host:
      default: sparkyfitness.example.com
      description: Hostname of your own SparkyFitness deployment. SparkyFitness is self-hosted; there is no vendor-operated API host.
security:
- apiKeyAuth: []
tags:
- name: Exercise Entries
paths:
  /exercise-entries/import-fit:
    post:
      summary: Import Garmin FIT activity files as exercise diary entries.
      description: 'Decodes up to 10 uploaded .fit files and creates one exercise entry per file, including full activity details for reports. Re-uploading a file updates the existing entry. Per-file failures are reported as rows in the results array; the response is 200 unless the request itself is invalid.

        '
      tags:
      - Exercise Entries
      security:
      - bearerAuth: []
      requestBody:
        required: true
        content:
          multipart/form-data:
            schema:
              type: object
              properties:
                files:
                  type: array
                  items:
                    type: string
                    format: binary
      responses:
        '200':
          description: Per-file import results.
          content:
            application/json:
              schema:
                type: object
                properties:
                  message:
                    type: string
                  created:
                    type: number
                  updated:
                    type: number
                  failed:
                    type: number
                  results:
                    type: array
                    items:
                      type: object
                      properties:
                        fileName:
                          type: string
                        status:
                          type: string
                          enum:
                          - created
                          - updated
                          - failed
                        reason:
                          type: string
                        warning:
                          type: string
                        exerciseEntryId:
                          type: string
                        entryDate:
                          type: string
                          format: date
                        activityName:
                          type: string
                        sport:
                          type: string
        '400':
          description: No files uploaded, or the upload exceeded size/count limits.
        '500':
          description: Failed to import FIT files.
components:
  securitySchemes:
    apiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: API key authentication via x-api-key header.
x-provenance:
  generated: '2026-08-27'
  method: derived
  source: https://github.com/CodeWithCJ/SparkyFitness — assembled from the project's own swagger-jsdoc configuration (SparkyFitnessServer/config/swagger.ts) and the 419 @swagger JSDoc blocks in SparkyFitnessServer/routes/**, using the same scan paths and the same cookieAuth->apiKeyAuth post-processing the server applies. This is the identical document a running instance serves at GET /api/api-docs/json (Swagger UI at /api/api-docs/swagger, ReDoc at /api/api-docs/redoc).
  note: 'Not fetched from a live host: SparkyFitness is self-hosted and the project operates no public instance, so the contract can only be read from the source that generates it. Upstream sets no operationIds; paths+methods are the stable identifiers.'
  upstream_version: server package.json 1.6.4 (release v1.6.4, 2026-08-27)