Wger Muscle API

openapi: 3.2.0
info:
  title: wger Muscle API
  version: 2.7.0a2
  description: Self hosted FLOSS workout and fitness tracker.
  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: muscle
paths:
  /api/v2/muscle/:
    get:
      operationId: muscle_list
      description: API endpoint for muscle objects
      parameters:
      - in: query
        name: is_front
        schema:
          type: boolean
      - name: limit
        required: false
        in: query
        description: Number of results to return per page.
        schema:
          type: integer
      - in: query
        name: name
        schema:
          type: string
      - in: query
        name: name_en
        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
      tags:
      - muscle
      security:
      - cookieAuth: []
      - tokenAuth: []
      - headlessJwtAuth: []
      - oidcAuth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/PaginatedMuscleList'
          description: ''
      summary: Muscle list
      x-summary-source: derived
  /api/v2/muscle/{id}/:
    get:
      operationId: muscle_retrieve
      description: API endpoint for muscle objects
      parameters:
      - in: path
        name: id
        schema:
          type: integer
        description: A unique integer value identifying this muscle.
        required: true
      tags:
      - muscle
      security:
      - cookieAuth: []
      - tokenAuth: []
      - headlessJwtAuth: []
      - oidcAuth: []
      - jwtAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Muscle'
          description: ''
      summary: Muscle retrieve
      x-summary-source: derived
components:
  schemas:
    Muscle:
      type: object
      description: Muscle serializer
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
          description: In latin, e.g. "Pectoralis major"
          maxLength: 50
        name_en:
          type: string
          title: Alternative name
          description: A more basic name for the muscle
          maxLength: 50
        is_front:
          type: boolean
        image_url_main:
          type:
          - string
          - 'null'
          description: Absolute URL to the main muscle image
          readOnly: true
        image_url_secondary:
          type:
          - string
          - 'null'
          description: Absolute URL to the secondary muscle image
          readOnly: true
      required:
      - id
      - image_url_main
      - image_url_secondary
      - name
    PaginatedMuscleList:
      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/Muscle'
  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
x-provenance:
  method: harvested
  publisher: Wger
  source: https://wger.de/api/v2/schema
  note: split by refine-openapis from the provider's own published document, verified by fetch (openapi/_original/*.fetch.json);
    stamped by stamp-openapi-provenance.py (roadmap#793)