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.

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

Inconsistent paths for corporations endpoints #1023

Open
3 of 4 tasks
jmayse opened this issue Aug 29, 2018 · 0 comments
Open
3 of 4 tasks

Inconsistent paths for corporations endpoints #1023

jmayse opened this issue Aug 29, 2018 · 0 comments

Comments

@jmayse
Copy link

jmayse commented Aug 29, 2018

Inconsistency

in v0.8.6 there is inconsistent naming for corporation and corporations in the corporations endpoint, specifically for mining endpoints. Almost all endpoint roots are pluralized (alliances, characters, contracts, etc.) even when they refer to a singular entity. Singularized endpoints are consistently singular. However, for the 3 industry endpoints corporation is singular, in contrast to the other corporations endpoints. This issue can make it difficult to standardize interactions with paths when expecting to find paths sharing the /corporations/ base.

Routes

Inconsistent singularized occurrences:

  • /v1/corporation/{corporation_id}/mining/extractions/
  • /v1/corporation/{corporation_id}/mining/extractions/observers/
  • /v1/corporation/{corporation_id}/mining/extractions/observers/{observer_id}/

Consistent, pluralized examples:

  • /v1/corporations/{corporation_id}/
  • /v1/corporations/{corporation_id}/alliance_history/

Consistent, pluralized examples that occur in the same Industry group as the inconsistent examples:

  • /v1/characters/{character_id}/industry/jobs/
  • /v1/corporations/{corporation_id}/industry/jobs/

Resolution

Change the occurrences of corporationto corporations to be consistent with the other endpoints

Checklist

Check all boxes that apply to this issue:

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

2 participants