Update platform API to current schema #56

Open
wants to merge 1 commit into
from

Projects

None yet

2 participants

@brentdax

Adds APIs available as of 13 January 2017. Among other things, these include:

  • Teams (organizations)
  • Federated log-in and identity providers
  • App formations sets
  • Heroku SSL (SNI Endpoint)

I have no idea what the policy is for updating this gem, but since I need one of these APIs (SNI Endpoint), I thought it wouldn't hurt to send a pull request.

This is just a straight rebuild on the current schema.json. I have two concerns about it:

  1. The schema appears to have changed many endpoints from using the spelling addon to add-on. This has caused widespread spelling changes from Addon to AddOn and from addon to add_on. While the new spellings are probably more readable, this will probably break a lot of existing code. Should we add in some sort of compatibility aliasing for the old names? I don't see any indication in the project that this is currently being done.

  2. The old PlatformAPI::Source#create call has been deprecated, which (thanks to a bit of patching by @naaman) turns it into create___deprecated with three underscores. While not an ideal name, this is at least callable, and it’s not going to be mistaken for either its non-deprecated replacement (which takes a different number of parameters, so mixing the two up will cause a runtime error) or anything else that’s currently recommended.

Brent Royal-Gordon Update platform API to current schema
Adds APIs available as of 13 January 2017. Among other things, these include:

• Teams (organizations)
• Federated log-in and identity providers
• App formations sets
• Heroku SSL (SNI Endpoint)

These APIs include a deprecated endpoint in `PlatformAPI::Source` which is imported as `create___deprecated`. While not an ideal name, this is at least callable, and it’s not going to be mistaken for either its non-deprecated replacement (which takes a different number of parameters) or anything else that’s currently recommended.
0623f54
@geemus
Member
geemus commented Jan 18, 2017

See also: interagent/heroics#78 (comment) (which thanks to schema fixes is probably not absolutely necessary, but would still be nice to have in some capacity).

@jalada jalada referenced this pull request in pixielabs/letsencrypt-rails-heroku Feb 17, 2017
Closed

fork of platform-api having problems #35

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