Merge pull request #694 from finos/565-list-all-apps-in-appd

add an endpoint for retrieving all apps from an appD (a primary use case)
finos · May 5, 2022 · a9e10e3 · a9e10e3
2 parents b385d8c + 9400bce
commit a9e10e3
Show file tree

Hide file tree

Showing 3 changed files with 89 additions and 14 deletions.
diff --git a/docs/app-directory/spec.md b/docs/app-directory/spec.md
@@ -11,6 +11,7 @@ View the [full specification](/schemas/next/app-directory) in [OpenAPI v3.0](htt
 
  Endpoint           | Method | Description
  ------------------ | ------ | -----------
+ `/v2/apps`         | GET    | Retrieve all application definitions
  `/v2/apps`         | POST   | Create a new application definition
  `/v2/apps/{appId}` | GET    | Retrieve an application defintion
  `/v2/apps/search`  | GET    | Retrieve a list of applications

diff --git a/src/app-directory/specification/appd.yaml b/src/app-directory/specification/appd.yaml
@@ -54,8 +54,8 @@ paths:
       tags:
         - Application
   /v2/apps:
-    post:
-      summary: Create a new application definition
+    get:
+      summary: Retrieve all application definitions
       responses:
         '200':
           description: OK
@@ -66,6 +66,40 @@ paths:
               examples:
                 FDC3WorkbenchAppDefinitionSearchResponse:
                   $ref: '#/components/examples/FDC3WorkbenchAppDefinitionSearchResponse'
+        '400':
+          description: Bad request.
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/ErrorDTO'
+        '403':
+          description: >-
+            Forbidden: Certificate authentication is not allowed for the
+            requested user.
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/ErrorDTO'
+        '500':
+          description: 'Server error, see response body for further details.'
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/ErrorDTO'
+      tags:
+        - Application
+    post:
+      summary: Create a new application definition
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Application'
+              examples:
+                FDC3WorkbenchAppDefinition:
+                  $ref: '#/components/examples/FDC3WorkbenchAppDefinition'
         '400':
           description: Bad request.
           content:
@@ -207,7 +241,8 @@ paths:
         - Application
   '/v1/apps/{appId}':
     get:
-      summary: (Deprecated v1 API version) Retrieve an application definition
+      deprecated: true
+      summary: Retrieve an application definition
       parameters:
         - name: appId
           in: path
@@ -245,7 +280,8 @@ paths:
         - Application
   /v1/apps:
     post:
-      summary: (Deprecated v1 API version) Create a new application definition
+      deprecated: true
+      summary: Create a new application definition
       responses:
         '200':
           description: OK
@@ -283,7 +319,8 @@ paths:
         required: true
   /v1/apps/search:
     get:
-      summary: (Deprecated v1 API version) Retrieve a list of applications based on parameters provided.  Depending on implementation, parameter
+      deprecated: true
+      summary: Retrieve a list of applications based on parameters provided.  Depending on implementation, parameter
               values should self describe search format and type (e.g. Regex)
       parameters:
         - in: query
@@ -448,7 +485,7 @@ components:
           type: string
           pattern: '^[a-z]{2}(-[a-zA-Z0-9]{2,8}){0,1}$'
           description: >- 
-            A language tag that specifies the primary language of both 
+            A language tag that specifies the primary language of both the
             application and its AppD entry, as defined by IETF RFC 5646.
         description:
           type: string
@@ -531,7 +568,7 @@ components:
           description: >-
             The name of the company that owns the application. The publisher has
             control over their namespace/app/signature.
-       customConfig:
+        customConfig:
           type: array
           description: >-
             An optional set of name value pairs that can be used to deliver

diff --git a/website/static/schemas/next/app-directory.yaml b/website/static/schemas/next/app-directory.yaml
@@ -54,8 +54,8 @@ paths:
       tags:
         - Application
   /v2/apps:
-    post:
-      summary: Create a new application definition
+    get:
+      summary: Retrieve all application definitions
       responses:
         '200':
           description: OK
@@ -66,6 +66,40 @@ paths:
               examples:
                 FDC3WorkbenchAppDefinitionSearchResponse:
                   $ref: '#/components/examples/FDC3WorkbenchAppDefinitionSearchResponse'
+        '400':
+          description: Bad request.
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/ErrorDTO'
+        '403':
+          description: >-
+            Forbidden: Certificate authentication is not allowed for the
+            requested user.
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/ErrorDTO'
+        '500':
+          description: 'Server error, see response body for further details.'
+          content:
+            '*/*':
+              schema:
+                $ref: '#/components/schemas/ErrorDTO'
+      tags:
+        - Application
+    post:
+      summary: Create a new application definition
+      responses:
+        '200':
+          description: OK
+          content:
+            application/json:
+              schema:
+                $ref: '#/components/schemas/Application'
+              examples:
+                FDC3WorkbenchAppDefinition:
+                  $ref: '#/components/examples/FDC3WorkbenchAppDefinition'
         '400':
           description: Bad request.
           content:
@@ -207,7 +241,8 @@ paths:
         - Application
   '/v1/apps/{appId}':
     get:
-      summary: (Deprecated v1 API version) Retrieve an application definition
+      deprecated: true
+      summary: Retrieve an application definition
       parameters:
         - name: appId
           in: path
@@ -245,7 +280,8 @@ paths:
         - Application
   /v1/apps:
     post:
-      summary: (Deprecated v1 API version) Create a new application definition
+      deprecated: true
+      summary: Create a new application definition
       responses:
         '200':
           description: OK
@@ -283,7 +319,8 @@ paths:
         required: true
   /v1/apps/search:
     get:
-      summary: (Deprecated v1 API version) Retrieve a list of applications based on parameters provided.  Depending on implementation, parameter
+      deprecated: true
+      summary: Retrieve a list of applications based on parameters provided.  Depending on implementation, parameter
               values should self describe search format and type (e.g. Regex)
       parameters:
         - in: query
@@ -448,7 +485,7 @@ components:
           type: string
           pattern: '^[a-z]{2}(-[a-zA-Z0-9]{2,8}){0,1}$'
           description: >- 
-            A language tag that specifies the primary language of both 
+            A language tag that specifies the primary language of both the
             application and its AppD entry, as defined by IETF RFC 5646.
         description:
           type: string
@@ -531,7 +568,7 @@ components:
           description: >-
             The name of the company that owns the application. The publisher has
             control over their namespace/app/signature.
-       customConfig:
+        customConfig:
           type: array
           description: >-
             An optional set of name value pairs that can be used to deliver