GITBOOK-205: Indexer API

hashgraph · Jul 18, 2024 · 2e9df26 · 2e9df26
1 parent e4790a2
commit 2e9df26
Show file tree

Hide file tree

Showing 39 changed files with 6,305 additions and 0 deletions.
diff --git a/docs/.gitbook/assets/swagger-indexer.yaml b/docs/.gitbook/assets/swagger-indexer.yaml
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md
@@ -53,6 +53,43 @@
   * [🔥 FireBlocks Signing Sequence Diagram](guardian/architecture/fireblocks-signing-sequence-diagram.md)
 * [📇 Global Indexer](guardian/global-indexer/README.md)
   * [💻 Indexer User Guide](guardian/global-indexer/indexer-user-guide.md)
+  * [⚙️ Indexer APIs](guardian/global-indexer/indexer-apis/README.md)
+    * [Full Text Indexer Search](guardian/global-indexer/indexer-apis/full-text-indexer-search.md)
+    * [Returns Standard Registries](guardian/global-indexer/indexer-apis/returns-standard-registries.md)
+    * [Returns Registry as per MessageID](guardian/global-indexer/indexer-apis/returns-registry-as-per-messageid.md)
+    * [Returns Registry Users](guardian/global-indexer/indexer-apis/returns-registry-users.md)
+    * [Returns Registry User as per MessageID](guardian/global-indexer/indexer-apis/returns-registry-user-as-per-messageid.md)
+    * [Returns Policies](guardian/global-indexer/indexer-apis/returns-policies.md)
+    * [Returns policy as per MessageID](guardian/global-indexer/indexer-apis/returns-policy-as-per-messageid.md)
+    * [Returns Tools](guardian/global-indexer/indexer-apis/returns-tools.md)
+    * [Returns Tool as per MessageID](guardian/global-indexer/indexer-apis/returns-tool-as-per-messageid.md)
+    * [Returns Modules](guardian/global-indexer/indexer-apis/returns-modules.md)
+    * [Returns Module as per MessageID](guardian/global-indexer/indexer-apis/returns-module-as-per-messageid.md)
+    * [Returns Schemas](guardian/global-indexer/indexer-apis/returns-schemas.md)
+    * [Returns Schema as per MessageID](guardian/global-indexer/indexer-apis/returns-schema-as-per-messageid.md)
+    * [Returns Schema Tree](guardian/global-indexer/indexer-apis/returns-schema-tree.md)
+    * [Returns Tokens](guardian/global-indexer/indexer-apis/returns-tokens.md)
+    * [Returns Token as per TokenID](guardian/global-indexer/indexer-apis/returns-token-as-per-tokenid.md)
+    * [Returns Roles](guardian/global-indexer/indexer-apis/returns-roles.md)
+    * [Returns Role as per MessageID](guardian/global-indexer/indexer-apis/returns-role-as-per-messageid.md)
+    * [Returns DIDs](guardian/global-indexer/indexer-apis/returns-dids.md)
+    * [Returns DID as per MessageID](guardian/global-indexer/indexer-apis/returns-did-as-per-messageid.md)
+    * [Returns DID Relationships](guardian/global-indexer/indexer-apis/returns-did-relationships.md)
+    * [Returns VP Documents](guardian/global-indexer/indexer-apis/returns-vp-documents.md)
+    * [Returns VP Document as per MessageID](guardian/global-indexer/indexer-apis/returns-vp-document-as-per-messageid.md)
+    * [Returns VP Relationships](guardian/global-indexer/indexer-apis/returns-vp-relationships.md)
+    * [Returns VC Documents](guardian/global-indexer/indexer-apis/returns-vc-documents.md)
+    * [Returns VC Document as per MessageID](guardian/global-indexer/indexer-apis/returns-vc-document-as-per-messageid.md)
+    * [Returns VC Relationships](guardian/global-indexer/indexer-apis/returns-vc-relationships.md)
+    * [Returns NFTs](guardian/global-indexer/indexer-apis/returns-nfts.md)
+    * [Returns NFT as per Serial No.](guardian/global-indexer/indexer-apis/returns-nft-as-per-serial-no..md)
+    * [Returns Topics](guardian/global-indexer/indexer-apis/returns-topics.md)
+    * [Returns Topic as per TopicID](guardian/global-indexer/indexer-apis/returns-topic-as-per-topicid.md)
+    * [Returns Contracts](guardian/global-indexer/indexer-apis/returns-contracts.md)
+    * [Returns Contract as per MessageID](guardian/global-indexer/indexer-apis/returns-contract-as-per-messageid.md)
+    * [Returns Landing Page Analytics](guardian/global-indexer/indexer-apis/returns-landing-page-analytics.md)
+    * [Returns Project Coordinates](guardian/global-indexer/indexer-apis/returns-project-coordinates.md)
+    * [Returns Search Policy Results](guardian/global-indexer/indexer-apis/returns-search-policy-results.md)
 * [🗄️ Standard Registry](guardian/standard-registry/README.md)
   * [🛠️ Schemas](guardian/standard-registry/schemas/README.md)
     * [📂 Available Schema Types](guardian/standard-registry/schemas/available-schema-types.md)

