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

Suggestions #138

Closed
VaslD opened this issue Apr 16, 2021 · 1 comment
Closed

Suggestions #138

VaslD opened this issue Apr 16, 2021 · 1 comment
Labels

Comments

@VaslD
Copy link
Contributor

VaslD commented Apr 16, 2021

Please consider introducing these (potentially breaking) changes:

  • Consistent Naming: select:/fields:, filter:/filters:, limit:/limits:.
    select is probably a typo or SQL-mindset mistake because there are only 2 methods with this parameter. Should just get rid of it. Since fields and limits aren't directly included in the API request (rather they form a JSONPath-like key along with referenced types), I suggest making all collection (e.g. [Limit]) parameters plural and single-type (e.g. Int) parameters singular.

  • Consolidate Data and Link Models: There really isn't a single reason that each response should inline their own named Data and Link structures since all have exactly the same properties. Apple's documentation isn't source code per-se so they give each structure a different name for readability, but in programming sense doing this is a huge waste of resources and hammers interoperability.

I can make these changes and PR (and adding some missing APIs along the way) but I'd like to ask for opinions first.

@github-actions
Copy link

This issue is stale because it has been open for 30 days with no activity. Remove the Stale label or comment or this will be closed in 10 days.

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

No branches or pull requests

1 participant