Wger Workoutsession API

openapi: 3.2.0
info:
  title: wger Workoutsession API
  version: 2.7.0a2
  description: "Self hosted FLOSS workout and fitness tracker.\n\n## Authentication\n\nSystem-wide data such as the exercise database, ingredients and units can be\nread without authenticating. Everything tied to a user account needs one of the\nfollowing, which are tried in this order:\n\n* `Authorization: Token <key>` with a personal API key. Users create one on the\n  API key page of their profile, e.g. `/en/user/api-key`.\n* `Authorization: Bearer <token>` with a JWT access token.\n* The session cookie, which is what a logged-in browser uses.\n\n## Pagination\n\nList endpoints take `limit` and `offset`, and answer with `count`, `next`,\n`previous` and `results`. The default page size is 20 and `limit` is capped\nat 999.\n\n`/api/v2/ingredient-sync/` is the exception. It uses cursor pagination so that\nsyncing the catalogue stays fast no matter how far a client has paginated. That\nresponse carries no `count`, and clients follow `next` instead of picking an\noffset.\n\n## Filtering and ordering\n\nMost list endpoints accept filters on a subset of their fields, plus `ordering`\nwith a field name that can be prefixed with `-` to reverse it. Both are listed\nper endpoint.\n\n## Unknown fields are dropped on write\n\nA field that the endpoint does not declare is ignored instead of rejected. Such\na request still answers 200 or 201, and the unknown field simply has no effect,\nso check a write against the response body rather than the status code.\n\n## Rate limits\n\nThe ingredient endpoints are rate limited because the catalogue holds millions\nof rows, and creating exercises is capped as well. Limits count per user for\nauthenticated callers and per IP otherwise. Exceeding one answers 429.\n"
  license:
    name: AGPL-3.0-or-later
    url: https://www.gnu.org/licenses/agpl-3.0.html
servers:
- url: /
  description: This server
- url: https://wger.de
  description: The "official" upstream wger instance
tags:
- name: workoutsession
paths:
  /api/v2/workoutsession/:
    get:
      operationId: workoutsession_list
      description: API endpoint for workout sessions objects
      parameters:
      - in: query
        name: date
        schema:
          type: string
          format: date
      - in: query
        name: impression
        schema:
          type: string
          title: General impression
          enum:
          - '1'
          - '2'
          - '3'
        description: 'Your impression about this workout session. Did you exercise as well as you could?


          * `1` - Bad

          * `2` - Neutral

          * `3` - Good'
      - name: limit
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: notes
        schema:
          type: string
      - name: offset
        required: false
        in: query
        description: The initial index from which to return the results.
        schema:
          type: integer
      - name: ordering
        required: false
        in: query
        description: Which field to use when ordering the results.
        schema:
          type: string
      - in: query
        name: routine
        schema:
          type: integer
      - in: query
        name: time_end
        schema:
          type: string
          format: time
      - in: query
        name: time_start
        schema:
          type: string
          format: time
      tags:
      - workoutsession
      security:
      - cookieAuth: []
      - tokenAuth: []
      - headlessJwtAuth: []
      - oidcAuth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedWorkoutSessionList'
          description: ''
    post:
      operationId: workoutsession_create
      description: API endpoint for workout sessions objects
      tags:
      - workoutsession
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkoutSessionRequest'
      security:
      - cookieAuth: []
      - tokenAuth: []
      - headlessJwtAuth: []
      - oidcAuth: []
      - jwtAuth: []
      responses:
        '201':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkoutSession'
          description: ''
  /api/v2/workoutsession/{id}/:
    get:
      operationId: workoutsession_retrieve
      description: API endpoint for workout sessions objects
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this workout session.
        required: true
      tags:
      - workoutsession
      security:
      - cookieAuth: []
      - tokenAuth: []
      - headlessJwtAuth: []
      - oidcAuth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkoutSession'
          description: ''
    put:
      operationId: workoutsession_update
      description: API endpoint for workout sessions objects
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this workout session.
        required: true
      tags:
      - workoutsession
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/WorkoutSessionRequest'
      security:
      - cookieAuth: []
      - tokenAuth: []
      - headlessJwtAuth: []
      - oidcAuth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkoutSession'
          description: ''
    patch:
      operationId: workoutsession_partial_update
      description: API endpoint for workout sessions objects
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this workout session.
        required: true
      tags:
      - workoutsession
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/PatchedWorkoutSessionRequest'
      security:
      - cookieAuth: []
      - tokenAuth: []
      - headlessJwtAuth: []
      - oidcAuth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/WorkoutSession'
          description: ''
    delete:
      operationId: workoutsession_destroy
      description: API endpoint for workout sessions objects
      parameters:
      - in: path
        name: id
        schema:
          type: string
          format: uuid
        description: A UUID string identifying this workout session.
        required: true
      tags:
      - workoutsession
      security:
      - cookieAuth: []
      - tokenAuth: []
      - headlessJwtAuth: []
      - oidcAuth: []
      - jwtAuth: []
      responses:
        '204':
          description: No response body
