[bisq-network/bisq] Prepare API Offers .proto defs for significant changes (PR #6055)

Stan notifications at github.com
Thu Feb 17 17:48:11 CET 2022


This PR adds comments to `grpc.proto` to be pulled into a new API reference doc.  Some of the comments highlight issues to be resolved in following PRs.

The main focus of the PR is on documenting `service Offers { ... }` related definitions in `grpc.proto`:
- Comment each field in the Offers service's messages.
- Add TODO comments about fixing field defs with usability & consistency problems.

Other API reference doc related changes to `grpc.proto`:
- Comment each gRPC service's rpc method definitions, however briefly.
- Improve some existing rpc method comments.

Also add unmerged API NPE fix to `FeeService` class (see PR #6052).

Based on `master`.

You can view, comment on, or merge this pull request online at:

  https://github.com/bisq-network/bisq/pull/6055

-- Commit Summary --

  * Include unmerged API NPE fix to FeeService class (see PR #6052)
  * Prepare API Offers .proto defs for significant changes
  * Fix comment about changing "all" number fields to string

-- File Changes --

    M core/src/main/java/bisq/core/provider/fee/FeeService.java (2)
    M proto/src/main/proto/grpc.proto (224)

-- Patch Links --

https://github.com/bisq-network/bisq/pull/6055.patch
https://github.com/bisq-network/bisq/pull/6055.diff

-- 
Reply to this email directly or view it on GitHub:
https://github.com/bisq-network/bisq/pull/6055
You are receiving this because you are subscribed to this thread.

Message ID: <bisq-network/bisq/pull/6055 at github.com>
-------------- next part --------------
An HTML attachment was scrubbed...
URL: <http://lists.bisq.network/pipermail/bisq-github/attachments/20220217/7197019e/attachment-0001.htm>


More information about the bisq-github mailing list