Fixes the swagger API by copying it to a custom path

This fixes the API by copying to a custom path in container while building the image. Previously, the API used to stop working after sometime or the file would be missing in container in some cases. This could be one of the solution to fix it. but the main cause still has to be fixed. This will make the API not work locally as the file generated is in gen and API server will look at the custom path we provided. Signed-off-by: Shivam Mukhade <[email protected]>
tektoncd · Apr 27, 2021 · 613dc2c · 613dc2c
1 parent 74739cc
commit 613dc2c
Show file tree

Hide file tree

Showing 13 changed files with 30 additions and 23 deletions.
diff --git a/api/Dockerfile b/api/Dockerfile
@@ -15,8 +15,8 @@ WORKDIR /app
 COPY --from=builder /go/src/github.com/tektoncd/hub/api/api-server /app/api-server
 
 # For each new version, doc has to be copied 
-COPY gen/http/openapi3.yaml /app/gen/http/openapi3.yaml
-COPY v1/gen/http/openapi3.yaml /app/v1/gen/http/openapi3.yaml
+COPY gen/http/openapi3.json /app/docs/openapi3.json
+COPY v1/gen/http/openapi3.json /app/docs/v1/openapi3.json
 
 EXPOSE 8000
 

diff --git a/api/design/swagger.go b/api/design/swagger.go
@@ -23,7 +23,11 @@ var _ = Service("swagger", func() {
 		Path("/schema")
 	})
 
-	Files("/swagger.json", "gen/http/openapi3.yaml", func() {
+	// NOTE: The path is changed to docs/openapi3.json to make it work in container.
+	// Copying the gen as it is doesn't seems to work properly, so in dockerfile, swagger will
+	// file is copied to /docs. This will make the swagger api not work locally, as the file
+	// generated is in gen directory. 
+	Files("/swagger.json", "docs/openapi3.json", func() {
 		Description("JSON document containing the API swagger definition")
 	})
 })
diff --git a/api/gen/http/openapi.json b/api/gen/http/openapi.json
diff --git a/api/gen/http/openapi.yaml b/api/gen/http/openapi.yaml
@@ -535,7 +535,7 @@ paths:
     get:
       tags:
       - swagger
-      summary: Download gen/http/openapi3.yaml
+      summary: Download docs/openapi3.json
       description: JSON document containing the API swagger definition
       operationId: swagger#/schema/swagger.json
       responses:

diff --git a/api/gen/http/openapi3.json b/api/gen/http/openapi3.json
diff --git a/api/gen/http/openapi3.yaml b/api/gen/http/openapi3.yaml
@@ -1099,7 +1099,7 @@ paths:
     get:
       tags:
       - swagger
-      summary: Download gen/http/openapi3.yaml
+      summary: Download docs/openapi3.json
       description: JSON document containing the API swagger definition
       operationId: swagger#/schema/swagger.json
       responses:

diff --git a/api/gen/http/swagger/server/server.go b/api/gen/http/swagger/server/server.go
diff --git a/api/v1/design/swagger.go b/api/v1/design/swagger.go
@@ -22,8 +22,11 @@ var _ = Service("swagger", func() {
 	HTTP(func() {
 		Path("/v1/schema")
 	})
-
-	Files("/swagger.json", "v1/gen/http/openapi3.yaml", func() {
+	// NOTE: The path is changed to docs/v1/openapi3.json to make it work in container.
+	// Copying the gen as it is doesn't seems to work properly, so in dockerfile, swagger will
+	// file is copied to /docs. This will make the swagger api not work locally, as the file
+	// generated is in gen directory. 
+	Files("/swagger.json", "docs/v1/openapi3.json", func() {
 		Description("JSON document containing the API swagger definition")
 	})
 })
diff --git a/api/v1/gen/http/openapi.json b/api/v1/gen/http/openapi.json
diff --git a/api/v1/gen/http/openapi.yaml b/api/v1/gen/http/openapi.yaml
@@ -312,7 +312,7 @@ paths:
     get:
       tags:
       - swagger
-      summary: Download v1/gen/http/openapi3.yaml
+      summary: Download docs/v1/openapi3.json
       description: JSON document containing the API swagger definition
       operationId: swagger#/v1/schema/swagger.json
       responses:

diff --git a/api/v1/gen/http/openapi3.json b/api/v1/gen/http/openapi3.json
diff --git a/api/v1/gen/http/openapi3.yaml b/api/v1/gen/http/openapi3.yaml
@@ -722,7 +722,7 @@ paths:
     get:
       tags:
       - swagger
-      summary: Download v1/gen/http/openapi3.yaml
+      summary: Download docs/v1/openapi3.json
       description: JSON document containing the API swagger definition
       operationId: swagger#/v1/schema/swagger.json
       responses:

diff --git a/api/v1/gen/http/swagger/server/server.go b/api/v1/gen/http/swagger/server/server.go