starred/jellyfin
1
0
Fork 0
mirror of https://github.com/jellyfin/jellyfin.git synced 2026-07-16 05:43:54 +03:00
Code Issues 822 Packages Projects Releases 17 Wiki Activity

[PR #15996] Swagger: load xml comments from plugins #14489

New Issue
Open
opened 2026-02-07 07:30:39 +03:00 by OVERLORD · 0 comments
OVERLORD commented 2026-02-07 07:30:39 +03:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/jellyfin/jellyfin/pull/15996
Author: @jon4hz
Created: 1/11/2026
Status: 🔄 Open

Base: master ← Head: feat-plugin-swagger-docs

📝 Commits (1)

  • 330fd32 Swagger: load xml comments from plugins

📊 Changes

2 files changed (+25 additions, -3 deletions)

View changed files

📝 Jellyfin.Server/Extensions/ApiServiceCollectionExtensions.cs (+22 -1)
📝 Jellyfin.Server/Startup.cs (+3 -2)

📄 Description

Changes

This PR allows plugins to include xml comments from custom rest endpoints in the swagger docs.
With the comments included, you can then test your plugin's endpoints on the swagger page and also generate openapi client implementations for the plugin.

For this to work, the plugin must enable docs generation in the .csproj file:

  <PropertyGroup>
    <GenerateDocumentationFile>true</GenerateDocumentationFile>
  </PropertyGroup>

The resulting My.Plugin.Name.xml file must also be included in the release zip of the plugin.

🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.

## 📋 Pull Request Information **Original PR:** https://github.com/jellyfin/jellyfin/pull/15996 **Author:** [@jon4hz](https://github.com/jon4hz) **Created:** 1/11/2026 **Status:** 🔄 Open **Base:** `master` ← **Head:** `feat-plugin-swagger-docs` --- ### 📝 Commits (1) - [`330fd32`](https://github.com/jellyfin/jellyfin/commit/330fd32317e322c8ae6f4ffce10b44509de701c9) Swagger: load xml comments from plugins ### 📊 Changes **2 files changed** (+25 additions, -3 deletions) <details> <summary>View changed files</summary> 📝 `Jellyfin.Server/Extensions/ApiServiceCollectionExtensions.cs` (+22 -1) 📝 `Jellyfin.Server/Startup.cs` (+3 -2) </details> ### 📄 Description **Changes** This PR allows plugins to include xml comments from custom rest endpoints in the swagger docs. With the comments included, you can then test your plugin's endpoints on the swagger page and also generate openapi client implementations for the plugin. For this to work, the plugin must enable docs generation in the `.csproj` file: ```xml <PropertyGroup> <GenerateDocumentationFile>true</GenerateDocumentationFile> </PropertyGroup> ``` The resulting `My.Plugin.Name.xml` file must also be included in the release zip of the plugin. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
OVERLORD added the pull-request label 2026-02-07 07:30:39 +03:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
EFjellyfin.db
area:database
awaiting-feedback
backend
blocked
breaking change: web api
bug
build
ci
confirmed
discussion needed
dotnet future
downstream
duplicate
enhancement
feature
future
github-actions
good first issue
hdr
help wanted
invalid
investigation
librarydb
live-tv
lyrics
media playback
music
needs testing
nuget
performance
platform
pull-request
Mirrored from GitHub Pull Request
 question
regression
release critical
requires-web
roadmap
security
security
stale
support
syncplay
ui & ux
upstream
wontfix
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
OVERLORD
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/jellyfin#14489
Delete Branch "%!s()"

Deleting a branch is permanent. Although the deleted branch may continue to exist for a short time before it actually gets removed, it CANNOT be undone in most cases. Continue?