add new featured institutions and services api specs (#1120)

pagopa · May 9, 2024 · cc76814 · cc76814
1 parent 3cc33bf
commit cc76814
Show file tree

Hide file tree

Showing 3 changed files with 201 additions and 1 deletion.
diff --git a/api_services_app_backend.yaml b/api_services_app_backend.yaml
@@ -84,6 +84,35 @@ paths:
           description: Bad gateway
         '504':
           description: Gateway timeout
+  /institutions/featured:
+    get:
+      tags:
+        - featured
+      summary: Retrieve featured intitutions
+      operationId: getFeaturedInstitutions
+      responses:
+        '200':
+          description: successful operation
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Institutions'
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not found
+        '500':
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ProblemJson'
+        '502':
+          description: Bad gateway
+        '504':
+          description: Gateway timeout
   /institutions/{institutionId}/services:
     get:
       tags:
@@ -146,6 +175,35 @@ paths:
           description: Bad gateway
         '504':
           description: Gateway timeout
+  /services/featured:
+    get:
+      tags:
+        - featured
+      summary: Retrieve featured services
+      operationId: getFeaturedServices
+      responses:
+        '200':
+          description: successful operation
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/FeaturedServices'
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not found
+        '500':
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ProblemJson'
+        '502':
+          description: Bad gateway
+        '504':
+          description: Gateway timeout
   /services/{serviceId}:
     get:
       tags:
@@ -319,6 +377,15 @@ components:
       allOf:
         - $ref: '#/components/schemas/FeaturedService'
         - $ref: '#/components/schemas/Institution'
+    FeaturedServices:
+      type: object
+      properties:
+        services:
+          type: array
+          items:
+            $ref: '#/components/schemas/FeaturedService'
+      required:
+        - services
     FeaturedService:
       allOf:
         - $ref: '#/components/schemas/ServiceMinified'

diff --git a/openapi/api_services_app_backend.template.yaml b/openapi/api_services_app_backend.template.yaml
@@ -77,6 +77,35 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/ProblemJson"
+  /institutions/featured:
+    get:
+      tags:
+        - featured
+      summary: Retrieve featured intitutions
+      operationId: getFeaturedInstitutions
+      responses:
+        '200':
+          description: successful operation
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Institutions'
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not found
+        '500':
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ProblemJson'
+        '502':
+          description: Bad gateway
+        '504':
+          description: Gateway timeout
   /institutions/{institutionId}/services:
     get:
       tags:
@@ -132,6 +161,35 @@ paths:
             application/json:
               schema:
                 $ref: "#/components/schemas/ProblemJson"
+  /services/featured:
+    get:
+      tags:
+        - featured
+      summary: Retrieve featured services
+      operationId: getFeaturedServices
+      responses:
+        '200':
+          description: successful operation
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/FeaturedServices'
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not found
+        '500':
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ProblemJson'
+        '502':
+          description: Bad gateway
+        '504':
+          description: Gateway timeout
   /services/{serviceId}:
     get:
       tags:
@@ -204,7 +262,6 @@ components:
       type: apiKey
       name: Authorization
       in: header
-
   schemas:
     InstitutionsResource:
       allOf:
@@ -306,6 +363,15 @@ components:
       allOf:
         - $ref: "#/components/schemas/FeaturedService"
         - $ref: "#/components/schemas/Institution"
+    FeaturedServices:
+      type: object
+      properties:
+        services:
+          type: array
+          items:
+            $ref: '#/components/schemas/FeaturedService'
+      required:
+        - services
     FeaturedService:
       allOf:
         - $ref: '#/components/schemas/ServiceMinified'

diff --git a/openapi/generated/api_services_app_backend.yaml b/openapi/generated/api_services_app_backend.yaml
@@ -84,6 +84,35 @@ paths:
           description: Bad gateway
         '504':
           description: Gateway timeout
+  /institutions/featured:
+    get:
+      tags:
+        - featured
+      summary: Retrieve featured intitutions
+      operationId: getFeaturedInstitutions
+      responses:
+        '200':
+          description: successful operation
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Institutions'
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not found
+        '500':
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ProblemJson'
+        '502':
+          description: Bad gateway
+        '504':
+          description: Gateway timeout
   /institutions/{institutionId}/services:
     get:
       tags:
@@ -146,6 +175,35 @@ paths:
           description: Bad gateway
         '504':
           description: Gateway timeout
+  /services/featured:
+    get:
+      tags:
+        - featured
+      summary: Retrieve featured services
+      operationId: getFeaturedServices
+      responses:
+        '200':
+          description: successful operation
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/FeaturedServices'
+        '401':
+          description: Unauthorized
+        '403':
+          description: Forbidden
+        '404':
+          description: Not found
+        '500':
+          description: Internal Server Error
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/ProblemJson'
+        '502':
+          description: Bad gateway
+        '504':
+          description: Gateway timeout
   /services/{serviceId}:
     get:
       tags:
@@ -319,6 +377,15 @@ components:
       allOf:
         - $ref: '#/components/schemas/FeaturedService'
         - $ref: '#/components/schemas/Institution'
+    FeaturedServices:
+      type: object
+      properties:
+        services:
+          type: array
+          items:
+            $ref: '#/components/schemas/FeaturedService'
+      required:
+        - services
     FeaturedService:
       allOf:
         - $ref: '#/components/schemas/ServiceMinified'