Merge pull request #158 from notion-dotnet/feature/157-mark-list-database-enpoint-deprecated

Mark database list endpoint obsolete with warning 🗑️

Author: KoditkarVedant

README.md

@@ -103,7 +103,7 @@ var complexFiler = new CompoundFilter(
   - [x] Create a database
   - [x] Update database
   - [x] Retrieve a database
-  - [x] List databases
+  - [x] List databases  (Deprecated: use Search API instead)
 - [x] Pages
   - [x] Retrieve a page
   - [x] Create a page

Src/Notion.Client/Api/Databases/DatabasesClient.cs

@@ -1,4 +1,5 @@
-using System.Collections.Generic;
+using System;
+using System.Collections.Generic;
 using System.Threading.Tasks;
 using static Notion.Client.ApiEndpoints;
 
@@ -18,6 +19,7 @@ public async Task<Database> RetrieveAsync(string databaseId)
             return await _client.GetAsync<Database>(DatabasesApiUrls.Retrieve(databaseId));
         }
 
+        [Obsolete("This endpoint is no longer recommended, use Search instead. This endpoint will only return explicitly shared pages, while search will also return child pages within explicitly shared pages. This endpoint's results cannot be filtered, while search can be used to match on page title.", false)]
         public async Task<PaginatedList<Database>> ListAsync(DatabasesListParameters databasesListParameters = null)
         {
             var databasesListQueryParmaters = (IDatabasesListQueryParmaters)databasesListParameters;

Src/Notion.Client/Api/Databases/IDatabasesClient.cs

@@ -1,11 +1,19 @@
-using System.Threading.Tasks;
+using System;
+using System.Threading.Tasks;
 
 namespace Notion.Client
 {
     public interface IDatabasesClient
     {
         Task<Database> RetrieveAsync(string databaseId);
         Task<PaginatedList<Page>> QueryAsync(string databaseId, DatabasesQueryParameters databasesQueryParameters);
+
+        /// <summary>
+        /// List all Databases shared with the authenticated integration.
+        /// </summary>
+        /// <param name="databasesListParameters">database list request parameters.</param>
+        /// <returns>PaginatedList of databases.</returns>
+        [Obsolete("This endpoint is no longer recommended, use Search instead. This endpoint will only return explicitly shared pages, while search will also return child pages within explicitly shared pages. This endpoint's results cannot be filtered, while search can be used to match on page title.", false)]
         Task<PaginatedList<Database>> ListAsync(DatabasesListParameters databasesListParameters = null);
 
         /// <summary>

Test/Notion.UnitTests/DatabasesClientTests.cs

@@ -19,6 +19,7 @@ public DatabasesClientTests()
         }
 
         [Fact]
+        [Obsolete]
         public async Task ListDatabasesAsync()
         {
             var path = ApiEndpoints.DatabasesApiUrls.List();

docs/README.md

@@ -70,7 +70,7 @@ var complexFiler = new CompoundFilter(
   - [x] Create a database
   - [x] Update database
   - [x] Retrieve a database
-  - [x] List databases
+  - [x] List databases (Deprecated: use Search API instead)
 - [x] Pages
   - [x] Retrieve a page
   - [x] Create a page