diff --git a/docs/rpc/README.md b/docs/rpc/README.md index e4835bd6..e26e5de6 100644 --- a/docs/rpc/README.md +++ b/docs/rpc/README.md @@ -4,15 +4,16 @@ The RPC API provides a [JSON-RPC 2.0](https://www.jsonrpc.org/specification) int ## Method Categories -- [Auth (STABLE)](auth.md) - Used to create and manage BTC Map accounts -- [Events (STABLE)](event/README.md) - Event management API -- [Areas (WIP)](area/README.md) - Manage community and country data +- [Auth (STABLE)](auth.md) - Used to create and manage BTC Map accounts; per-method docs in [auth/](auth/) (signin, signup, signout, password change, API keys, whoami) +- [Events (STABLE)](event/README.md) - Event management API; per-method docs in [event/](event/) (create, read, update, soft-delete events with geofence enforcement) +- [Areas (WIP)](area/README.md) - Manage community and country data; per-method docs in [area/](area/) (CRUD, tags, images, trending and dashboard reports, element mapping) - [Public Methods](public-methods.md) - Methods for client apps to use - [Element Methods](element-methods.md) - Methods for working with map elements - [User Methods](user-methods.md) - Methods for working with user data, including the `set_user_geofence` restriction on event managers - [Admin Methods](admin-methods.md) - Methods for administrative operations -- [Log Methods](log/README.md) - Methods for log analysis and infrastructure reporting -- [Invoice Methods](invoice-methods.md) - Methods for handling payments +- [Analytics](analytics/README.md) - Dashboards and analytical reports: place statistics, daily infrastructure and request-log reports, top API consumers +- [Import](import/README.md) - Add and manage places submitted by trusted external sources; per-method docs in [import/](import/) (`submit_place`, `revoke_submitted_place`, `get_submitted_place`, `get_place_import_origins`) +- [Invoice Methods](invoice-methods.md) - Methods for handling payments; per-method docs in [invoice/](invoice/) (create and read invoices) - [Search Methods](search-methods.md) - Methods for searching -- [Electrum servers](electrum/) - Methods for managing electrum servers used by wallet balance lookups -- [Wallets](wallet/) - Methods for managing project wallets and reading their on-chain balances +- [Electrum servers](electrum/) - Methods for managing electrum servers used by wallet balance lookups; per-method docs in [electrum/](electrum/) (list, add, update, remove) +- [Wallets](wallet/) - Methods for managing project wallets and reading their on-chain balances; per-method docs in [wallet/](wallet/) (list, add, update, soft-delete)