Merge pull request #696 from finos/370-remove-appd-search-endpoint

370 remove appD search application endpoint
finos · May 16, 2022 · 704603b · 704603b
2 parents 1339c60 + 70d33c2
commit 704603b
Show file tree

Hide file tree

Showing 4 changed files with 14 additions and 229 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -40,6 +40,8 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 * All DesktopAgent and Channel API functions are now async for consistency, changing the return type of the `broadcast`, `addIntentListener`, `addContextListener` and `getInfo` functions ([#516](https://github.com/finos/FDC3/pull/516))
 * App Directory `images` field was replaced with `screenshots` to better align the application record with web application manifest and match its format to that used by `icons` ([#675](https://github.com/finos/FDC3/pull/675))
 * App Directory endpoint for creating applications was removed as these will often be implementation dependent and should not be required for compliance ([#695](https://github.com/finos/FDC3/pull/695))
+* App Directory endpoint for searching applications was removed as searches over multiple app directories are better implemented by retrieving all the records and searching over the resulting combined dataset ([#696](https://github.com/finos/FDC3/pull/696))
+
 
 ### Deprecated
 * Removed details of the 'global' channel that was deprecated in FDC3 1.2. ([#496](https://github.com/finos/FDC3/pull/496))

diff --git a/docs/app-directory/spec.md b/docs/app-directory/spec.md
@@ -13,7 +13,6 @@ View the [full specification](/schemas/next/app-directory) in [OpenAPI v3.0](htt
  ------------------ | ------ | -----------
  `/v2/apps`         | GET    | Retrieve all application definitions
  `/v2/apps/{appId}` | GET    | Retrieve an application defintion
- `/v2/apps/search`  | GET    | Retrieve a list of applications
  `/v1/apps`         | POST   | (deprecated v1 API version) Create a new application definition
  `/v1/apps/{appId}` | GET    | (deprecated v1 API version) Retrieve an application defintion
  `/v1/apps/search`  | GET    | (deprecated v1 API version) Retrieve a list of applications

diff --git a/src/app-directory/specification/appd.yaml b/src/app-directory/specification/appd.yaml
@@ -62,10 +62,10 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/ApplicationSearchResponse'
+                $ref: '#/components/schemas/AllApplicationsResponse'
               examples:
-                FDC3WorkbenchAppDefinitionSearchResponse:
-                  $ref: '#/components/examples/FDC3WorkbenchAppDefinitionSearchResponse'
+                FDC3WorkbenchAppDefinitionAllAppsResponse:
+                  $ref: '#/components/examples/FDC3WorkbenchAppDefinitionAllAppsResponse'
         '400':
           description: Bad request.
           content:
@@ -88,114 +88,6 @@ paths:
                 $ref: '#/components/schemas/ErrorDTO'
       tags:
         - Application
-  /v2/apps/search:
-    get:
-      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
-          name: appId
-          schema:
-            type: string
-          required: false
-          description: >
-            The unique application identifier located within a specific
-            application directory instance.
-        - in: query
-          name: name
-          schema:
-            type: string
-          required: false
-          description: >
-            The name of the application.
-
-            The name should be unique within an FDC3 App Directory instance. The
-            exception to the uniqueness constraint is that an App Directory can
-            hold definitions for multiple versions of the same app.
-
-            The same appName could occur in other directories. We are not
-            currently specifying app name conventions in the document.
-        - in: query
-          name: version
-          schema:
-            type: string
-          required: false
-          description: >-
-            Version of the application. This allows multiple app versions to be
-            defined using the same app name. This can be a triplet but can also
-            include things like 1.2.5 (BETA)
-        - in: query
-          name: title
-          schema:
-            type: string
-          required: false
-          description: >-
-            Optional title for the application, if missing use appName,
-            typically used in a launcher UI.
-        - in: query
-          name: tooltip
-          schema:
-            type: string
-          required: false
-          description: Optional tooltip description e.g. for a launcher
-        - in: query
-          name: description
-          schema:
-            type: string
-          required: false
-          description: >-
-            Description of the application. This will typically be a 1-2
-            paragraph style blurb about the application. Allow mark up language
-        - in: query
-          name: intent_name
-          schema:
-            type: string
-          required: false
-          description: name of intent
-        - in: query
-          name: intent_displayName
-          schema:
-            type: string
-          required: false
-          description: displayName of intent
-        - in: query
-          name: intent_context
-          schema:
-            type: string
-          required: false
-          description: search contexts list
-      responses:
-        '200':
-          description: OK
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/ApplicationSearchResponse'
-              examples:
-                FDC3WorkbenchAppDefinitionSearchResponse:
-                  $ref: '#/components/examples/FDC3WorkbenchAppDefinitionSearchResponse'
-        '400':
-          description: Bad request.
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/ErrorDTO'
-        '403':
-          description: >-
-            Forbidden: Certificate authentication is not allowed for the
-            requested user.
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/ErrorDTO'
-        '500':
-          description: 'Server error, see response body for further details.'
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/ErrorDTO'
-      tags:
-        - Application
   '/v1/apps/{appId}':
     get:
       deprecated: true
@@ -658,7 +550,7 @@ components:
             https://github.com/FDC3/Intents/blob/master/src/Intent.yaml
           items:
             $ref: '#/components/schemas/IntentV1'
-    ApplicationSearchResponse:
+    AllApplicationsResponse:
       properties:
         applications:
           type: array
@@ -919,7 +811,7 @@ components:
           }
         }
       summary: A sample app definition for the FDC3 Workbench application
-    FDC3WorkbenchAppDefinitionSearchResponse:
+    FDC3WorkbenchAppDefinitionAllAppsResponse:
       value:
         applications: # you can't $ref inside a $ref so example is repeated here for search response
           - appId: fdc3-workbench
@@ -1003,4 +895,4 @@ components:
               }
             }
         message: OK
-      summary: A sample application search response containing the FDC3 Workbench application
+      summary: A sample 'all applications' listing response containing the FDC3 Workbench application
diff --git a/website/static/schemas/next/app-directory.yaml b/website/static/schemas/next/app-directory.yaml
@@ -62,10 +62,10 @@ paths:
           content:
             application/json:
               schema:
-                $ref: '#/components/schemas/ApplicationSearchResponse'
+                $ref: '#/components/schemas/AllApplicationsResponse'
               examples:
-                FDC3WorkbenchAppDefinitionSearchResponse:
-                  $ref: '#/components/examples/FDC3WorkbenchAppDefinitionSearchResponse'
+                FDC3WorkbenchAppDefinitionAllAppsResponse:
+                  $ref: '#/components/examples/FDC3WorkbenchAppDefinitionAllAppsResponse'
         '400':
           description: Bad request.
           content:
@@ -88,114 +88,6 @@ paths:
                 $ref: '#/components/schemas/ErrorDTO'
       tags:
         - Application
-  /v2/apps/search:
-    get:
-      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
-          name: appId
-          schema:
-            type: string
-          required: false
-          description: >
-            The unique application identifier located within a specific
-            application directory instance.
-        - in: query
-          name: name
-          schema:
-            type: string
-          required: false
-          description: >
-            The name of the application.
-
-            The name should be unique within an FDC3 App Directory instance. The
-            exception to the uniqueness constraint is that an App Directory can
-            hold definitions for multiple versions of the same app.
-
-            The same appName could occur in other directories. We are not
-            currently specifying app name conventions in the document.
-        - in: query
-          name: version
-          schema:
-            type: string
-          required: false
-          description: >-
-            Version of the application. This allows multiple app versions to be
-            defined using the same app name. This can be a triplet but can also
-            include things like 1.2.5 (BETA)
-        - in: query
-          name: title
-          schema:
-            type: string
-          required: false
-          description: >-
-            Optional title for the application, if missing use appName,
-            typically used in a launcher UI.
-        - in: query
-          name: tooltip
-          schema:
-            type: string
-          required: false
-          description: Optional tooltip description e.g. for a launcher
-        - in: query
-          name: description
-          schema:
-            type: string
-          required: false
-          description: >-
-            Description of the application. This will typically be a 1-2
-            paragraph style blurb about the application. Allow mark up language
-        - in: query
-          name: intent_name
-          schema:
-            type: string
-          required: false
-          description: name of intent
-        - in: query
-          name: intent_displayName
-          schema:
-            type: string
-          required: false
-          description: displayName of intent
-        - in: query
-          name: intent_context
-          schema:
-            type: string
-          required: false
-          description: search contexts list
-      responses:
-        '200':
-          description: OK
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/ApplicationSearchResponse'
-              examples:
-                FDC3WorkbenchAppDefinitionSearchResponse:
-                  $ref: '#/components/examples/FDC3WorkbenchAppDefinitionSearchResponse'
-        '400':
-          description: Bad request.
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/ErrorDTO'
-        '403':
-          description: >-
-            Forbidden: Certificate authentication is not allowed for the
-            requested user.
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/ErrorDTO'
-        '500':
-          description: 'Server error, see response body for further details.'
-          content:
-            application/json:
-              schema:
-                $ref: '#/components/schemas/ErrorDTO'
-      tags:
-        - Application
   '/v1/apps/{appId}':
     get:
       deprecated: true
@@ -658,7 +550,7 @@ components:
             https://github.com/FDC3/Intents/blob/master/src/Intent.yaml
           items:
             $ref: '#/components/schemas/IntentV1'
-    ApplicationSearchResponse:
+    AllApplicationsResponse:
       properties:
         applications:
           type: array
@@ -919,7 +811,7 @@ components:
           }
         }
       summary: A sample app definition for the FDC3 Workbench application
-    FDC3WorkbenchAppDefinitionSearchResponse:
+    FDC3WorkbenchAppDefinitionAllAppsResponse:
       value:
         applications: # you can't $ref inside a $ref so example is repeated here for search response
           - appId: fdc3-workbench
@@ -1003,4 +895,4 @@ components:
               }
             }
         message: OK
-      summary: A sample application search response containing the FDC3 Workbench application
+      summary: A sample 'all applications' listing response containing the FDC3 Workbench application