Skip to content

feat: Generate OpenAPI specification for Tenant and Warehouse APIs. #9

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
hantmac merged 5 commits into from
Dec 16, 2024
Merged

feat: Generate OpenAPI specification for Tenant and Warehouse APIs. #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
ab8dfc5
chore: add openapi-gen in script.
Electronic-Waste Dec 16, 2024
0745679
fix: fix version to v1alpha1 in the codegen script.
Electronic-Waste Dec 16, 2024
04bff5f
chore: add doc.go in v1alpha1.
Electronic-Waste Dec 16, 2024
14fd6cd
feat: generate OpenAPI definitions.
Electronic-Waste Dec 16, 2024
9aeb5b0
fix(lint): remove blank lines.
Electronic-Waste Dec 16, 2024
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: 13 additions & 0 deletions hack/update-codegen.sh
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -27,3 +27,16 @@ kube::codegen::gen_client \
--with-watch \
--with-applyconfig \
"${DATABEND_OPERATOR_ROOT}/pkg/apis"

# Get the kube-openapi binary.
OPENAPI_PKG=$(go list -m -mod=readonly -f "{{.Dir}}" k8s.io/kube-openapi)
echo ">> Using ${OPENAPI_PKG}"

echo "Generating OpenAPI specification for databendlabs.io/v1alpha1"
go run ${OPENAPI_PKG}/cmd/openapi-gen \
--go-header-file "${DATABEND_OPERATOR_ROOT}/hack/boilerplate.go.txt" \
--output-pkg "${DATABEND_OPERATOR_PKG}/pkg/apis/databendlabs.io/v1alpha1" \
--output-dir "${DATABEND_OPERATOR_ROOT}/pkg/apis/databendlabs.io/v1alpha1" \
--output-file "zz_generated.openapi.go" \
--report-filename "${DATABEND_OPERATOR_ROOT}/hack/violation_exception_v1alpha1.list" \
"${DATABEND_OPERATOR_ROOT}/pkg/apis/databendlabs.io/v1alpha1"
9 changes: 9 additions & 0 deletions hack/violation_exception_v1alpha1.list
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
API rule violation: list_type_missing,github.com/databendcloud/databend-operator/pkg/apis/databendlabs.io/v1alpha1,MetaConfig,Endpoints
API rule violation: list_type_missing,github.com/databendcloud/databend-operator/pkg/apis/databendlabs.io/v1alpha1,WarehouseSpec,PodTolerations
API rule violation: names_match,github.com/databendcloud/databend-operator/pkg/apis/databendlabs.io/v1alpha1,DiskCacheSpec,MaxBytes
API rule violation: names_match,github.com/databendcloud/databend-operator/pkg/apis/databendlabs.io/v1alpha1,MetaConfig,TimeoutInSeconds
API rule violation: names_match,github.com/databendcloud/databend-operator/pkg/apis/databendlabs.io/v1alpha1,WarehouseSpec,Cache
API rule violation: names_match,github.com/databendcloud/databend-operator/pkg/apis/databendlabs.io/v1alpha1,WarehouseSpec,PodLabels
API rule violation: names_match,github.com/databendcloud/databend-operator/pkg/apis/databendlabs.io/v1alpha1,WarehouseSpec,PodResource
API rule violation: names_match,github.com/databendcloud/databend-operator/pkg/apis/databendlabs.io/v1alpha1,WarehouseSpec,PodTolerations
API rule violation: names_match,github.com/databendcloud/databend-operator/pkg/apis/databendlabs.io/v1alpha1,WarehouseStatus,Conditions
24 changes: 24 additions & 0 deletions pkg/apis/databendlabs.io/v1alpha1/doc.go
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
/*
Copyright 2024.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.
*/

// +k8s:defaulter-gen=TypeMeta
// +k8s:openapi-gen=true
// +k8s:deepcopy-gen=package

// Package v1alpha1 is the v1alpha1 version of the API.
// +groupName=databendlabs.io

package v1alpha1
Loading
Loading