fix: add api docs and http handler for openapi files (#1526)

* tests

* chore: set vars for platform in dockerfile

* simplyfy generate

* correct dockerfile

* add openapi to gitignore

* object files

* protos

* update protoc version

* admin only secuity missing

* texts

* start secutiry

* add handler

* add description

* add descriptions and remove adddress

* default limit

* add mapping for openapi

* generate statik for openapi

* remove address converter

* executable

* operator test

Co-authored-by: Livio Amstutz <livio.a@gmail.com>

build/dockerfile

@@ -48,7 +48,7 @@ RUN curl https://raw.githubusercontent.com/envoyproxy/protoc-gen-validate/v0.4.1
     && curl https://raw.githubusercontent.com/googleapis/googleapis/master/google/api/field_behavior.proto --create-dirs -o include/google/api/field_behavior.proto
 
 #zitadel protos
-COPY /proto/ include/.
+COPY proto/ include/.
 
 
 #######################
@@ -95,28 +95,38 @@ RUN npm run prodbuild
 #######################
 FROM golang:${GO_VERSION} as go-dep
 RUN mkdir -p src/github.com/caos/zitadel
-COPY . src/github.com/caos/zitadel/
-WORKDIR /go/src/github.com/caos/zitadel/
+# copy mod definitions
+COPY tools src/github.com/caos/zitadel/tools
+COPY ./go.* src/github.com/caos/zitadel
 
+# install all dependencies
+WORKDIR /go/src/github.com/caos/zitadel
 RUN go mod download
 RUN ./tools/install.sh
 
+FROM go-dep AS go-gen
+COPY --from=base /proto /proto
+COPY --from=base /usr/local/bin /usr/local/bin/.
+COPY build/zitadel/generate-grpc.sh build/zitadel/generate-grpc.sh
+COPY internal/protoc internal/protoc
+RUN build/zitadel/generate-grpc.sh
+
 #######################
 ## Go base build
 #######################
-FROM go-dep as go-base
-COPY --from=base /proto /proto
-COPY --from=base /usr/local/bin /usr/local/bin/.
-RUN build/zitadel/generate-grpc.sh
+FROM go-gen as go-base
+# copy all zitadel files
+COPY . .
 
 
 #######################
 ## copy for local dev
 #######################
 FROM scratch as go-copy
-COPY --from=go-base /go/src/github.com/caos/zitadel/pkg/grpc ./pkg/grpc
-COPY --from=go-base /go/src/github.com/caos/zitadel/internal/protoc/protoc-gen-authoption/templates.gen.go ./internal/protoc/protoc-gen-authoption/templates.gen.go
-COPY --from=go-base /go/src/github.com/caos/zitadel/internal/protoc/protoc-gen-authoption/authoption/options.pb.go ./internal/protoc/protoc-gen-authoption/authoption/options.pb.go
+COPY --from=go-gen /go/src/github.com/caos/zitadel/pkg/grpc ./pkg/grpc
+COPY --from=go-gen /go/src/github.com/caos/zitadel/openapi/v2/zitadel ./openapi/v2/zitadel
+COPY --from=go-gen /go/src/github.com/caos/zitadel/internal/protoc/protoc-gen-authoption/templates.gen.go ./internal/protoc/protoc-gen-authoption/templates.gen.go
+COPY --from=go-gen /go/src/github.com/caos/zitadel/internal/protoc/protoc-gen-authoption/authoption/options.pb.go ./internal/protoc/protoc-gen-authoption/authoption/options.pb.go
 
 
 #######################
@@ -149,7 +159,8 @@ RUN go get github.com/rakyll/statik \
     && ./build/console/generate-static.sh \
     && ./build/login/generate-static.sh \
     && ./build/notification/generate-static.sh \
-    && ./build/zitadel/generate-static.sh
+    && ./build/zitadel/generate-static.sh \
+    && ./build/zitadel/generate-openapi-static.sh
 RUN CGO_ENABLED=0 GOOS=linux GOARCH=${BUILDARCH} go build -a -installsuffix cgo -ldflags '-extldflags "-static"' -o zitadel-linux-${BUILDARCH} cmd/zitadel/main.go
 
 

build/zitadel/generate-grpc.sh

@@ -9,27 +9,30 @@ ZITADEL_PATH=${GOPATH}/src/github.com/caos/zitadel
 GRPC_PATH=${ZITADEL_PATH}/pkg/grpc
 PROTO_PATH=/proto/include/zitadel
 
+# generate go stub and grpc code for all files
 protoc \
   -I=/proto/include/ \
   --go_out $GOPATH/src \
   --go-grpc_out $GOPATH/src \
-  $(find ${PROTO_PATH} -iname *.proto | grep -v "management|admin|auth")
+  $(find ${PROTO_PATH} -iname *.proto)
 
+# generate authoptions code from templates
 go-bindata \
   -pkg main \
   -prefix internal/protoc/protoc-gen-authoption \
   -o ${ZITADEL_PATH}/internal/protoc/protoc-gen-authoption/templates.gen.go \
   ${ZITADEL_PATH}/internal/protoc/protoc-gen-authoption/templates
 
+# install authoption proto compiler
 go install ${ZITADEL_PATH}/internal/protoc/protoc-gen-authoption
 
 # output folder for openapi v2
 mkdir -p ${OPENAPI_PATH}
 
+# generate additional output
+
 protoc \
   -I=/proto/include \
-  --go_out ${GOPATH}/src \
-  --go-grpc_out ${GOPATH}/src \
   --grpc-gateway_out ${GOPATH}/src \
   --grpc-gateway_opt logtostderr=true \
   --openapiv2_out ${OPENAPI_PATH} \
@@ -37,13 +40,13 @@ protoc \
   --authoption_out ${GRPC_PATH}/admin \
   --validate_out=lang=go:${GOPATH}/src \
   ${PROTO_PATH}/admin.proto
+
+# authoptions are generated into the wrong folder
 mv ${ZITADEL_PATH}/pkg/grpc/admin/zitadel/* ${ZITADEL_PATH}/pkg/grpc/admin
 rm -r ${ZITADEL_PATH}/pkg/grpc/admin/zitadel
 
 protoc \
   -I=/proto/include \
-  --go_out $GOPATH/src \
-  --go-grpc_out $GOPATH/src \
   --grpc-gateway_out ${GOPATH}/src \
   --grpc-gateway_opt logtostderr=true \
   --grpc-gateway_opt allow_delete_body=true \
@@ -53,13 +56,13 @@ protoc \
   --authoption_out ${GRPC_PATH}/management \
   --validate_out=lang=go:${GOPATH}/src \
   ${PROTO_PATH}/management.proto
+
+# authoptions are generated into the wrong folder
 mv ${ZITADEL_PATH}/pkg/grpc/management/zitadel/* ${ZITADEL_PATH}/pkg/grpc/management
 rm -r ${ZITADEL_PATH}/pkg/grpc/management/zitadel
 
 protoc \
   -I=/proto/include \
-  --go_out $GOPATH/src \
-  --go-grpc_out $GOPATH/src \
   --grpc-gateway_out ${GOPATH}/src \
   --grpc-gateway_opt logtostderr=true \
   --openapiv2_out ${OPENAPI_PATH} \
@@ -67,6 +70,8 @@ protoc \
   --authoption_out=${GRPC_PATH}/auth \
   --validate_out=lang=go:${GOPATH}/src \
   ${PROTO_PATH}/auth.proto
+
+# authoptions are generated into the wrong folder
 mv ${ZITADEL_PATH}/pkg/grpc/auth/zitadel/* ${ZITADEL_PATH}/pkg/grpc/auth
 rm -r ${ZITADEL_PATH}/pkg/grpc/auth/zitadel
 

build/zitadel/generate-openapi-static.sh

@@ -0,0 +1,5 @@
+#! /bin/sh
+
+set -eux
+
+go generate openapi/statik/generate.go