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

Update platform API to current schema #56

Closed
wants to merge 1 commit into from

Conversation

beccadax
Copy link

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.

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.
@geemus
Copy link
Contributor

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).

@geemus
Copy link
Contributor

geemus commented May 1, 2017

I believe the newest release(s) included the new stuff, though we lost track of this PR along the way. Apologies for this lingering for so long.

@geemus geemus closed this May 1, 2017
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants