app.fitsky.workoutPlan Documentation (EN)

main record

A reusable workout plan template

Record Key tid Timestamp-based ID

Properties

createdAt string datetime Required

An RFC 3339 formatted timestamp.

exercises array of ref #planExercise Required

No description available.

name string Required

No description available.

maxLength: 256 bytes

ogImage blob Optional

Open Graph preview image for social sharing

maxSize: 1.0 MB

type string Required

No description available.

maxLength: 64 bytes

Known values: weightlifting, bodyweight, yoga, hiit

View raw schema

{
  "key": "tid",
  "type": "record",
  "record": {
    "type": "object",
    "required": [
      "name",
      "type",
      "exercises",
      "createdAt"
    ],
    "properties": {
      "name": {
        "type": "string",
        "maxLength": 256
      },
      "type": {
        "type": "string",
        "maxLength": 64,
        "knownValues": [
          "weightlifting",
          "bodyweight",
          "yoga",
          "hiit"
        ]
      },
      "ogImage": {
        "type": "blob",
        "accept": [
          "image/png",
          "image/jpeg",
          "image/webp"
        ],
        "maxSize": 1000000,
        "description": "Open Graph preview image for social sharing"
      },
      "createdAt": {
        "type": "string",
        "format": "datetime"
      },
      "exercises": {
        "type": "array",
        "items": {
          "ref": "#planExercise",
          "type": "ref"
        }
      }
    }
  },
  "description": "A reusable workout plan template"
}

planExercise object

No description available.

Properties

name string Required

No description available.

maxLength: 128 bytes

notes string Optional

No description available.

maxLength: 512 bytes

targetReps integer Required

No description available.

minimum: 1

targetSets integer Required

No description available.

minimum: 1

View raw schema

{
  "type": "object",
  "required": [
    "name",
    "targetSets",
    "targetReps"
  ],
  "properties": {
    "name": {
      "type": "string",
      "maxLength": 128
    },
    "notes": {
      "type": "string",
      "maxLength": 512
    },
    "targetReps": {
      "type": "integer",
      "minimum": 1
    },
    "targetSets": {
      "type": "integer",
      "minimum": 1
    }
  }
}