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

Jump to bottom

Prepare API Offers .proto defs for significant changes [#1] #6055

Merged
merged 3 commits into from
Feb 24, 2022
Merged

Prepare API Offers .proto defs for significant changes [#1] #6055

merged 3 commits into from
Feb 24, 2022

Commits on Feb 17, 2022

  1. Include unmerged API NPE fix to FeeService class (see PR bisq-network… 

    …#6052)
    @ghubstan
    ghubstan committed Feb 17, 2022
    Configuration menu
    Copy the full SHA
    6f1057a View commit details
    Browse the repository at this point in the history

  2. Prepare API Offers .proto defs for significant changes 

    This commit 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 is on documenting gRPC Offers service 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.
    @ghubstan
    ghubstan committed Feb 17, 2022
    Configuration menu
    Copy the full SHA
    4596960 View commit details
    Browse the repository at this point in the history

  3. Fix comment about changing "all" number fields to string 

    We will consider each problematic number field one at a time.

Note: changing field types in following commits will break
the API's backward compatibility, but devs agree it's OK since
it is still in beta.
    @ghubstan
    ghubstan committed Feb 17, 2022
    Configuration menu
    Copy the full SHA
    ddd3ec3 View commit details
    Browse the repository at this point in the history