Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Docs swagger links path fixes #1633

Merged
merged 2 commits into from
Feb 6, 2025
+6 −6
Merged

Docs swagger links path fixes #1633

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
718c591
Docs swagger links path fixes
lanasta Feb 5, 2025
26f1c20
Merge branch 'main' into doc-links-fix
EnriqueL8 Feb 6, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion doc-site/docs/reference/firefly_interface_format.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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 <a href="/swagger/#/Default%20Namespace/postGenerateContractInterface" data-proofer-ignore>API documentation for the contract interface generation endpoint</a>.
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 <a href="../../swagger/#/Default%20Namespace/postGenerateContractInterface" data-proofer-ignore>API documentation for the contract interface generation endpoint</a>.

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).

Expand Down
2 changes: 1 addition & 1 deletion doc-site/docs/tutorials/broadcast_data.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ title: Broadcast data
## Additional info

- Key Concepts: [Broadcast / shared data](../overview/multiparty/broadcast.md)
- Swagger Reference: <a href="/swagger/#/Default%20Namespace/postNewMessageBroadcast" data-proofer-ignore>POST /api/v1/namespaces/{ns}/messages/broadcast</a>
- Swagger Reference: <a href="../../swagger/#/Default%20Namespace/postNewMessageBroadcast" data-proofer-ignore>POST /api/v1/namespaces/{ns}/messages/broadcast</a>

## Example 1: Inline string data

Expand Down
2 changes: 1 addition & 1 deletion doc-site/docs/tutorials/create_custom_identity.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: <a href="/swagger/#/Default%20Namespace/postNewIdentity" data-proofer-ignore>POST /api/v1/identities</a>
- Swagger: <a href="../../swagger/#/Default%20Namespace/postNewIdentity" data-proofer-ignore>POST /api/v1/identities</a>

## Previous steps: Start your environment

Expand Down
2 changes: 1 addition & 1 deletion doc-site/docs/tutorials/define_datatype.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: <a href="/swagger/#/Default%20Namespace/postNewDatatype" data-proofer-ignore>POST /api/v1/namespaces/{ns}/datatypes</a>
- Swagger: <a href="../../swagger/#/Default%20Namespace/postNewDatatype" data-proofer-ignore>POST /api/v1/namespaces/{ns}/datatypes</a>

### Example 1: Broadcast new datatype

Expand Down
2 changes: 1 addition & 1 deletion doc-site/docs/tutorials/private_send.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,7 +37,7 @@ title: Privately send data
## Additional info

- Key Concepts: [Private data exchange](../overview/multiparty/data_exchange.md)
- Swagger: <a href="/swagger/#/Default%20Namespace/postNewMessagePrivate" data-proofer-ignore>POST /api/v1/namespaces/{ns}/messages/private</a>
- Swagger: <a href="../../swagger/#/Default%20Namespace/postNewMessagePrivate" data-proofer-ignore>POST /api/v1/namespaces/{ns}/messages/private</a>

## Example 1: Pinned private send of in-line string data

Expand Down
2 changes: 1 addition & 1 deletion doc-site/docs/tutorials/query_messages.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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: <a href="/swagger/#/Default%20Namespace/getMsgs" data-proofer-ignore>GET /api/v1/namespaces/{ns}/messages</a>
- Swagger: <a href="../../swagger/#/Default%20Namespace/getMsgs" data-proofer-ignore>GET /api/v1/namespaces/{ns}/messages</a>

### Example 1: Query confirmed messages

Expand Down