[PR #2357] [CLOSED] refactor: converted headscale.swagger.json to openapi 3.0 + bearer auth #2624

Closed
opened 2025-12-29 03:22:05 +01:00 by adam · 0 comments
Owner

📋 Pull Request Information

Original PR: https://github.com/juanfont/headscale/pull/2357
Author: @ChxGuillaume
Created: 1/20/2025
Status: Closed

Base: mainHead: feat/swagger-to-openapi-3


📝 Commits (1)

  • a30b799 refactor: converted headscale.swagger.json to openapi 3.0 + bearer auth

📊 Changes

1 file changed (+1012 additions, -741 deletions)

View changed files

📝 gen/openapiv2/headscale/v1/headscale.swagger.json (+1012 -741)

📄 Description

  • have read the CONTRIBUTING.md file
  • raised a GitHub issue or discussed it on the projects chat beforehand
  • added unit tests
  • added integration tests
  • updated documentation if needed
  • updated CHANGELOG.md

I recently used the swagger document and imported it into Postman and saw no "security schema" was included.
So I made an OpenAPI 3.0 version with the bearer auth for all routes.


🔄 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/juanfont/headscale/pull/2357 **Author:** [@ChxGuillaume](https://github.com/ChxGuillaume) **Created:** 1/20/2025 **Status:** ❌ Closed **Base:** `main` ← **Head:** `feat/swagger-to-openapi-3` --- ### 📝 Commits (1) - [`a30b799`](https://github.com/juanfont/headscale/commit/a30b799e2a98bc62862a6c007dfbb9e4631d8142) refactor: converted headscale.swagger.json to openapi 3.0 + bearer auth ### 📊 Changes **1 file changed** (+1012 additions, -741 deletions) <details> <summary>View changed files</summary> 📝 `gen/openapiv2/headscale/v1/headscale.swagger.json` (+1012 -741) </details> ### 📄 Description <!-- Headscale is "Open Source, acknowledged contribution", this means that any contribution will have to be discussed with the Maintainers before being submitted. This model has been chosen to reduce the risk of burnout by limiting the maintenance overhead of reviewing and validating third-party code. Headscale is open to code contributions for bug fixes without discussion. If you find mistakes in the documentation, please submit a fix to the documentation. --> <!-- Please tick if the following things apply. You… --> - [x] have read the [CONTRIBUTING.md](./CONTRIBUTING.md) file - [ ] raised a GitHub issue or discussed it on the projects chat beforehand - [ ] added unit tests - [ ] added integration tests - [x] updated documentation if needed - [ ] updated CHANGELOG.md <!-- If applicable, please reference the issue using `Fixes #XXX` and add tests to cover your new code. --> I recently used the swagger document and imported it into Postman and saw no "security schema" was included. So I made an OpenAPI 3.0 version with the bearer auth for all routes. --- <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 03:22:05 +01:00
adam closed this issue 2025-12-29 03:22:05 +01:00
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: starred/headscale#2624