Skip to content

feat(openapi): add endpoint tags and update docs workflow #45

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
sallymoc merged 1 commit into from
Feb 6, 2026
Merged

feat(openapi): add endpoint tags and update docs workflow #45

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: 10 additions & 3 deletions .github/workflows/api-docs-update-v2.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,22 @@ on:
branches:
- main
paths:
- 'protobuff/qubic.swagger.json' # Only trigger if the swagger file changed
- 'protobuff/qubic.openapi.yaml' # Only trigger if the OpenAPI file changed

jobs:
api-docs-update-trigger:
runs-on: ubuntu-latest
steps:
- name: Dispatch Event
- name: Dispatch to Integration
uses: peter-evans/repository-dispatch@v3
with:
token: ${{ secrets.GH_PAT }}
repository: qubic/integration
event-type: api-docs-update
event-type: api-docs-update

- name: Dispatch to Docs
uses: peter-evans/repository-dispatch@v3
with:
token: ${{ secrets.GH_PAT }}
repository: qubic/docs
event-type: live-api-update
2 changes: 2 additions & 0 deletions protobuff/Makefile
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -33,6 +33,8 @@ all: $(GO) openapi-v3

openapi-v3:
protoc -I=. --openapi_out=output_mode=source_relative,default_response=false:. *.proto
@# Add x-scalar-ignore to auto-generated QubicLiveService tag
yq -i '(.tags[] | select(.name == "QubicLiveService")).x-scalar-ignore = true' qubic.openapi.yaml

clean:
rm -f *.pb.go
Expand Down
Loading