From 8623f32086e6fa6e558cf58585b7f564d7ce9ba5 Mon Sep 17 00:00:00 2001
From: Jordan Woods <13803242+jorwoods@users.noreply.github.com>
Date: Tue, 30 Sep 2025 21:43:19 -0500
Subject: [PATCH 1/2] docs: metadata.paginated_query
---
docs/api-ref.md | 35 +++++++++++++++++++++++++++++++++++
1 file changed, 35 insertions(+)
diff --git a/docs/api-ref.md b/docs/api-ref.md
index 21e7d47e..21baccff 100644
--- a/docs/api-ref.md
+++ b/docs/api-ref.md
@@ -1631,6 +1631,41 @@ Name | Description
The method returns the query results as a stucture of `list`s and `dict`s as returned by the `json` package.
+**Example**
+
+See the `metadata_query.py` sample in the Samples directory.
+
+
+
+
+#### metadata.paginated_query
+
+
+```py
+metadata.paginated_query(query, variables=None, abort_on_error=False)
+```
+
+Executes a metadata query, and returns a dictionary containing a list of the results. In order to properly paginate through all the results, the query must contain a field `pageInfo` with the subfields `hasNextPage` and `endCursor`, as well as the nodes to be returned. The query must accept the variables `first` (the number of items to return) and `afterToken` (the cursor after which to return items). The method will repeatedly call the metadata endpoint until all results have been retrieved, and return a dictionary containing a list of all results.
+
+**Example**
+
+See the `metadata_paginated_query.py` sample in the Samples directory.
+
+
+**Parameters**
+
+Name | Description
+:--- | :---
+`query` | The GraphQL query
+`variables` | Variables for the GraphQL query
+`abort_on_error` | Whether to throw an exception on error
+
+
+**Returns**
+
+The method returns the query results in a dictionary containing a list of pages as a stucture of `list`s and `dict`s as returned by the `json` package.
+
+
**Example**
See the `metadata_query.py` sample in the Samples directory.
From 6faf1a71ca8a8ebcda8a4cd56e402ca3d184b8ae Mon Sep 17 00:00:00 2001
From: Jordan Woods <13803242+jorwoods@users.noreply.github.com>
Date: Thu, 16 Oct 2025 23:13:56 -0500
Subject: [PATCH 2/2] fix: remove bad sample reference
---
docs/api-ref.md | 5 +----
1 file changed, 1 insertion(+), 4 deletions(-)
diff --git a/docs/api-ref.md b/docs/api-ref.md
index 21baccff..aebe7995 100644
--- a/docs/api-ref.md
+++ b/docs/api-ref.md
@@ -1647,9 +1647,6 @@ metadata.paginated_query(query, variables=None, abort_on_error=False)
Executes a metadata query, and returns a dictionary containing a list of the results. In order to properly paginate through all the results, the query must contain a field `pageInfo` with the subfields `hasNextPage` and `endCursor`, as well as the nodes to be returned. The query must accept the variables `first` (the number of items to return) and `afterToken` (the cursor after which to return items). The method will repeatedly call the metadata endpoint until all results have been retrieved, and return a dictionary containing a list of all results.
-**Example**
-
-See the `metadata_paginated_query.py` sample in the Samples directory.
**Parameters**
@@ -1668,7 +1665,7 @@ The method returns the query results in a dictionary containing a list of pages
**Example**
-See the `metadata_query.py` sample in the Samples directory.
+See the `metadata_paginated_query.py` sample in the Samples directory.