🌿 Fern Regeneration -- May 15, 2025 (#49)

* SDK regeneration

* Add test for list backups by index

---------

Co-authored-by: fern-api <115122769+fern-api[bot]@users.noreply.github.com>
Co-authored-by: Niels Swimberghe <3382717+Swimburger@users.noreply.github.com>

Author: fern-api[bot]

.mock/definition/backups.yml

@@ -4,29 +4,49 @@ service:
   auth: false
   base-path: ''
   endpoints:
-    list:
-      path: /backups
+    listByIndex:
+      path: /indexes/{index_name}/backups
       method: GET
       auth: true
-      docs: List all backups for a project.
+      docs: List all backups for an index.
       source:
         openapi: ../control-plane/openapi/openapi.yml
-      display-name: List backups for all indexes in a project
+      path-parameters:
+        index_name:
+          type: string
+          docs: Name of the backed up index
+      display-name: List backups for an index
+      request:
+        name: ListBackupsByIndexRequest
+        query-parameters:
+          limit:
+            type: optional<integer>
+            default: 10
+            docs: The number of results to return per page.
+            validation:
+              min: 1
+              max: 100
+          paginationToken:
+            type: optional<string>
+            docs: The token to use to retrieve the next page of results.
       response:
         docs: >-
-          This operation returns a list of all the backups for the given index
-          that you have previously created.
+          This operation returns a list of all the backups that you have
+          previously created, and which are associated with the given index.
         type: root.BackupList
         status-code: 200
       errors:
         - root.UnauthorizedError
+        - root.NotFoundError
         - root.InternalServerError
       examples:
         - name: A list containing backups.
+          path-parameters:
+            index_name: index_name
           response:
             body:
               data:
-                - backup_id: 670e8400-e29b-41d4-a716-446655440000
+                - backup_id: bkp_123abc
                   source_index_name: my-index
                   source_index_id: idx_456
                   name: backup_2024_03_15
@@ -43,9 +63,9 @@ service:
                     environment: production
                     type: monthly
                   created_at: '2024-03-15T10:30:00Z'
-                - backup_id: 670e8400-e29b-41d4-a716-446655440001
-                  source_index_name: my-index-2
-                  source_index_id: idx_789
+                - backup_id: bkp_789xyz
+                  source_index_name: my-index
+                  source_index_id: idx_456
                   name: backup_2024_03_20
                   description: Pre-deployment safety backup
                   status: Ready
@@ -170,6 +190,64 @@ service:
                 tag0: val0
                 tag1: val1
               created_at: created_at
+    list:
+      path: /backups
+      method: GET
+      auth: true
+      docs: List all backups for a project.
+      source:
+        openapi: ../control-plane/openapi/openapi.yml
+      display-name: List backups for all indexes in a project
+      response:
+        docs: >-
+          This operation returns a list of all the backups for the given index
+          that you have previously created.
+        type: root.BackupList
+        status-code: 200
+      errors:
+        - root.UnauthorizedError
+        - root.InternalServerError
+      examples:
+        - name: A list containing backups.
+          response:
+            body:
+              data:
+                - backup_id: 670e8400-e29b-41d4-a716-446655440000
+                  source_index_name: my-index
+                  source_index_id: idx_456
+                  name: backup_2024_03_15
+                  description: Monthly backup of production index
+                  status: Ready
+                  cloud: aws
+                  region: us-east-1
+                  dimension: 1536
+                  metric: cosine
+                  record_count: 120000
+                  namespace_count: 3
+                  size_bytes: 10000000
+                  tags:
+                    environment: production
+                    type: monthly
+                  created_at: '2024-03-15T10:30:00Z'
+                - backup_id: 670e8400-e29b-41d4-a716-446655440001
+                  source_index_name: my-index-2
+                  source_index_id: idx_789
+                  name: backup_2024_03_20
+                  description: Pre-deployment safety backup
+                  status: Ready
+                  cloud: aws
+                  region: us-east-1
+                  dimension: 1536
+                  metric: cosine
+                  record_count: 125000
+                  namespace_count: 4
+                  size_bytes: 10500000
+                  tags:
+                    environment: production
+                    type: pre-deploy
+                  created_at: '2024-03-20T15:45:00Z'
+              pagination:
+                next: dXNlcl9pZD11c2VyXzE=
     get:
       path: /backups/{backup_id}
       method: GET

README.md

@@ -482,7 +482,7 @@ var backup = await pinecone.Backups.GetAsync("backup-id");
 ```
 
 #### List backups
-The following example describes a backup.
+The following example lists all backups.
 
 ```csharp
 using Pinecone;
@@ -499,8 +499,27 @@ foreach (var backup in backups.Data)
 }
 ```
 
+
+#### List backups by index
+The following example lists backups for a specific index.
+
+```csharp
+using Pinecone;
+
+var pinecone = new PineconeClient("PINECONE_API_KEY");
+var backups = await pinecone.Backups.ListByIndexAsync( "index-name", new ListBackupsByIndexRequest());
+foreach (var backup in backups.Data)
+{
+    Console.WriteLine($"BackupId: {backup.BackupId}");
+    Console.WriteLine($"Name: {backup.Name}");
+    Console.WriteLine($"CreatedAt: {backup.CreatedAt}");
+    Console.WriteLine($"Status: {backup.Status}");
+    Console.WriteLine($"RecordCount: {backup.RecordCount}");
+}
+```
+
 #### Delete backup
-The following example describes a backup.
+The following example deletes a backup.
 
 ```csharp
 using Pinecone;

reference.md

