Skip to content

Up to date OpenAPI 3 YAML and tool to convert generated swagger #847

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
javuto merged 1 commit into from
May 28, 2026
Merged

Up to date OpenAPI 3 YAML and tool to convert generated swagger #847

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 11 additions & 2 deletions Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -30,8 +30,9 @@ STATIC_ARGS = -ldflags "-linkmode external -extldflags -static"
BUILD_ARGS = -ldflags "-s -w -X main.buildCommit=$(shell git rev-parse HEAD) -X main.buildDate=$(shell date -u +%Y-%m-%dT%H:%M:%SZ)"
SWAG_VERSION ?= v1.16.6
SWAG = go run github.com/swaggo/swag/cmd/swag@$(SWAG_VERSION)
SWAG_OUTPUT_DIR ?= $(API_DIR)/docs

.PHONY: build static clean tls admin cli api swagger release release-build release-check release-init clean-dist frontend frontend-install frontend-dev frontend-build frontend-test
.PHONY: build static clean tls admin cli api swagger openapi openapi-check release release-build release-check release-init clean-dist frontend frontend-install frontend-dev frontend-build frontend-test

# Build code according to caller OS and architecture
build:
Expand Down Expand Up @@ -73,7 +74,15 @@ api-static:

# Generate Swagger 2.0 YAML and JSON files from API annotations
swagger:
$(SWAG) init -d $(API_DIR),$(API_DIR)/handlers,pkg/types,pkg/nodes,pkg/queries,pkg/environments,pkg/users,pkg/settings,pkg/tags,pkg/carves -g main.go -o $(API_DIR)/docs --outputTypes yaml,json --parseDependencyLevel 1
$(SWAG) init -d $(API_DIR),$(API_DIR)/handlers,pkg/types,pkg/nodes,pkg/queries,pkg/environments,pkg/users,pkg/settings,pkg/tags,pkg/carves -g main.go -o $(SWAG_OUTPUT_DIR) --outputTypes yaml,json --parseDependencyLevel 1

# Generate Swagger 2.0 docs and update the OpenAPI 3 spec
openapi:
./tools/update-openapi.sh

# Verify generated API docs are up to date
openapi-check:
./tools/update-openapi.sh --check

# Build the CLI
cli:
Expand Down
Loading
Loading