Make sure template REST API is in sync with GRPC (#130)

* make sure template REST API is in sync with GRPC

* Borrow template id

* Update Open API spec

* Fix path for upload

* Fix Spec

* Rearrange methods

* Generate new spec

* Update endpoint

* Fix versions

* Fix integration tests

Author: afsalthaj

golem-cli

@@ -111,16 +111,11 @@ pub struct TemplateApi {
 
 #[OpenApi(prefix_path = "/v2/templates", tag = ApiTags::Template)]
 impl TemplateApi {
-    #[oai(
-        path = "/:template_id",
-        method = "get",
-        operation_id = "get_template_by_id"
-    )]
-    async fn get_template_by_id(
-        &self,
-        template_id: Path<TemplateId>,
-    ) -> Result<Json<Vec<Template>>> {
-        let response = self.template_service.get(&template_id.0).await?;
+    #[oai(path = "/", method = "post", operation_id = "create_template")]
+    async fn create_template(&self, payload: UploadPayload) -> Result<Json<Template>> {
+        let data = payload.template.into_vec().await?;
+        let template_name = payload.name;
+        let response = self.template_service.create(&template_name, data).await?;
         Ok(Json(response))
     }
 
@@ -139,14 +134,6 @@ impl TemplateApi {
         Ok(Json(response))
     }
 
-    #[oai(path = "/", method = "post", operation_id = "upload_template")]
-    async fn upload_template(&self, payload: UploadPayload) -> Result<Json<Template>> {
-        let data = payload.template.into_vec().await?;
-        let template_name = payload.name;
-        let response = self.template_service.create(&template_name, data).await?;
-        Ok(Json(response))
-    }
-
     #[oai(
         path = "/:template_id/download",
         method = "get",
@@ -164,12 +151,65 @@ impl TemplateApi {
         Ok(Binary(Body::from(bytes)))
     }
 
+    #[oai(
+        path = "/:template_id",
+        method = "get",
+        operation_id = "get_template_metadata_all_versions"
+    )]
+    async fn get_template_metadata_all_versions(
+        &self,
+        template_id: Path<TemplateId>,
+    ) -> Result<Json<Vec<Template>>> {
+        let response = self.template_service.get(&template_id.0).await?;
+        Ok(Json(response))
+    }
+
+    #[oai(
+        path = "/:template_id/versions/:version",
+        method = "get",
+        operation_id = "get_template_metadata"
+    )]
+    async fn get_template_metadata(
+        &self,
+        #[oai(name = "template_id")] template_id: Path<TemplateId>,
+        #[oai(name = "version")] version: Path<String>,
+    ) -> Result<Json<Template>> {
+        let version_int = match version.0.parse::<i32>() {
+            Ok(v) => v,
+            Err(_) => {
+                return Err(TemplateError::BadRequest(Json(ErrorsBody {
+                    errors: vec!["Invalid version".to_string()],
+                })))
+            }
+        };
+
+        let versioned_template_id = VersionedTemplateId {
+            template_id: template_id.0,
+            version: version_int,
+        };
+
+        let response = self
+            .template_service
+            .get_by_version(&versioned_template_id)
+            .await?;
+
+        match response {
+            Some(template) => Ok(Json(template)),
+            None => Err(TemplateError::NotFound(Json(ErrorBody {
+                error: "Template not found".to_string(),
+            }))),
+        }
+    }
+
     #[oai(
         path = "/:template_id/latest",
         method = "get",
-        operation_id = "get_latest_version"
+        operation_id = "get_latest_template_version"
     )]
