nik/bisq-api-reference
1
0
Fork 0
mirror of https://github.com/bisq-network/bisq-api-reference.git synced 2026-05-01 09:10:12 +00:00
Code Issues Packages Projects Releases Wiki Activity

Change links from my repo to bisq_network fork

Browse Source
This commit is contained in:
ghubstan 2022-05-03 11:00:54 -03:00
parent 45f6704f20
commit 8c7bdd975a
No known key found for this signature in database
GPG Key ID: E35592D6800A861E
4 changed files with 11 additions and 11 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
README.md
View File

@ -10,20 +10,20 @@ client example code, and developing new Java and Python clients and bots.
It contains four subprojects: It contains four subprojects:
1. [reference-doc-builder](https://github.com/ghubstan/bisq-api-reference/tree/main/reference-doc-builder) -- The Java 1. [reference-doc-builder](https://github.com/bisq-network/bisq-api-reference/tree/main/reference-doc-builder) -- The Java
application that produces the [API Reference](https://bisq-network.github.io/slate) content, from Bisq protobuf application that produces the [API Reference](https://bisq-network.github.io/slate) content, from Bisq protobuf
definition files. definition files.
2. [cli-examples](https://github.com/ghubstan/bisq-api-reference/tree/main/cli-examples) -- A folder of bash scripts 2. [cli-examples](https://github.com/bisq-network/bisq-api-reference/tree/main/cli-examples) -- A folder of bash scripts
demonstrating how to run API CLI commands. Each script is named for the RPC method call being demonstrated. demonstrating how to run API CLI commands. Each script is named for the RPC method call being demonstrated.
3. [java-examples](https://github.com/ghubstan/bisq-api-reference/tree/main/java-examples) -- A Java project 3. [java-examples](https://github.com/bisq-network/bisq-api-reference/tree/main/java-examples) -- A Java project
demonstrating how to call the API from Java gRPC clients. Each class in demonstrating how to call the API from Java gRPC clients. Each class in
the [bisq.rpccalls](https://github.com/ghubstan/bisq-api-reference/tree/main/java-examples/src/main/java/bisq/rpccalls) the [bisq.rpccalls](https://github.com/bisq-network/bisq-api-reference/tree/main/java-examples/src/main/java/bisq/rpccalls)
package is named for the RPC method call being demonstrated. package is named for the RPC method call being demonstrated.
4. [python-examples](https://github.com/ghubstan/bisq-api-reference/tree/main/python-examples) -- A Python3 project 4. [python-examples](https://github.com/bisq-network/bisq-api-reference/tree/main/python-examples) -- A Python3 project
demonstrating how to call the API from Python3 gRPC clients. Each class in demonstrating how to call the API from Python3 gRPC clients. Each class in
the [bisq.rpccalls](https://github.com/ghubstan/bisq-api-reference/tree/main/python-examples/bisq/rpccalls) package the [bisq.rpccalls](https://github.com/bisq-network/bisq-api-reference/tree/main/python-examples/bisq/rpccalls) package
is named for the RPC method call being demonstrated. There are also some simple bot examples in is named for the RPC method call being demonstrated. There are also some simple bot examples in
the [bisq.bots](https://github.com/ghubstan/bisq-api-reference/tree/main/python-examples/bisq/bots) package. the [bisq.bots](https://github.com/bisq-network/bisq-api-reference/tree/main/python-examples/bisq/bots) package.
The RPC method examples are also displayed in the [API Reference](https://bisq-network.github.io/slate). While The RPC method examples are also displayed in the [API Reference](https://bisq-network.github.io/slate). While
navigating the RPC method links in the reference's table of contents on the left side of the page, they appear in the navigating the RPC method links in the reference's table of contents on the left side of the page, they appear in the

4
java-examples/README.md
View File

@ -3,9 +3,9 @@
This subproject contains Java classes demonstrating API gRPC method calls. This subproject contains Java classes demonstrating API gRPC method calls.
Each class in Each class in
the [bisq.rpccalls](https://github.com/ghubstan/bisq-api-reference/tree/main/java-examples/src/main/java/bisq/rpccalls) the [bisq.rpccalls](https://github.com/bisq-network/bisq-api-reference/tree/main/java-examples/src/main/java/bisq/rpccalls)
package is named for the RPC method call being demonstrated. package is named for the RPC method call being demonstrated.
The subproject uses a The subproject uses a
a [Gradle build file](https://github.com/ghubstan/bisq-api-reference/blob/main/java-examples/build.gradle), also a [Gradle build file](https://github.com/bisq-network/bisq-api-reference/blob/main/java-examples/build.gradle), also
demonstrating how to generate the necessary protobuf classes from the Bisq .proto files. demonstrating how to generate the necessary protobuf classes from the Bisq .proto files.

2
python-examples/README.md
View File

@ -3,7 +3,7 @@
This subproject contains Python3 classes demonstrating API gRPC method calls, and some sample bots. This subproject contains Python3 classes demonstrating API gRPC method calls, and some sample bots.
Each class in Each class in
the [bisq.rpccalls](https://github.com/ghubstan/bisq-api-reference/tree/main/python-examples/bisq/rpccalls) package is the [bisq.rpccalls](https://github.com/bisq-network/bisq-api-reference/tree/main/python-examples/bisq/rpccalls) package is
named for the RPC method call being demonstrated. named for the RPC method call being demonstrated.
The `run-setup.sh` script in this directory can install Python3 dependencies and example packages into a local venv. The `run-setup.sh` script in this directory can install Python3 dependencies and example packages into a local venv.

2
reference-doc-builder/src/main/resources/templates/examples-setup.md
View File

@ -43,7 +43,7 @@ directory (`my-api-app`), and the Bisq .proto files are located in a directory n
### Generate Bisq API protobuf stubs using Gradle grpc-java plugin (recommended) ### Generate Bisq API protobuf stubs using Gradle grpc-java plugin (recommended)
You can generate Java API stubs in a Gradle project using the [protoc-gen-grpc-java](https://github.com/grpc/grpc-java) You can generate Java API stubs in a Gradle project using the [protoc-gen-grpc-java](https://github.com/grpc/grpc-java)
plugin. Try the [build.gradle](https://github.com/ghubstan/bisq-api-reference/blob/main/java-examples/build.gradle) plugin. Try the [build.gradle](https://github.com/bisq-network/bisq-api-reference/blob/main/java-examples/build.gradle)
file used by the project providing the Java examples for this document; it should work for you. file used by the project providing the Java examples for this document; it should work for you.
_Note: You can also generate stubs with [protoc-gen-grpc-java](https://github.com/grpc/grpc-java) in maven projects._ _Note: You can also generate stubs with [protoc-gen-grpc-java](https://github.com/grpc/grpc-java) in maven projects._