rename interopMeta -> interop in appD schema

finos · Jun 6, 2022 · acdca74 · acdca74
1 parent 2327de5
commit acdca74
Show file tree

Hide file tree

Showing 3 changed files with 13 additions and 13 deletions.
diff --git a/CHANGELOG.md b/CHANGELOG.md
@@ -62,7 +62,7 @@ The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 * 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))
 * Extended Intent Naming conventions and added hyperlinks for existing Intent spec definitions ([#701](https://github.com/finos/FDC3/pull/701))
 * Extended recommended field type conventions for contexts to include types for ids, times, dates, currency codes and country codes. The `fdc3.country` context type was updated to comply with the recommended field name for country codes (`COUNTRY_ISOALPHA2`). ([#704](https://github.com/finos/FDC3/pull/704))
-* The intents field of an AppD application records has been replaced with the `interop` field, to more fully describe an app's use of FDC3 and enable search for apps that 'interoperate' with a selected app ([#697](https://github.com/finos/FDC3/pull/697))
+* The `intents` field of an AppD application records has been replaced with the `interop` field, to more fully describe an app's use of FDC3 and enable search for apps that 'interoperate' with a selected app ([#697](https://github.com/finos/FDC3/pull/697))
 
 ### Deprecated
 

diff --git a/src/app-directory/specification/appd.yaml b/src/app-directory/specification/appd.yaml
@@ -424,8 +424,8 @@ components:
             $ref: '#/components/schemas/NameValuePair'
         hostManifests:
           $ref: '#/components/schemas/HostManifests'
-        interopMeta:
-          $ref: '#/components/schemas/InteropMeta'
+        interop:
+          $ref: '#/components/schemas/Interop'
     Application:
       description: >
         Defines an application retrieved from an FDC3 App Directory, which can
@@ -627,7 +627,7 @@ components:
           description: >-
             Custom configuration for the intent that may be required for a
             particular desktop agent.
-    InteropMeta:
+    Interop:
       type: object
       description: |
         Metadata that describes how the application uses FDC3 APIs. This metadata serves multiple purposes:
@@ -647,7 +647,7 @@ components:
                 A mapping of Intents names that an app listens for via `fdc3.addIntentListener()` to their 
                 configuration. 
                 
-                Used to support intent resolution by desktop agents.
+                Used to support intent resolution by desktop agents. Replaces the `intents` element used in appD records prior to FDC3 2.0. 
               additionalProperties:
                 x-additionalPropertiesName: Intent name
                 items:
@@ -1025,7 +1025,7 @@ components:
           },
           Web App Manifest: http://example.domain.com/my-app.json
         }
-        interopMeta:
+        interop:
           intents: 
             listensFor: 
               ViewChart: 
@@ -1140,7 +1140,7 @@ components:
               },
               Web App Manifest: http://example.domain.com/my-app.json
             }
-            interopMeta:
+            interop:
               intents: 
                 listensFor: 
                   ViewChart: 

diff --git a/website/static/schemas/next/app-directory.yaml b/website/static/schemas/next/app-directory.yaml
@@ -424,8 +424,8 @@ components:
             $ref: '#/components/schemas/NameValuePair'
         hostManifests:
           $ref: '#/components/schemas/HostManifests'
-        interopMeta:
-          $ref: '#/components/schemas/InteropMeta'
+        interop:
+          $ref: '#/components/schemas/Interop'
     Application:
       description: >
         Defines an application retrieved from an FDC3 App Directory, which can
@@ -627,7 +627,7 @@ components:
           description: >-
             Custom configuration for the intent that may be required for a
             particular desktop agent.
-    InteropMeta:
+    Interop:
       type: object
       description: |
         Metadata that describes how the application uses FDC3 APIs. This metadata serves multiple purposes:
@@ -647,7 +647,7 @@ components:
                 A mapping of Intents names that an app listens for via `fdc3.addIntentListener()` to their 
                 configuration. 
                 
-                Used to support intent resolution by desktop agents.
+                Used to support intent resolution by desktop agents. Replaces the `intents` element used in appD records prior to FDC3 2.0. 
               additionalProperties:
                 x-additionalPropertiesName: Intent name
                 items:
@@ -1025,7 +1025,7 @@ components:
           },
           Web App Manifest: http://example.domain.com/my-app.json
         }
-        interopMeta:
+        interop:
           intents: 
             listensFor: 
               ViewChart: 
@@ -1140,7 +1140,7 @@ components:
               },
               Web App Manifest: http://example.domain.com/my-app.json
             }
-            interopMeta:
+            interop:
               intents: 
                 listensFor: 
                   ViewChart: