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.

Sign up for GitHub

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

Jump to bottom

Clean up the API #30

Closed
skluck opened this issue Feb 3, 2017 · 0 comments
Closed

Clean up the API #30

skluck opened this issue Feb 3, 2017 · 0 comments
Labels
c/api c/docs

Comments

@skluck
Copy link
Member

skluck commented Feb 3, 2017

  • hyphens should not be used in property names

    Example: test_property instead of test-property

  • Double check for inconsistent property names
  • Add missing resources - Target Pools / Views
  • Add missing resources - Job Processes
  • Add missing resources - Encrypted Properties (without secrets)
  • Add missing resources - Credentials (without secrets)
  • Sanity checks - Some endpoints can return a lot of data, or many results. These should be paged or guarded.
  • Support "embed" on more endpoints to allow clients to select what resources are embedded
  • Consider switching to JSON API
  • Add link to documentation when throwing http problem
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
c/api c/docs
Milestone
No milestone
Development

No branches or pull requests
1 participant
@skluck