-    async fn get_latest_version(&self, template_id: Path<TemplateId>) -> Result<Json<i32>> {
+    async fn get_latest_template_version(
+        &self,
+        template_id: Path<TemplateId>,
+    ) -> Result<Json<i32>> {
         let response = self
             .template_service
             .get_latest_version(&template_id.0)
@@ -183,8 +223,8 @@ impl TemplateApi {
         }
     }
 
-    #[oai(path = "/", method = "get", operation_id = "get_all_templates")]
-    async fn get_all_templates(
+    #[oai(path = "/", method = "get", operation_id = "get_templates")]
+    async fn get_templates(
         &self,
         #[oai(name = "template-name")] template_name: Query<Option<TemplateName>>,
     ) -> Result<Json<Vec<Template>>> {

golem-template-service/src/api/template.rs

@@ -9,17 +9,78 @@ tags:
 - name: Template
 - name: Worker
 paths:
-  /v2/templates/{template_id}:
+  /v2/templates:
+    post:
+      tags:
+      - Template
+      requestBody:
+        content:
+          multipart/form-data:
+            schema:
+              type: object
+              required:
+              - name
+              - template
+              properties:
+                name:
+                  type: string
+                template:
+                  type: string
+                  format: binary
+        required: true
+      responses:
+        '200':
+          description: ''
+          content:
+            application/json; charset=utf-8:
+              schema:
+                $ref: '#/components/schemas/Template'
+        '400':
+          description: ''
+          content:
+            application/json; charset=utf-8:
+              schema:
+                $ref: '#/components/schemas/ErrorsBody'
+        '401':
+          description: ''
+          content:
+            application/json; charset=utf-8:
+              schema:
+                $ref: '#/components/schemas/ErrorBody'
+        '403':
+          description: ''
+          content:
+            application/json; charset=utf-8:
+              schema:
+                $ref: '#/components/schemas/ErrorBody'
+        '404':
+          description: ''
+          content:
+            application/json; charset=utf-8:
+              schema:
+                $ref: '#/components/schemas/ErrorBody'
+        '409':
+          description: ''
+          content:
+            application/json; charset=utf-8:
+              schema:
+                $ref: '#/components/schemas/ErrorBody'
+        '500':
+          description: ''
+          content:
+            application/json; charset=utf-8:
+              schema:
+                $ref: '#/components/schemas/ErrorBody'
+      operationId: create_template
     get:
       tags:
       - Template
       parameters:
-      - name: template_id
+      - name: template-name
         schema:
           type: string
-          format: uuid
-        in: path
-        required: true
+        in: query
+        required: false
         deprecated: false
         explode: true
       responses:
@@ -67,7 +128,7 @@ paths:
             application/json; charset=utf-8:
               schema:
                 $ref: '#/components/schemas/ErrorBody'
-      operationId: get_template_by_id
+      operationId: get_templates
   /v2/templates/{template_id}/upload:
     put:
       tags:
@@ -132,32 +193,35 @@ paths:
               schema:
                 $ref: '#/components/schemas/ErrorBody'
       operationId: update_template
-  /v2/templates:
-    post:
+  /v2/templates/{template_id}/download:
+    get:
       tags:
       - Template
-      requestBody:
-        content:
-          multipart/form-data:
-            schema:
-              type: object
-              required:
-              - name
-              - template
-              properties:
-                name:
-                  type: string
-                template:
-                  type: string
-                  format: binary
+      parameters:
+      - name: template_id
+        schema:
+          type: string
+          format: uuid
+        in: path
         required: true
+        deprecated: false
+        explode: true
+      - name: version
+        schema:
+          type: integer
+          format: int32
+        in: query
+        required: false
+        deprecated: false
+        explode: true
       responses:
         '200':
           description: ''
           content:
-            application/json; charset=utf-8:
+            application/octet-stream:
               schema:
-                $ref: '#/components/schemas/Template'
+                type: string
+                format: binary
         '400':
           description: ''
           content:
@@ -194,16 +258,18 @@ paths:
             application/json; charset=utf-8:
               schema:
                 $ref: '#/components/schemas/ErrorBody'
-      operationId: upload_template
+      operationId: download_template
+  /v2/templates/{template_id}:
     get:
       tags:
       - Template
       parameters:
-      - name: template-name
+      - name: template_id
         schema:
           type: string
-        in: query
-        required: false
+          format: uuid
+        in: path
+        required: true
         deprecated: false
         explode: true
       responses:
@@ -251,8 +317,8 @@ paths:
             application/json; charset=utf-8:
               schema:
                 $ref: '#/components/schemas/ErrorBody'
-      operationId: get_all_templates
-  /v2/templates/{template_id}/download:
+      operationId: get_template_metadata_all_versions
+  /v2/templates/{template_id}/versions/{version}:
     get:
       tags:
       - Template
@@ -267,20 +333,18 @@ paths:
         explode: true
       - name: version
         schema:
-          type: integer
-          format: int32
-        in: query
-        required: false
+          type: string
+        in: path
+        required: true
         deprecated: false
         explode: true
       responses:
         '200':
           description: ''
           content:
-            application/octet-stream:
+            application/json; charset=utf-8:
               schema:
-                type: string
-                format: binary
+                $ref: '#/components/schemas/Template'
         '400':
           description: ''
           content:
@@ -317,7 +381,7 @@ paths:
             application/json; charset=utf-8:
               schema:
                 $ref: '#/components/schemas/ErrorBody'
-      operationId: download_template
+      operationId: get_template_metadata
   /v2/templates/{template_id}/latest:
     get:
       tags:
@@ -375,7 +439,7 @@ paths:
             application/json; charset=utf-8:
               schema:
                 $ref: '#/components/schemas/ErrorBody'
-      operationId: get_latest_version
+      operationId: get_latest_template_version
   /v2/templates/workers/{worker_id}:
     get:
       tags: