Analytic index additions (#89)

* Update ems-api.json for the changes * Include the ignoreIndex query parameter * Update release info
ge-flight-analytics · Feb 7, 2024 · c353129 · c353129
1 parent 2b03f7e
commit c353129
Show file tree

Hide file tree

Showing 5 changed files with 16,140 additions and 16,102 deletions.
diff --git a/ReleaseNotes.md b/ReleaseNotes.md
@@ -1,2 +1,3 @@
-# Release 2.19.0
-* Adds support for the Export Analytic Service Reprocess route.
+# Release 2.20.0
+* Adds analytic path properties.
+* Adds the ignoreIndex optional property for getting analytic groups.
diff --git a/src/Client/V2/Access/AnalyticsAccess.cs b/src/Client/V2/Access/AnalyticsAccess.cs
@@ -73,7 +73,7 @@ public virtual IEnumerable<AnalyticInfo> Search( string text, string groupId = n
         /// </param>
         /// <param name="maxResults">
         /// The optional maximum number of matching results to return. If not specified, a default value of 200
-        /// is used. Use 0 to return all results.
+        /// is used. Use 0 to return the maximum of 1000 results.
         /// </param>
         /// <param name="category">
         /// The category of analytics to search, including "Full", "Physical" or "Logical". A null value specifies
@@ -101,7 +101,7 @@ public virtual Task<IEnumerable<AnalyticInfo>> SearchAsync( int flightId, string
         /// </param>
         /// <param name="maxResults">
         /// The optional maximum number of matching results to return. If not specified, a default value of 200
-        /// is used. Use 0 to return all results.
+        /// is used. Use 0 to return the maximum of 1000 results.
         /// </param>
         /// <param name="category">
         /// The category of analytics to search, including "Full", "Physical" or "Logical". A null value specifies
@@ -192,12 +192,15 @@ public virtual AnalyticInfo GetInfo( int flightId, string analyticId, CallContex
         /// <param name="includeMetadata">
         /// When true, metadata will be returned along with analytic items.
         /// </param>
+        /// <param name="ignoreIndex">
+        /// When true, the API will not attempt to use a pre-built index to answer the request.
+        /// </param>
         /// <param name="context">
         /// The optional call context to include.
         /// </param>
-        public virtual Task<AnalyticGroupContents> GetGroupAsync( string analyticGroupId = null, Category category = Category.Full, bool includeMetadata = false, CallContext context = null )
+        public virtual Task<AnalyticGroupContents> GetGroupAsync( string analyticGroupId = null, Category category = Category.Full, bool includeMetadata = false, bool ignoreIndex = false, CallContext context = null )
         {
-            return CallApiTask( api => api.GetAnalyticGroup( analyticGroupId, category, includeMetadata, context ) );
+            return CallApiTask( api => api.GetAnalyticGroup( analyticGroupId, category, includeMetadata, ignoreIndex, context ) );
         }
 
         /// <summary>
@@ -213,12 +216,15 @@ public virtual Task<AnalyticGroupContents> GetGroupAsync( string analyticGroupId
         /// <param name="includeMetadata">
         /// When true, metadata will be returned along with analytic items.
         /// </param>
+        /// <param name="ignoreIndex">
+        /// When true, the API will not attempt to use a pre-built index to answer the request.
+        /// </param>
         /// <param name="context">
         /// The optional call context to include.
         /// </param>
-        public virtual AnalyticGroupContents GetGroup( string analyticGroupId = null, Category category = Category.Full, bool includeMetadata = false, CallContext context = null )
+        public virtual AnalyticGroupContents GetGroup( string analyticGroupId = null, Category category = Category.Full, bool includeMetadata = false, bool ignoreIndex = false, CallContext context = null )
         {
-            return AccessTaskResult( GetGroupAsync( analyticGroupId, category, includeMetadata, context ) );
+            return AccessTaskResult( GetGroupAsync( analyticGroupId, category, includeMetadata, ignoreIndex, context ) );
         }
 
         /// <summary>

diff --git a/src/Client/V2/IEmsApi.cs b/src/Client/V2/IEmsApi.cs
@@ -253,7 +253,7 @@ public interface IEmsApi
         /// </param>
         /// <param name="maxResults">
         /// The optional maximum number of matching results to return. If not specified, a default value of 200
-        /// is used. Use 0 to return all results.
+        /// is used. Use 0 to return the maximum of 1000 results.
         /// </param>
         /// <param name="category">
         /// The category of analytics to search, including "Full", "Physical" or "Logical". A null value specifies
@@ -319,8 +319,11 @@ public interface IEmsApi
         /// <param name="includeMetadata">
         /// When true, metadata will be returned along with analytic items.
         /// </param>
+        /// <param name="ignoreIndex">
+        /// When true, the API will not attempt to use a pre-built index to answer the request.
+        /// </param>
         [Get( "/v2/ems-systems/1/analytic-groups" )]
-        Task<AnalyticGroupContents> GetAnalyticGroup( string analyticGroupId = null, Category category = Category.Full, bool includeMetadata = false, [Property] CallContext context = null );
+        Task<AnalyticGroupContents> GetAnalyticGroup( string analyticGroupId = null, Category category = Category.Full, bool includeMetadata = false, bool ignoreIndex = false, [Property] CallContext context = null );
 
         /// <summary>
         /// Retrieves the contents of an analytic group, which is a hierarchical tree structure used to organize analytics.

diff --git a/src/Directory.Build.props b/src/Directory.Build.props
@@ -1,13 +1,13 @@
-<Project>
-    <PropertyGroup>
-        <VersionPrefix>2.19.0</VersionPrefix>
-        <VersionSuffix>prerelease</VersionSuffix>
-        <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
-        <IncludeSymbols>true</IncludeSymbols>
-        <EmbedAllSources>true</EmbedAllSources>
-        <DebugType>portable</DebugType>
-        <SymbolPackageFormat>snupkg</SymbolPackageFormat>
-        <Authors>c-owens</Authors>
-        <LangVersion>10</LangVersion>
-    </PropertyGroup>
+<Project>
+    <PropertyGroup>
+        <VersionPrefix>2.20.0</VersionPrefix>
+        <VersionSuffix>prerelease</VersionSuffix>
+        <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
+        <IncludeSymbols>true</IncludeSymbols>
+        <EmbedAllSources>true</EmbedAllSources>
+        <DebugType>portable</DebugType>
+        <SymbolPackageFormat>snupkg</SymbolPackageFormat>
+        <Authors>c-owens</Authors>
+        <LangVersion>10</LangVersion>
+    </PropertyGroup>
 </Project>