Tube Archivist User API

openapi: 3.2.0
info:
  title: Tubearchivist User API
  version: v0.6.0
  description: 'Operations tagged User across 2 of this provider''s published API definitions: schema.yaml, tubearchivist-openapi.yml. Each path carries the servers of the definition it was published in.'
tags:
- name: User
paths:
  /api/user/account/:
    get:
      operationId: api_user_account_retrieve
      description: get user account
      tags:
      - User
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Account'
          description: ''
      summary: Api user account retrieve
      x-summary-source: derived
  /api/user/login/:
    post:
      operationId: api_user_login_create
      description: login with username and password
      tags:
      - User
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/Login'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/Login'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/Login'
        required: true
      security:
      - cookieAuth: []
      - basicAuth: []
      - {}
      responses:
        '204':
          description: login successful
      summary: Api user login create
      x-summary-source: derived
  /api/user/logout/:
    post:
      operationId: api_user_logout_create
      description: logout user from session
      tags:
      - User
      security:
      - tokenAuth: []
      responses:
        '204':
          description: logout successful
      summary: Api user logout create
      x-summary-source: derived
  /api/user/me/:
    get:
      operationId: api_user_me_retrieve
      description: get user config
      tags:
      - User
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserMeConfig'
          description: ''
      summary: Api user me retrieve
      x-summary-source: derived
    post:
      operationId: api_user_me_create
      description: update config, allows partial update
      tags:
      - User
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/UserMeConfig'
          application/x-www-form-urlencoded:
            schema:
              $ref: '#/components/schemas/UserMeConfig'
          multipart/form-data:
            schema:
              $ref: '#/components/schemas/UserMeConfig'
        required: true
      security:
      - tokenAuth: []
      responses:
        '200':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/UserMeConfig'
          description: ''
        '400':
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
          description: Bad request
      summary: Api user me create
      x-summary-source: derived
components:
  schemas:
    ErrorResponse:
      type: object
      description: error message
      properties:
        error:
          type: string
      required:
      - error
    FileSizeUnitEnum:
      enum:
      - binary
      - metric
      type: string
      description: '* `binary` - binary

        * `metric` - metric'
    Account:
      type: object
      description: serialize account
      properties:
        id:
          type: integer
          readOnly: true
        name:
          type: string
          maxLength: 150
        is_superuser:
          type: boolean
          title: Superuser status
          description: Designates that this user has all permissions without explicitly assigning them.
        is_staff:
          type: boolean
        groups:
          type: array
          items:
            type: integer
          description: The groups this user belongs to. A user will get all permissions granted to each of their groups.
        user_permissions:
          type: array
          items:
            type: integer
          description: Specific permissions for this user.
        last_login:
          type:
          - string
          - 'null'
          format: date-time
      required:
      - id
      - name
    UserMeConfig:
      type: object
      description: serialize user me config
      properties:
        stylesheet:
          $ref: '#/components/schemas/StylesheetEnum'
        page_size:
          type: integer
        sort_by:
          $ref: '#/components/schemas/SortByEnum'
        sort_order:
          $ref: '#/components/schemas/SortOrderEnum'
        view_style_home:
          $ref: '#/components/schemas/ViewStyleHomeEnum'
        view_style_channel:
          $ref: '#/components/schemas/ViewStylePlaylistEnum'
        view_style_downloads:
          $ref: '#/components/schemas/ViewStylePlaylistEnum'
        view_style_playlist:
          $ref: '#/components/schemas/ViewStylePlaylistEnum'
        vid_type_filter:
          oneOf:
          - $ref: '#/components/schemas/VidTypeFilterEnum'
          - $ref: '#/components/schemas/NullEnum'
        grid_items:
          type: integer
          maximum: 7
          minimum: 3
        hide_watched:
          type:
          - boolean
          - 'null'
        hide_watched_channel:
          type:
          - boolean
          - 'null'
        hide_watched_playlist:
          type:
          - boolean
          - 'null'
        file_size_unit:
          $ref: '#/components/schemas/FileSizeUnitEnum'
        show_ignored_only:
          type: boolean
        show_subed_only:
          type:
          - boolean
          - 'null'
        show_subed_only_playlists:
          type:
          - boolean
          - 'null'
        show_help_text:
          type: boolean
      required:
      - file_size_unit
      - grid_items
      - hide_watched
      - hide_watched_channel
      - hide_watched_playlist
      - page_size
      - show_help_text
      - show_ignored_only
      - show_subed_only
      - show_subed_only_playlists
      - sort_by
      - sort_order
      - stylesheet
      - vid_type_filter
      - view_style_channel
      - view_style_downloads
      - view_style_home
      - view_style_playlist
    StylesheetEnum:
      enum:
      - dark.css
      - light.css
      - matrix.css
      - midnight.css
      - custom.css
      type: string
      description: '* `dark.css` - dark.css

        * `light.css` - light.css

        * `matrix.css` - matrix.css

        * `midnight.css` - midnight.css

        * `custom.css` - custom.css'
    RememberMeEnum:
      enum:
      - 'on'
      - 'off'
      type: string
      description: '* `on` - on

        * `off` - off'
    SortByEnum:
      enum:
      - published
      - downloaded
      - views
      - likes
      - duration
      - mediasize
      - width
      - height
      type: string
      description: '* `published` - published

        * `downloaded` - downloaded

        * `views` - views

        * `likes` - likes

        * `duration` - duration

        * `mediasize` - mediasize

        * `width` - width

        * `height` - height'
    NullEnum:
      enum:
      - null
    ViewStyleHomeEnum:
      enum:
      - grid
      - list
      - table
      type: string
      description: '* `grid` - grid

        * `list` - list

        * `table` - table'
    SortOrderEnum:
      enum:
      - asc
      - desc
      type: string
      description: '* `asc` - asc

        * `desc` - desc'
    Login:
      type: object
      description: serialize login
      properties:
        username:
          type: string
        password:
          type: string
        remember_me:
          allOf:
          - $ref: '#/components/schemas/RememberMeEnum'
          default: 'off'
      required:
      - password
      - username
    ViewStylePlaylistEnum:
      enum:
      - grid
      - list
      type: string
      description: '* `grid` - grid

        * `list` - list'
    VidTypeFilterEnum:
      enum:
      - videos
      - streams
      - shorts
      type: string
      description: '* `videos` - videos

        * `streams` - streams

        * `shorts` - shorts'
  securitySchemes:
    basicAuth:
      type: http
      scheme: basic
    cookieAuth:
      type: apiKey
      in: cookie
      name: sessionid
    tokenAuth:
      type: apiKey
      in: header
      name: Authorization
      description: Token-based authentication with required prefix "Token"
x-refined-from:
- schema.yaml
- tubearchivist-openapi.yml