Skip to content
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.

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

Clean up API #4005

Open
wants to merge 54 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
54 commits
Select commit Hold shift + click to select a range
ca577e3
Clean up API.
sarataha Sep 12, 2023
0c43e86
Revert including clusterNamespace/name in path
foot Oct 6, 2023
0ad0318
adds swagger-ui as a react component
foot Oct 4, 2023
e5d636d
Update docstrings for proto methods
foot Oct 6, 2023
0b53192
Test out gitattributes to collapse part of the diff
foot Oct 6, 2023
36535c2
Ignore swagger files in website docs too
foot Oct 6, 2023
0449377
Fix up prod build w/ swagger-ui
foot Oct 7, 2023
c4ddf96
Generate buf so ci is happy
foot Oct 7, 2023
cc7c6c5
Fixes staging docs
foot Oct 7, 2023
952c20a
echo cmd substitution
foot Oct 7, 2023
e9a33f7
Adds baseUrl
foot Oct 7, 2023
42138f3
Oops, fix up hook position
foot Oct 7, 2023
c2a821c
Fixes react hook being called conditionally
foot Oct 9, 2023
b8c0f29
Fixes loading the login screen
foot Oct 9, 2023
cbb5686
Adds a simple /namespaces/{ns}/object style of route
foot Oct 9, 2023
0a6b1ec
Revert /v1/events to a top level endpoint
foot Oct 9, 2023
67160c5
Convert more endpoints to GET
foot Oct 16, 2023
9ad5fe3
Standardise on "name" and "namespace" as path name vars
foot Oct 16, 2023
fe06315
Upgrade grpc-gateway to a version that supports internal api methods
foot Oct 17, 2023
dc46e67
Fix up TS errors
foot Oct 17, 2023
0524d3e
Rollback tf-controller not sure why it bumped up
foot Oct 17, 2023
b519d77
Cleanup, reduce some of the changes
foot Oct 17, 2023
64b1129
Downgrade deps other than grpc-gateway
foot Oct 17, 2023
cc0e7bb
Re-gen proto properly, fix ui tests
foot Oct 17, 2023
2158758
Merge remote-tracking branch 'origin/main' into api-cleanup
foot Oct 17, 2023
9de4fd0
Merge remote-tracking branch 'origin/main' into api-cleanup
foot Oct 18, 2023
d851831
Adds a few more doc descriptions to /flux
foot Oct 18, 2023
385c514
Update WGE / Gitopssets swagger
foot Oct 18, 2023
43be5a4
Add swagger-ui Makefile target
bigkevmcd Oct 18, 2023
8c2807e
Fixes some docusaurus x swagger-ui styling issues
foot Oct 18, 2023
cb7b06d
Adds example on how to render templates to a PR via a script
foot Oct 19, 2023
463cb48
Fix.
bigkevmcd Oct 18, 2023
9abc7a9
Remove unused field.
bigkevmcd Oct 19, 2023
8719817
Simplify example
foot Oct 19, 2023
c5ff6c3
Merge branch 'main' into api-cleanup
bigkevmcd Oct 19, 2023
e4ecd0b
Expose internal methods again
foot Oct 23, 2023
269362f
Bring in all APIs, even those not ready for use
foot Oct 30, 2023
a17612b
Merge branch 'main' into api-cleanup
bigkevmcd Nov 1, 2023
c1ba4e3
Update EE protos
foot Nov 3, 2023
04209b6
Latest apis from EE main
foot Nov 10, 2023
47537fc
rip gitopssets api
foot Nov 14, 2023
35eb679
Merge remote-tracking branch 'origin/main' into api-cleanup
foot Nov 15, 2023
de2cdc6
Adds more docsstrings
foot Nov 16, 2023
1f054ba
More docs
foot Nov 16, 2023
ad7dce6
Tidy up docstrings
foot Nov 16, 2023
dde725f
DIY TOC for now
foot Nov 17, 2023
44835bb
Merge remote-tracking branch 'origin/main' into api-cleanup
foot Nov 17, 2023
d4c6880
Move create-template example to examples/templates
foot Nov 17, 2023
d69d1c5
Adds an example to render a template via the API
foot Nov 17, 2023
89e1c0c
Adds example for automations too
foot Nov 17, 2023
8e4d8a1
Show models by default
foot Nov 20, 2023
72b3d36
More docs around fields
foot Nov 20, 2023
02ce076
More docstrings
foot Nov 21, 2023
2bdcffe
Adds improved gitauth/workspace docs
foot Nov 22, 2023
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
4 changes: 4 additions & 0 deletions .gitattributes
Original file line number Diff line number Diff line change
@@ -0,0 +1,4 @@
# Collapse the diff of generated files in github by default
**/*.swagger.json linguist-generated=true
**/*.pb.* linguist-generated=true

2 changes: 1 addition & 1 deletion .protolint.yaml
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ lint:
# The specific linters to add.
add:
- MESSAGE_NAMES_UPPER_CAMEL_CASE
- MAX_LINE_LENGTH
- MAX_LINE_LENGTH 120
- INDENT 4
- SERVICE_NAMES_END_WITH
- FILE_NAMES_LOWER_SNAKE_CASE
Expand Down
7 changes: 7 additions & 0 deletions Makefile
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ GIT_COMMIT?=$(shell which git > /dev/null && git log -n1 --pretty='%h')
VERSION?=$(shell which git > /dev/null && git describe --always --match "v*")
FLUX_VERSION=2.0.1
CHART_VERSION=$(shell which yq > /dev/null && yq e '.version' charts/gitops-server/Chart.yaml)
CURRENT_DIR := $(shell pwd)
TIER=oss

# Go build args
Expand Down Expand Up @@ -135,6 +136,7 @@ proto: ## Generate protobuf files
@go install google.golang.org/grpc/cmd/[email protected]
@go install github.com/bufbuild/buf/cmd/[email protected]
buf generate
cp api/core/core.swagger.json website/static/swagger/core.swagger.json
# This job is complaining about a missing plugin and error-ing out
# oapi-codegen -config oapi-codegen.config.yaml api/applications/applications.swagger.json

Expand Down Expand Up @@ -246,3 +248,8 @@ ifeq ($(OS),Windows_NT)
else
@awk 'BEGIN {FS = ":.*##"; printf "\nUsage:\n make \033[36m<target>\033[0m\n"} /^[a-zA-Z_-]+:.*?##/ { printf " \033[36m%-40s\033[0m %s\n", $$1, $$2 } /^##@/ { printf "\n\033[1m%s\033[0m\n", substr($$0, 5) } ' $(MAKEFILE_LIST)
endif

.PHONY: swagger-docs
swagger-docs:
@echo "Swagger docs available at http://localhost:6001"
docker run -p 6001:8080 -e SWAGGER_JSON=/api/core/core.swagger.json -v $(CURRENT_DIR)/api:/api swaggerapi/swagger-ui
Loading
Loading