diff --git a/docs/guardian/global-indexer/indexer-apis/README.md b/docs/guardian/global-indexer/indexer-apis/README.md
@@ -0,0 +1,2 @@
+# ⚙️ Indexer APIs
+
diff --git a/docs/guardian/global-indexer/indexer-apis/full-text-indexer-search.md b/docs/guardian/global-indexer/indexer-apis/full-text-indexer-search.md
@@ -0,0 +1,5 @@
+# Full Text Indexer Search
+
+{% swagger src="../../../.gitbook/assets/swagger-indexer.yaml" path="/search" method="get" %}
+[swagger-indexer.yaml](../../../.gitbook/assets/swagger-indexer.yaml)
+{% endswagger %}
diff --git a/docs/guardian/global-indexer/indexer-apis/returns-contract-as-per-messageid.md b/docs/guardian/global-indexer/indexer-apis/returns-contract-as-per-messageid.md
@@ -0,0 +1,5 @@
+# Returns Contract as per MessageID
+
+{% swagger src="../../../.gitbook/assets/swagger-indexer.yaml" path="/entities/contracts/{messageId}" method="get" %}
+[swagger-indexer.yaml](../../../.gitbook/assets/swagger-indexer.yaml)
+{% endswagger %}
diff --git a/docs/guardian/global-indexer/indexer-apis/returns-contracts.md b/docs/guardian/global-indexer/indexer-apis/returns-contracts.md
@@ -0,0 +1,5 @@
+# Returns Contracts
+
+{% swagger src="../../../.gitbook/assets/swagger-indexer.yaml" path="/entities/contracts" method="get" %}
+[swagger-indexer.yaml](../../../.gitbook/assets/swagger-indexer.yaml)
+{% endswagger %}
diff --git a/docs/guardian/global-indexer/indexer-apis/returns-did-as-per-messageid.md b/docs/guardian/global-indexer/indexer-apis/returns-did-as-per-messageid.md
@@ -0,0 +1,5 @@
+# Returns DID as per MessageID
+
+{% swagger src="../../../.gitbook/assets/swagger-indexer.yaml" path="/entities/did-documents/{messageId}" method="get" %}
+[swagger-indexer.yaml](../../../.gitbook/assets/swagger-indexer.yaml)
+{% endswagger %}
diff --git a/docs/guardian/global-indexer/indexer-apis/returns-did-relationships.md b/docs/guardian/global-indexer/indexer-apis/returns-did-relationships.md
@@ -0,0 +1,5 @@
+# Returns DID Relationships
+
+{% swagger src="../../../.gitbook/assets/swagger-indexer.yaml" path="/entities/did-documents/{messageId}/relationships" method="get" %}
+[swagger-indexer.yaml](../../../.gitbook/assets/swagger-indexer.yaml)
+{% endswagger %}
diff --git a/docs/guardian/global-indexer/indexer-apis/returns-dids.md b/docs/guardian/global-indexer/indexer-apis/returns-dids.md
@@ -0,0 +1,5 @@
+# Returns DIDs
+
+{% swagger src="../../../.gitbook/assets/swagger-indexer.yaml" path="/entities/did-documents" method="get" %}
+[swagger-indexer.yaml](../../../.gitbook/assets/swagger-indexer.yaml)
+{% endswagger %}
diff --git a/docs/guardian/global-indexer/indexer-apis/returns-landing-page-analytics.md b/docs/guardian/global-indexer/indexer-apis/returns-landing-page-analytics.md
@@ -0,0 +1,5 @@
+# Returns Landing Page Analytics
+
+{% swagger src="../../../.gitbook/assets/swagger-indexer.yaml" path="/landing/analytics" method="get" %}
+[swagger-indexer.yaml](../../../.gitbook/assets/swagger-indexer.yaml)
+{% endswagger %}
diff --git a/docs/guardian/global-indexer/indexer-apis/returns-module-as-per-messageid.md b/docs/guardian/global-indexer/indexer-apis/returns-module-as-per-messageid.md
@@ -0,0 +1,5 @@
+# Returns Module as per MessageID
+
+{% swagger src="../../../.gitbook/assets/swagger-indexer.yaml" path="/entities/modules/{messageId}" method="get" %}
+[swagger-indexer.yaml](../../../.gitbook/assets/swagger-indexer.yaml)
+{% endswagger %}
diff --git a/docs/guardian/global-indexer/indexer-apis/returns-modules.md b/docs/guardian/global-indexer/indexer-apis/returns-modules.md
@@ -0,0 +1,5 @@
+# Returns Modules
+
+{% swagger src="../../../.gitbook/assets/swagger-indexer.yaml" path="/entities/modules" method="get" %}
+[swagger-indexer.yaml](../../../.gitbook/assets/swagger-indexer.yaml)
+{% endswagger %}
diff --git a/docs/guardian/global-indexer/indexer-apis/returns-nft-as-per-serial-no..md b/docs/guardian/global-indexer/indexer-apis/returns-nft-as-per-serial-no..md
@@ -0,0 +1,5 @@
+# Returns NFT as per Serial No.
+
+{% swagger src="../../../.gitbook/assets/swagger-indexer.yaml" path="/entities/nfts/{tokenId}/{serialNumber}" method="get" %}
+[swagger-indexer.yaml](../../../.gitbook/assets/swagger-indexer.yaml)
+{% endswagger %}
diff --git a/docs/guardian/global-indexer/indexer-apis/returns-nfts.md b/docs/guardian/global-indexer/indexer-apis/returns-nfts.md
@@ -0,0 +1,5 @@
+# Returns NFTs
+
+{% swagger src="../../../.gitbook/assets/swagger-indexer.yaml" path="/entities/nfts" method="get" %}
+[swagger-indexer.yaml](../../../.gitbook/assets/swagger-indexer.yaml)
+{% endswagger %}
diff --git a/docs/guardian/global-indexer/indexer-apis/returns-policies.md b/docs/guardian/global-indexer/indexer-apis/returns-policies.md
@@ -0,0 +1,5 @@
+# Returns Policies
+
+{% swagger src="../../../.gitbook/assets/swagger-indexer.yaml" path="/entities/policies" method="get" %}
+[swagger-indexer.yaml](../../../.gitbook/assets/swagger-indexer.yaml)
+{% endswagger %}
diff --git a/docs/guardian/global-indexer/indexer-apis/returns-policy-as-per-messageid.md b/docs/guardian/global-indexer/indexer-apis/returns-policy-as-per-messageid.md
@@ -0,0 +1,5 @@
+# Returns policy as per MessageID
+
+{% swagger src="../../../.gitbook/assets/swagger-indexer.yaml" path="/entities/policies/{messageId}" method="get" %}
+[swagger-indexer.yaml](../../../.gitbook/assets/swagger-indexer.yaml)
+{% endswagger %}
diff --git a/docs/guardian/global-indexer/indexer-apis/returns-project-coordinates.md b/docs/guardian/global-indexer/indexer-apis/returns-project-coordinates.md
@@ -0,0 +1,5 @@
+# Returns Project Coordinates
+
+{% swagger src="../../../.gitbook/assets/swagger-indexer.yaml" path="/landing/projects-coordinates" method="get" %}
+[swagger-indexer.yaml](../../../.gitbook/assets/swagger-indexer.yaml)
+{% endswagger %}
diff --git a/docs/guardian/global-indexer/indexer-apis/returns-registry-as-per-messageid.md b/docs/guardian/global-indexer/indexer-apis/returns-registry-as-per-messageid.md
@@ -0,0 +1,5 @@
+# Returns Registry as per MessageID
+
+{% swagger src="../../../.gitbook/assets/swagger-indexer.yaml" path="/entities/registries/{messageId}" method="get" %}
+[swagger-indexer.yaml](../../../.gitbook/assets/swagger-indexer.yaml)
+{% endswagger %}
diff --git a/.../guardian/global-indexer/indexer-apis/returns-registry-user-as-per-messageid.md b/.../guardian/global-indexer/indexer-apis/returns-registry-user-as-per-messageid.md
@@ -0,0 +1,5 @@
+# Returns Registry User as per MessageID
+
+{% swagger src="../../../.gitbook/assets/swagger-indexer.yaml" path="/entities/registry-users/{messageId}" method="get" %}
+[swagger-indexer.yaml](../../../.gitbook/assets/swagger-indexer.yaml)
+{% endswagger %}
diff --git a/docs/guardian/global-indexer/indexer-apis/returns-registry-users.md b/docs/guardian/global-indexer/indexer-apis/returns-registry-users.md
@@ -0,0 +1,5 @@
+# Returns Registry Users
+
+{% swagger src="../../../.gitbook/assets/swagger-indexer.yaml" path="/entities/registry-users" method="get" %}
+[swagger-indexer.yaml](../../../.gitbook/assets/swagger-indexer.yaml)
+{% endswagger %}
diff --git a/docs/guardian/global-indexer/indexer-apis/returns-role-as-per-messageid.md b/docs/guardian/global-indexer/indexer-apis/returns-role-as-per-messageid.md
@@ -0,0 +1,5 @@
+# Returns Role as per MessageID
+
+{% swagger src="../../../.gitbook/assets/swagger-indexer.yaml" path="/entities/roles/{messageId}" method="get" %}
+[swagger-indexer.yaml](../../../.gitbook/assets/swagger-indexer.yaml)
+{% endswagger %}
diff --git a/docs/guardian/global-indexer/indexer-apis/returns-roles.md b/docs/guardian/global-indexer/indexer-apis/returns-roles.md
@@ -0,0 +1,5 @@
+# Returns Roles
+
+{% swagger src="../../../.gitbook/assets/swagger-indexer.yaml" path="/entities/roles" method="get" %}
+[swagger-indexer.yaml](../../../.gitbook/assets/swagger-indexer.yaml)
+{% endswagger %}
diff --git a/docs/guardian/global-indexer/indexer-apis/returns-schema-as-per-messageid.md b/docs/guardian/global-indexer/indexer-apis/returns-schema-as-per-messageid.md
@@ -0,0 +1,5 @@
+# Returns Schema as per MessageID
+
+{% swagger src="../../../.gitbook/assets/swagger-indexer.yaml" path="/entities/schemas/{messageId}" method="get" %}
+[swagger-indexer.yaml](../../../.gitbook/assets/swagger-indexer.yaml)
+{% endswagger %}
diff --git a/docs/guardian/global-indexer/indexer-apis/returns-schema-tree.md b/docs/guardian/global-indexer/indexer-apis/returns-schema-tree.md
@@ -0,0 +1,5 @@
+# Returns Schema Tree
+
+{% swagger src="../../../.gitbook/assets/swagger-indexer.yaml" path="/entities/schemas/{messageId}/tree" method="get" %}
+[swagger-indexer.yaml](../../../.gitbook/assets/swagger-indexer.yaml)
+{% endswagger %}
diff --git a/docs/guardian/global-indexer/indexer-apis/returns-schemas.md b/docs/guardian/global-indexer/indexer-apis/returns-schemas.md
@@ -0,0 +1,5 @@
+# Returns Schemas
+
+{% swagger src="../../../.gitbook/assets/swagger-indexer.yaml" path="/entities/schemas" method="get" %}
+[swagger-indexer.yaml](../../../.gitbook/assets/swagger-indexer.yaml)
+{% endswagger %}
diff --git a/docs/guardian/global-indexer/indexer-apis/returns-search-policy-results.md b/docs/guardian/global-indexer/indexer-apis/returns-search-policy-results.md
@@ -0,0 +1,5 @@
+# Returns Search Policy Results
+
+{% swagger src="../../../.gitbook/assets/swagger-indexer.yaml" path="/analytics/search/policy" method="post" %}
+[swagger-indexer.yaml](../../../.gitbook/assets/swagger-indexer.yaml)
+{% endswagger %}
diff --git a/docs/guardian/global-indexer/indexer-apis/returns-standard-registries.md b/docs/guardian/global-indexer/indexer-apis/returns-standard-registries.md
@@ -0,0 +1,5 @@
+# Returns Standard Registries
+
+{% swagger src="../../../.gitbook/assets/swagger-indexer.yaml" path="/entities/registries" method="get" %}
+[swagger-indexer.yaml](../../../.gitbook/assets/swagger-indexer.yaml)
+{% endswagger %}
diff --git a/docs/guardian/global-indexer/indexer-apis/returns-token-as-per-tokenid.md b/docs/guardian/global-indexer/indexer-apis/returns-token-as-per-tokenid.md
@@ -0,0 +1,5 @@
+# Returns Token as per TokenID
+
+{% swagger src="../../../.gitbook/assets/swagger-indexer.yaml" path="/entities/tokens/{tokenId}" method="get" %}
+[swagger-indexer.yaml](../../../.gitbook/assets/swagger-indexer.yaml)
+{% endswagger %}
diff --git a/docs/guardian/global-indexer/indexer-apis/returns-tokens.md b/docs/guardian/global-indexer/indexer-apis/returns-tokens.md
@@ -0,0 +1,5 @@
+# Returns Tokens
+
+{% swagger src="../../../.gitbook/assets/swagger-indexer.yaml" path="/entities/tokens" method="get" %}
+[swagger-indexer.yaml](../../../.gitbook/assets/swagger-indexer.yaml)
+{% endswagger %}
diff --git a/docs/guardian/global-indexer/indexer-apis/returns-tool-as-per-messageid.md b/docs/guardian/global-indexer/indexer-apis/returns-tool-as-per-messageid.md
@@ -0,0 +1,5 @@
+# Returns Tool as per MessageID
+
+{% swagger src="../../../.gitbook/assets/swagger-indexer.yaml" path="/entities/tools/{messageId}" method="get" %}
+[swagger-indexer.yaml](../../../.gitbook/assets/swagger-indexer.yaml)
+{% endswagger %}
diff --git a/docs/guardian/global-indexer/indexer-apis/returns-tools.md b/docs/guardian/global-indexer/indexer-apis/returns-tools.md
@@ -0,0 +1,5 @@
+# Returns Tools
+
+{% swagger src="../../../.gitbook/assets/swagger-indexer.yaml" path="/entities/tools" method="get" %}
+[swagger-indexer.yaml](../../../.gitbook/assets/swagger-indexer.yaml)
+{% endswagger %}
diff --git a/docs/guardian/global-indexer/indexer-apis/returns-topic-as-per-topicid.md b/docs/guardian/global-indexer/indexer-apis/returns-topic-as-per-topicid.md
@@ -0,0 +1,5 @@
+# Returns Topic as per TopicID
+
+{% swagger src="../../../.gitbook/assets/swagger-indexer.yaml" path="/entities/topics/{topicId}" method="get" %}
+[swagger-indexer.yaml](../../../.gitbook/assets/swagger-indexer.yaml)
+{% endswagger %}
diff --git a/docs/guardian/global-indexer/indexer-apis/returns-topics.md b/docs/guardian/global-indexer/indexer-apis/returns-topics.md
@@ -0,0 +1,5 @@
+# Returns Topics
+
+{% swagger src="../../../.gitbook/assets/swagger-indexer.yaml" path="/entities/topics" method="get" %}
+[swagger-indexer.yaml](../../../.gitbook/assets/swagger-indexer.yaml)
+{% endswagger %}
diff --git a/docs/guardian/global-indexer/indexer-apis/returns-vc-document-as-per-messageid.md b/docs/guardian/global-indexer/indexer-apis/returns-vc-document-as-per-messageid.md
@@ -0,0 +1,5 @@
+# Returns VC Document as per MessageID
+
+{% swagger src="../../../.gitbook/assets/swagger-indexer.yaml" path="/entities/vc-documents/{messageId}" method="get" %}
+[swagger-indexer.yaml](../../../.gitbook/assets/swagger-indexer.yaml)
+{% endswagger %}
diff --git a/docs/guardian/global-indexer/indexer-apis/returns-vc-documents.md b/docs/guardian/global-indexer/indexer-apis/returns-vc-documents.md
@@ -0,0 +1,5 @@
+# Returns VC Documents
+
+{% swagger src="../../../.gitbook/assets/swagger-indexer.yaml" path="/entities/vc-documents" method="get" %}
+[swagger-indexer.yaml](../../../.gitbook/assets/swagger-indexer.yaml)
+{% endswagger %}
diff --git a/docs/guardian/global-indexer/indexer-apis/returns-vc-relationships.md b/docs/guardian/global-indexer/indexer-apis/returns-vc-relationships.md
@@ -0,0 +1,5 @@
+# Returns VC Relationships
+
+{% swagger src="../../../.gitbook/assets/swagger-indexer.yaml" path="/entities/vc-documents/{messageId}/relationships" method="get" %}
+[swagger-indexer.yaml](../../../.gitbook/assets/swagger-indexer.yaml)
+{% endswagger %}
diff --git a/docs/guardian/global-indexer/indexer-apis/returns-vp-document-as-per-messageid.md b/docs/guardian/global-indexer/indexer-apis/returns-vp-document-as-per-messageid.md
@@ -0,0 +1,5 @@
+# Returns VP Document as per MessageID
+
+{% swagger src="../../../.gitbook/assets/swagger-indexer.yaml" path="/entities/vp-documents/{messageId}" method="get" %}
+[swagger-indexer.yaml](../../../.gitbook/assets/swagger-indexer.yaml)
+{% endswagger %}
diff --git a/docs/guardian/global-indexer/indexer-apis/returns-vp-documents.md b/docs/guardian/global-indexer/indexer-apis/returns-vp-documents.md
@@ -0,0 +1,5 @@
+# Returns VP Documents
+
+{% swagger src="../../../.gitbook/assets/swagger-indexer.yaml" path="/entities/vp-documents" method="get" %}
+[swagger-indexer.yaml](../../../.gitbook/assets/swagger-indexer.yaml)
+{% endswagger %}
diff --git a/docs/guardian/global-indexer/indexer-apis/returns-vp-relationships.md b/docs/guardian/global-indexer/indexer-apis/returns-vp-relationships.md
@@ -0,0 +1,5 @@
+# Returns VP Relationships
+
+{% swagger src="../../../.gitbook/assets/swagger-indexer.yaml" path="/entities/vp-documents/{messageId}/relationships" method="get" %}
+[swagger-indexer.yaml](../../../.gitbook/assets/swagger-indexer.yaml)
+{% endswagger %}