@@ -572,7 +572,7 @@ await client.DeleteCollectionAsync("test-collection");
 </details>
 
 ## Backups
-<details><summary><code>client.Backups.<a href="/src/Pinecone/Backups/BackupsClient.cs">ListAsync</a>() -> BackupList</code></summary>
+<details><summary><code>client.Backups.<a href="/src/Pinecone/Backups/BackupsClient.cs">ListByIndexAsync</a>(indexName, ListBackupsByIndexRequest { ... }) -> BackupList</code></summary>
 <dl>
 <dd>
 
@@ -584,7 +584,7 @@ await client.DeleteCollectionAsync("test-collection");
 <dl>
 <dd>
 
-List all backups for a project.
+List all backups for an index.
 </dd>
 </dl>
 </dd>
@@ -599,13 +599,36 @@ List all backups for a project.
 <dd>
 
 ```csharp
-await client.Backups.ListAsync();
+await client.Backups.ListByIndexAsync("index_name", new ListBackupsByIndexRequest());
 ```
 </dd>
 </dl>
 </dd>
 </dl>
 
+#### ⚙️ Parameters
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+**indexName:** `string` — Name of the backed up index
+    
+</dd>
+</dl>
+
+<dl>
+<dd>
+
+**request:** `ListBackupsByIndexRequest` 
+    
+</dd>
+</dl>
+</dd>
+</dl>
+
 
 </dd>
 </dl>
@@ -669,6 +692,45 @@ await client.Backups.BackupIndexAsync("index_name", new BackupIndexRequest());
 </dl>
 
 
+</dd>
+</dl>
+</details>
+
+<details><summary><code>client.Backups.<a href="/src/Pinecone/Backups/BackupsClient.cs">ListAsync</a>() -> BackupList</code></summary>
+<dl>
+<dd>
+
+#### 📝 Description
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+List all backups for a project.
+</dd>
+</dl>
+</dd>
+</dl>
+
+#### 🔌 Usage
+
+<dl>
+<dd>
+
+<dl>
+<dd>
+
+```csharp
+await client.Backups.ListAsync();
+```
+</dd>
+</dl>
+</dd>
+</dl>
+
+
 </dd>
 </dl>
 </details>

src/Pinecone.Test/Integration/Data/TestBackups.cs

@@ -66,6 +66,19 @@ public async Task TestListBackups()
         Assert.That(backups.Data, Is.Not.Empty);
     }
 
+    [Test]
+    public async Task TestListBackupsByIndex()
+    {
+        var backups = await Client.Backups.ListByIndexAsync(
+            IndexName, 
+            new ListBackupsByIndexRequest(), 
+            _options
+        );
+        Assert.That(backups, Is.Not.Null);
+        Assert.That(backups.Data, Is.Not.Null);
+        Assert.That(backups.Data, Is.Not.Empty);
+    }
+
     [Test]
     public async Task TestGetBackup()
     {

src/Pinecone.Test/Unit/MockServer/ListByIndexTest.cs

@@ -0,0 +1,87 @@
+using global::System.Threading.Tasks;
+using NUnit.Framework;
+using Pinecone;
+using Pinecone.Core;
+
+namespace Pinecone.Test.Unit.MockServer;
+
+[TestFixture]
+public class ListByIndexTest : BaseMockServerTest
+{
+    [Test]
+    public async global::System.Threading.Tasks.Task MockServerTest()
+    {
+        const string mockResponse = """
+            {
+              "data": [
+                {
+                  "backup_id": "bkp_123abc",
+                  "source_index_name": "my-index",
+                  "source_index_id": "idx_456",
+                  "name": "backup_2024_03_15",
+                  "description": "Monthly backup of production index",
+                  "status": "Ready",
+                  "cloud": "aws",
+                  "region": "us-east-1",
+                  "dimension": 1536,
+                  "metric": "cosine",
+                  "record_count": 120000,
+                  "namespace_count": 3,
+                  "size_bytes": 10000000,
+                  "tags": {
+                    "environment": "production",
+                    "type": "monthly"
+                  },
+                  "created_at": "2024-03-15T10:30:00.000Z"
+                },
+                {
+                  "backup_id": "bkp_789xyz",
+                  "source_index_name": "my-index",
+                  "source_index_id": "idx_456",
+                  "name": "backup_2024_03_20",
+                  "description": "Pre-deployment safety backup",
+                  "status": "Ready",
+                  "cloud": "aws",
+                  "region": "us-east-1",
+                  "dimension": 1536,
+                  "metric": "cosine",
+                  "record_count": 125000,
+                  "namespace_count": 4,
+                  "size_bytes": 10500000,
+                  "tags": {
+                    "environment": "production",
+                    "type": "pre-deploy"
+                  },
+                  "created_at": "2024-03-20T15:45:00.000Z"
+                }
+              ],
+              "pagination": {
+                "next": "dXNlcl9pZD11c2VyXzE="
+              }
+            }
+            """;
+
+        Server
+            .Given(
+                WireMock
+                    .RequestBuilders.Request.Create()
+                    .WithPath("/indexes/index_name/backups")
+                    .UsingGet()
+            )
+            .RespondWith(
+                WireMock
+                    .ResponseBuilders.Response.Create()
+                    .WithStatusCode(200)
+                    .WithBody(mockResponse)
+            );
+
+        var response = await Client.Backups.ListByIndexAsync(
+            "index_name",
+            new ListBackupsByIndexRequest()
+        );
+        Assert.That(
+            response,
+            Is.EqualTo(JsonUtils.Deserialize<BackupList>(mockResponse)).UsingDefaults()
+        );
+    }
+}