Fix documentation inaccuracies: endpoint count, scope table, coverage claim#12
Merged
ronaldvdmeer merged 2 commits intomainfrom Mar 29, 2026
Merged
Fix documentation inaccuracies: endpoint count, scope table, coverage claim#12ronaldvdmeer merged 2 commits intomainfrom
ronaldvdmeer merged 2 commits intomainfrom
Conversation
README: - Correct endpoint count from 15 to 23 - Update feature description to list all endpoint categories (notifications, clones, contacts, calendar, loyalty, killmails were missing) - Correct test coverage claim from '100%' to '>=98%' - Update endpoint reference link to reflect 23 methods docs/authentication.md: - Add 7 missing scopes to the required OAuth scope table: read_notifications, read_clones, read_implants, read_contacts, read_calendar_events, read_loyalty, read_killmails - Note that wallet_journal shares esi-wallet.read_character_wallet.v1 with wallet_balance - Correct 'exports the full set' to 'exports a recommended baseline set' (DEFAULT_SCOPES is intentionally a subset, not the complete scope list)
There was a problem hiding this comment.
Pull request overview
Documentation-only update to align the published docs with the library’s already-implemented endpoint surface and auth scope requirements, correcting several inaccuracies found during audit.
Changes:
- Updates README endpoint count/reference (15 → 23) and adjusts the test coverage claim to reflect current coverage.
- Expands
docs/authentication.mdscope table to include missing scopes/method mappings and clarifiesDEFAULT_SCOPESas a baseline set. - Adds
async_get_wallet_journal()to the wallet scope row (shared scope with wallet balance).
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
| File | Description |
|---|---|
| docs/authentication.md | Adds missing scope rows, updates wallet scope row to include wallet journal, and clarifies DEFAULT_SCOPES description. |
| README.md | Updates feature bullets and docs links to reflect 23 endpoints and adjusts stated test coverage. |
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
README.md
Outdated
| - **Fully async** — built on [aiohttp](https://docs.aiohttp.org/) | ||
| - **Typed models** — all API responses are frozen dataclasses with full type annotations | ||
| - **15 endpoints** — public (server, character, corporation, universe) and authenticated (wallet, skills, location, industry, market, mail, fatigue) | ||
| - **23 endpoints** — public (server, character, corporation, universe) and authenticated (wallet, skills, location, industry, market, mail, notifications, clones, contacts, calendar, loyalty, killmails) |
There was a problem hiding this comment.
The authenticated endpoint category list drops “fatigue”, but the client still provides async_get_jump_fatigue() (and it’s listed in the scopes table). To keep the README feature summary accurate, add “fatigue” back to the authenticated categories list.
Suggested change
| - **23 endpoints** — public (server, character, corporation, universe) and authenticated (wallet, skills, location, industry, market, mail, notifications, clones, contacts, calendar, loyalty, killmails) | |
| - **23 endpoints** — public (server, character, corporation, universe) and authenticated (wallet, skills, location, industry, market, mail, notifications, clones, fatigue, contacts, calendar, loyalty, killmails) |
- endpoints.md: expand Pagination section with table of paginated methods and page sizes; add Client utilities section documenting clear_etag_cache(); add Request caching section explaining TTL and ETag layers with examples - quickstart.md: add Automatic pagination and Request caching sections - error-handling.md: replace duplicated caching content with cross-reference to endpoints.md#request-caching - README.md: restore 'fatigue' to authenticated endpoint category list (addresses Copilot review comment)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Corrects inaccurate counts, missing scope entries, and a misleading constant description found during a pre-release documentation audit.
Details
README.md:
docs/authentication.md:
esi-characters.read_notifications.v1→async_get_notifications()esi-clones.read_clones.v1→async_get_clones()esi-clones.read_implants.v1→async_get_implants()esi-characters.read_contacts.v1→async_get_contacts()esi-calendar.read_calendar_events.v1→async_get_calendar()esi-characters.read_loyalty.v1→async_get_loyalty_points()esi-killmails.read_killmails.v1→async_get_killmails()async_get_wallet_journal()now listed alongsideasync_get_wallet_balance()in theesi-wallet.read_character_wallet.v1row (they share the same scope)DEFAULT_SCOPESis intentionally a subset of all scopes, not a complete listingTesting
172 unit tests pass, 98.04% coverage. No code changes — docs only.
Integration testing
No integration test changes required — docs-only PR.
Documentation
This PR is the documentation change.