Swagger spec issues #709

New Issue

OVERLORD · 2026-02-06T20:01:58+03:00

OVERLORD commented

2026-02-06 20:01:58 +03:00

Originally created by @josh-burton on GitHub (May 25, 2019).

The current swagger spec has some issues which means API specs aren't defined properly.

For example, the user views API doesn't define the UserId parameter or a response type.

"/emby/emby/Users/{UserId}/Views": {
      "get": {
        "tags": [],
        "operationId": "GetUserViews",
        "consumes": [
          "application/json"
        ],
        "produces": [
          "application/json"
        ],
        "parameters": [],
        "responses": {
          "200": {
            "description": "OK"
          }
        },
        "security": [
          {
            "api_key": []
          }
        ]
      }
    },

Originally created by @josh-burton on GitHub (May 25, 2019). The current swagger spec has some issues which means API specs aren't defined properly. For example, the user views API doesn't define the `UserId` parameter or a response type. ``` "/emby/emby/Users/{UserId}/Views": { "get": { "tags": [], "operationId": "GetUserViews", "consumes": [ "application/json" ], "produces": [ "application/json" ], "parameters": [], "responses": { "200": { "description": "OK" } }, "security": [ { "api_key": [] } ] } }, ```

OVERLORD added the wontfix label 2026-02-06 20:01:58 +03:00

OVERLORD closed this issue

2026-02-06 20:01:58 +03:00

OVERLORD commented

2026-02-06 20:02:00 +03:00

@sparky8251 commented on GitHub (Jun 25, 2019):

We are aware the docs suck. Unfortunately its what we inherited... Given the talks of a major API overhaul before the 11.0.z release, no one wants to really document the existing API.

We all agree the new API should be properly documented with parameters and response data samples. How we get there is uncertain.

Unfortunately, I am marking this "wontfix" and closing it. If someone wants to fix the swagger docs, all power to 'em, but we are just moving towards the new API which will be documented instead.

@sparky8251 commented on GitHub (Jun 25, 2019): We are aware the docs suck. Unfortunately its what we inherited... Given the talks of a major API overhaul before the 11.0.z release, no one wants to really document the existing API. We all agree the new API should be properly documented with parameters and response data samples. How we get there is uncertain. Unfortunately, I am marking this "wontfix" and closing it. If someone wants to fix the swagger docs, all power to 'em, but we are just moving towards the new API which will be documented instead.

OVERLORD referenced this issue

2026-02-07 05:44:32 +03:00

[PR #709] [MERGED] Fix always null expressions #8453

Sign in to join this conversation.

Branches Tags

master

release-10.11.z

renovate/skiasharp-monorepo

JPVenson-patch-1

renovate/morestachio-5.x

release-10.9.z

openapi-cache

release-10.10.z

explicit-load

explicit-load-v2

feature/entity-framework

only-count-folder-item

fix/ci-workflow-refactor

release-10.8.z

release-10.7.z

EraYaN-add-management-interface

release-10.6.z

release-10.5.z

release-10.4.z

release-10.3.z

release-10.2.z

release-10.1.0

1 Participants

Notifications

Due Date

No due date set.

Dependencies

No dependencies set.

Reference: starred/jellyfin#709