components:
  schemas:
    PatchedWorkoutSessionRequest:
      type: object
      description: Workout session serializer
      properties:
        id:
          type: string
          format: uuid
        routine:
          type:
          - integer
          - 'null'
        day:
          type:
          - integer
          - 'null'
        date:
          type: string
          format: date
        notes:
          type:
          - string
          - 'null'
          description: Any notes you might want to save about this workout session.
        impression:
          allOf:
          - $ref: '#/components/schemas/ImpressionEnum'
          title: General impression
          description: 'Your impression about this workout session. Did you exercise as well as you could?


            * `1` - Bad

            * `2` - Neutral

            * `3` - Good'
        time_start:
          type:
          - string
          - 'null'
          format: time
          title: Start time
        time_end:
          type:
          - string
          - 'null'
          format: time
          title: Finish time
    PaginatedWorkoutSessionList:
      type: object
      required:
      - count
      - results
      properties:
        count:
          type: integer
          example: 123
        next:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?offset=400&limit=100
        previous:
          type:
          - string
          - 'null'
          format: uri
          example: http://api.example.org/accounts/?offset=200&limit=100
        results:
          type: array
          items:
            $ref: '#/components/schemas/WorkoutSession'
    WorkoutSessionRequest:
      type: object
      description: Workout session serializer
      properties:
        id:
          type: string
          format: uuid
        routine:
          type:
          - integer
          - 'null'
        day:
          type:
          - integer
          - 'null'
        date:
          type: string
          format: date
        notes:
          type:
          - string
          - 'null'
          description: Any notes you might want to save about this workout session.
        impression:
          allOf:
          - $ref: '#/components/schemas/ImpressionEnum'
          title: General impression
          description: 'Your impression about this workout session. Did you exercise as well as you could?


            * `1` - Bad

            * `2` - Neutral

            * `3` - Good'
        time_start:
          type:
          - string
          - 'null'
          format: time
          title: Start time
        time_end:
          type:
          - string
          - 'null'
          format: time
          title: Finish time
    WorkoutSession:
      type: object
      description: Workout session serializer
      properties:
        id:
          type: string
          format: uuid
        routine:
          type:
          - integer
          - 'null'
        day:
          type:
          - integer
          - 'null'
        date:
          type: string
          format: date
        notes:
          type:
          - string
          - 'null'
          description: Any notes you might want to save about this workout session.
        impression:
          allOf:
          - $ref: '#/components/schemas/ImpressionEnum'
          title: General impression
          description: 'Your impression about this workout session. Did you exercise as well as you could?


            * `1` - Bad

            * `2` - Neutral

            * `3` - Good'
        time_start:
          type:
          - string
          - 'null'
          format: time
          title: Start time
        time_end:
          type:
          - string
          - 'null'
          format: time
          title: Finish time
    ImpressionEnum:
      enum:
      - '1'
      - '2'
      - '3'
      type: string
      description: '* `1` - Bad

        * `2` - Neutral

        * `3` - Good'
  securitySchemes:
    cookieAuth:
      type: apiKey
      in: cookie
      name: sessionid
    headlessJwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
      description: Access token issued by the allauth headless endpoints
    jwtAuth:
      type: http
      scheme: bearer
      bearerFormat: JWT
    oidcAuth:
      type: oauth2
      description: Access token issued by the OAuth2/OIDC provider
      flows:
        authorizationCode:
          authorizationUrl: https://wger.de/identity/o/authorize
          tokenUrl: https://wger.de/identity/o/api/token
          scopes:
            api:read: View your training, nutrition and body data
            api:write: Add and change your training, nutrition and body data
    tokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Token"
externalDocs:
  url: https://wger.readthedocs.io
  description: wger documentation