starred/netbox
1
0
Fork 0
mirror of https://github.com/netbox-community/netbox.git synced 2026-01-13 22:03:32 +01:00
Code Issues 273 Packages Projects Releases 10 Wiki Activity

[PR #14568] [CLOSED] Add PUBLIC_SWAGGER configuration option #14408

New Issue
Closed
opened 2025-12-29 23:24:19 +01:00 by adam · 0 comments
adam commented 2025-12-29 23:24:19 +01:00
Owner
Copy Link

📋 Pull Request Information

Original PR: https://github.com/netbox-community/netbox/pull/14568
Author: @XioNoX
Created: 12/20/2023
Status: ❌ Closed

Base: develop ← Head: develop

📝 Commits (2)

  • 14472c0 Add PUBLIC_SWAGGER configuration option
  • 3601331 Rename PUBLIC_SWAGGER to SWAGGER_PUBLIC

📊 Changes

2 files changed (+10 additions, -0 deletions)

View changed files

📝 docs/configuration/miscellaneous.md (+8 -0)
📝 netbox/netbox/settings.py (+2 -0)

📄 Description

Fixes: #14555

Swagger metadata are by default opened to unauthenticated users. Add a configuration option to be able to only expose them to authenticated users.

Even though it's only the metadata (and not read or write operations) public Netbox instances attract a significant amount of "Google traffic" and people experimenting with the API, slowing down Netbox.

🔄 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/netbox-community/netbox/pull/14568 **Author:** [@XioNoX](https://github.com/XioNoX) **Created:** 12/20/2023 **Status:** ❌ Closed **Base:** `develop` ← **Head:** `develop` --- ### 📝 Commits (2) - [`14472c0`](https://github.com/netbox-community/netbox/commit/14472c0cf4bc48f066af6da1c8f8b05084bd78d4) Add PUBLIC_SWAGGER configuration option - [`3601331`](https://github.com/netbox-community/netbox/commit/36013319b10c3c39f7caac6ddd8e90b1ce495dca) Rename PUBLIC_SWAGGER to SWAGGER_PUBLIC ### 📊 Changes **2 files changed** (+10 additions, -0 deletions) <details> <summary>View changed files</summary> 📝 `docs/configuration/miscellaneous.md` (+8 -0) 📝 `netbox/netbox/settings.py` (+2 -0) </details> ### 📄 Description ### Fixes: #14555 Swagger metadata are by default opened to unauthenticated users. Add a configuration option to be able to only expose them to authenticated users. Even though it's only the metadata (and not read or write operations) public Netbox instances attract a significant amount of "Google traffic" and people experimenting with the API, slowing down Netbox. --- <sub>🔄 This issue represents a GitHub Pull Request. It cannot be merged through Gitea due to API limitations.</sub>
adam added the pull-request label 2025-12-29 23:24:19 +01:00
adam closed this issue 2025-12-29 23:24:19 +01:00
Sign in to join this conversation.
No Branch/Tag Specified
Branches Tags
Labels
Clear labels
beta
breaking change
complexity: high
complexity: low
complexity: medium
needs milestone
netbox
pending closure
plugin candidate
pull-request
Mirrored from GitHub Pull Request
 severity: high
severity: low
severity: medium
status: accepted
status: backlog
status: blocked
status: duplicate
status: needs owner
status: needs triage
status: revisions needed
status: under review
topic: GraphQL
topic: Internationalization
topic: OpenAPI
topic: UI/UX
topic: cabling
topic: event rules
topic: htmx navigation
topic: industrialization
topic: migrations
topic: plugins
topic: scripts
topic: templating
topic: testing
type: bug
type: deprecation
type: documentation
type: feature
type: housekeeping
type: translation
No Label pull-request
Milestone
No items
No Milestone
Projects
Clear projects
No project
Assignees
Clear assignees
adam
No Assignees
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/netbox#14408
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?