esi-issues
esi-issues copied to clipboard
Change scopes descriptions in swagger.json to match description in developpers.eveonline
Inconsistency
Routes
swagger.json
Description
Currently, scopes description in the swagger.json look like this:
"scopes": {
"esi-assets.read_assets.v1": "EVE SSO scope esi-assets.read_assets.v1",
"esi-bookmarks.read_character_bookmarks.v1": "EVE SSO scope esi-bookmarks.read_character_bookmarks.v1",
"esi-calendar.read_calendar_events.v1": "EVE SSO scope esi-calendar.read_calendar_events.v1",
It could be useful to have "real" description (if these are descriptions) that match what is currently displayed in developpers.eveonline.com
Resolution
Match the description in developpers.eveonline.com.
exemple:
"scopes": {
"esi-assets.read_assets.v1": "Allows reading a list of assets that the character owns",
"esi-bookmarks.read_character_bookmarks.v1": "Allows reading of a character's bookmarks and bookmark folders",
"esi-calendar.read_calendar_events.v1": "Allows reading a character's calendar, including corporation events",
we requested a route for this from SSO back in the early design days of ESI.
still waiting for an update on internal jira issue [SSO-194]
Scopes in openapi3 carry forward this non informative description, though the exact text has changed
"scopes": {
"esi-alliances.read_contacts.v1": "esi-alliances.read_contacts.v1",
"esi-assets.read_assets.v1": "esi-assets.read_assets.v1",
"esi-assets.read_corporation_assets.v1": "esi-assets.read_corporation_assets.v1",
...
},