BREAKING: add new APIs to filter nodes and validators by network

ripple / validator-history-service

Service for ingesting, aggregating, storing, and disbursing XRP Ledger validation related data.

ISC License

14 stars 8 forks source link

BREAKING: add new APIs to filter nodes and validators by network #32

Closed mvadari closed 2 years ago

mvadari commented 2 years ago

High Level Overview of Change

This PR adds new API methods to filter nodes and validators by what network they are in (mainnet/testnet/devnet). The existing API calls are also modified a bit, to be named to better represent what they do.

Context of Change

Prep for sidechain support

Type of Change

[x] New feature (non-breaking change which adds functionality)
[x] Breaking change (fix or feature that would cause existing functionality to not work as expected)

Before / After

Test Plan

CI passes.

JST5000 commented 2 years ago

Would it be possible/preferable to just alias the old api names to the new names for now and mark them as deprecated?

mvadari commented 2 years ago

Would it be possible/preferable to just alias the old api names to the new names for now and mark them as deprecated?

Done in #33 (this PR is based on top of that one).

I've asked around and it doesn't seem like anyone else uses this API (plus migration is super easy if they do), so I'm thinking it might be okay to just do it.

mvadari commented 2 years ago

I've asked around and it doesn't seem like anyone else uses this API (plus migration is super easy if they do), so I'm thinking it might be okay to just do it.

Update: only one person has said that they use this API, and is fine with making the migration (it is a super simple migration to make)