Merge pull request #136 from mihaelabalutoiu/add-more-swagger-client-api

Add more functionality to swagger client library
cloudbase · Jul 18, 2023 · 91dd082 · 91dd082
2 parents 8089244 + 520f468
commit 91dd082
Show file tree

Hide file tree

Showing 11 changed files with 853 additions and 0 deletions.
diff --git a/apiserver/controllers/controllers.go b/apiserver/controllers/controllers.go
@@ -202,6 +202,13 @@ func (a *APIController) NotFoundHandler(w http.ResponseWriter, r *http.Request)
 	}
 }
 
+// swagger:route GET /metrics-token metrics-token MetricsToken
+//
+// Returns a JWT token that can be used to access the metrics endpoint.
+//
+//	Responses:
+//	  200: JWTResponse
+//	  401: APIErrorResponse
 func (a *APIController) MetricsTokenHandler(w http.ResponseWriter, r *http.Request) {
 	ctx := r.Context()
 
@@ -350,6 +357,13 @@ func (a *APIController) ListProviders(w http.ResponseWriter, r *http.Request) {
 	}
 }
 
+// swagger:route GET /jobs jobs ListJobs
+//
+// List all jobs.
+//
+//	Responses:
+//	  200: Jobs
+//	  400: APIErrorResponse
 func (a *APIController) ListAllJobs(w http.ResponseWriter, r *http.Request) {
 	ctx := r.Context()
 	jobs, err := a.r.ListAllJobs(ctx)

diff --git a/apiserver/swagger-models.yaml b/apiserver/swagger-models.yaml
@@ -29,6 +29,22 @@ definitions:
         import:
             package: github.com/cloudbase/garm/params
             alias: garm_params
+  Jobs:
+    type: array
+    x-go-type:
+        type: Jobs
+        import:
+            package: github.com/cloudbase/garm/params
+            alias: garm_params
+    items:
+        $ref: '#/definitions/Job'
+  Job: 
+    type: object
+    x-go-type:
+        type: Job
+        import:
+            package: github.com/cloudbase/garm/params
+            alias: garm_params
   Credentials:
     type: array
     x-go-type:

diff --git a/apiserver/swagger.yaml b/apiserver/swagger.yaml
@@ -69,6 +69,22 @@ definitions:
                 alias: garm_params
                 package: github.com/cloudbase/garm/params
             type: JWTResponse
+    Job:
+        type: object
+        x-go-type:
+            import:
+                alias: garm_params
+                package: github.com/cloudbase/garm/params
+            type: Job
+    Jobs:
+        items:
+            $ref: '#/definitions/Job'
+        type: array
+        x-go-type:
+            import:
+                alias: garm_params
+                package: github.com/cloudbase/garm/params
+            type: Jobs
     NewUserParams:
         type: object
         x-go-type:
@@ -291,6 +307,36 @@ paths:
             summary: Get runner instance by name.
             tags:
                 - instances
+    /jobs:
+        get:
+            operationId: ListJobs
+            responses:
+                "200":
+                    description: Jobs
+                    schema:
+                        $ref: '#/definitions/Jobs'
+                "400":
+                    description: APIErrorResponse
+                    schema:
+                        $ref: '#/definitions/APIErrorResponse'
+            summary: List all jobs.
+            tags:
+                - jobs
+    /metrics-token:
+        get:
+            operationId: MetricsToken
+            responses:
+                "200":
+                    description: JWTResponse
+                    schema:
+                        $ref: '#/definitions/JWTResponse'
+                "401":
+                    description: APIErrorResponse
+                    schema:
+                        $ref: '#/definitions/APIErrorResponse'
+            summary: Returns a JWT token that can be used to access the metrics endpoint.
+            tags:
+                - metrics-token
     /organizations:
         get:
             operationId: ListOrgs

diff --git a/client/garm_api_client.go b/client/garm_api_client.go
diff --git a/client/jobs/jobs_client.go b/client/jobs/jobs_client.go
diff --git a/client/jobs/list_jobs_parameters.go b/client/jobs/list_jobs_parameters.go