From 718c591b06e0505de0d871d5e7ad155f429100cc Mon Sep 17 00:00:00 2001 From: Anastasia Lalamentik Date: Wed, 5 Feb 2025 13:58:18 -0500 Subject: [PATCH] Docs swagger links path fixes Signed-off-by: Anastasia Lalamentik --- doc-site/docs/reference/firefly_interface_format.md | 2 +- doc-site/docs/tutorials/broadcast_data.md | 2 +- doc-site/docs/tutorials/create_custom_identity.md | 2 +- doc-site/docs/tutorials/define_datatype.md | 2 +- doc-site/docs/tutorials/private_send.md | 2 +- doc-site/docs/tutorials/query_messages.md | 2 +- 6 files changed, 6 insertions(+), 6 deletions(-) diff --git a/doc-site/docs/reference/firefly_interface_format.md b/doc-site/docs/reference/firefly_interface_format.md index 3a52a2ce99..9370b609cf 100644 --- a/doc-site/docs/reference/firefly_interface_format.md +++ b/doc-site/docs/reference/firefly_interface_format.md @@ -98,7 +98,7 @@ For example, the Ethereum plugin always needs to know what Solidity type the fie ## Automated generation of FireFly Interfaces -A convenience endpoint exists on the API to facilitate converting from native blockchain interface formats such as an Ethereum ABI to the FireFly Interface format. For details, please see the API documentation for the contract interface generation endpoint. +A convenience endpoint exists on the API to facilitate converting from native blockchain interface formats such as an Ethereum ABI to the FireFly Interface format. For details, please see the API documentation for the contract interface generation endpoint. For an example of using this endpoint with a specific Ethereum contract, please see the [Tutorial to Work with custom smart contracts](../tutorials/custom_contracts/index.md). diff --git a/doc-site/docs/tutorials/broadcast_data.md b/doc-site/docs/tutorials/broadcast_data.md index 86ca25a20f..6f367a427f 100644 --- a/doc-site/docs/tutorials/broadcast_data.md +++ b/doc-site/docs/tutorials/broadcast_data.md @@ -20,7 +20,7 @@ title: Broadcast data ## Additional info - Key Concepts: [Broadcast / shared data](../overview/multiparty/broadcast.md) -- Swagger Reference: POST /api/v1/namespaces/{ns}/messages/broadcast +- Swagger Reference: POST /api/v1/namespaces/{ns}/messages/broadcast ## Example 1: Inline string data diff --git a/doc-site/docs/tutorials/create_custom_identity.md b/doc-site/docs/tutorials/create_custom_identity.md index 52624f24cd..a8faf453f4 100644 --- a/doc-site/docs/tutorials/create_custom_identity.md +++ b/doc-site/docs/tutorials/create_custom_identity.md @@ -11,7 +11,7 @@ Out of the box, a FireFly Supernode contains both an `org` and a `node` identity ## Additional info - Reference: [Identities](../reference/identities.md) -- Swagger: POST /api/v1/identities +- Swagger: POST /api/v1/identities ## Previous steps: Start your environment diff --git a/doc-site/docs/tutorials/define_datatype.md b/doc-site/docs/tutorials/define_datatype.md index 17fa24de45..f241c3d2b0 100644 --- a/doc-site/docs/tutorials/define_datatype.md +++ b/doc-site/docs/tutorials/define_datatype.md @@ -20,7 +20,7 @@ of datatypes, as is used to broadcast the data itself. ## Additional info - Key Concepts: [Broadcast / shared data](../overview/multiparty/broadcast.md) -- Swagger: POST /api/v1/namespaces/{ns}/datatypes +- Swagger: POST /api/v1/namespaces/{ns}/datatypes ### Example 1: Broadcast new datatype diff --git a/doc-site/docs/tutorials/private_send.md b/doc-site/docs/tutorials/private_send.md index 63d71f1324..bb59b5997c 100644 --- a/doc-site/docs/tutorials/private_send.md +++ b/doc-site/docs/tutorials/private_send.md @@ -37,7 +37,7 @@ title: Privately send data ## Additional info - Key Concepts: [Private data exchange](../overview/multiparty/data_exchange.md) -- Swagger: POST /api/v1/namespaces/{ns}/messages/private +- Swagger: POST /api/v1/namespaces/{ns}/messages/private ## Example 1: Pinned private send of in-line string data diff --git a/doc-site/docs/tutorials/query_messages.md b/doc-site/docs/tutorials/query_messages.md index 6bdf2ee328..5785b992ac 100644 --- a/doc-site/docs/tutorials/query_messages.md +++ b/doc-site/docs/tutorials/query_messages.md @@ -17,7 +17,7 @@ This builds on the APIs to query and filter messages, described below ## Additional info - Reference: [API Query Syntax](../reference/api_query_syntax.md) -- Swagger: GET /api/v1/namespaces/{ns}/messages +- Swagger: GET /api/v1/namespaces/{ns}/messages ### Example 1: Query confirmed messages