search

plangrid / flask-rebar

Flask-Rebar combines flask, marshmallow, and swagger for robust REST services.
MIT License
231 stars 38 forks source link

Use application/json rather than application/vnd.plangrid+json #17

Closed twosigmajab closed 5 years ago

twosigmajab commented 5 years ago

SwaggerV2Generator produces application/vnd.plangrid+json by default:

https://github.com/plangrid/flask-rebar/blob/fcdd3b016a9b218dcaa53aa70467e2e2f0832d8d/flask_rebar/swagger_generation/swagger_generator.py#L278

This seemed unusual and after looking a bit I wasn't able to find any clues as to why this doesn't use application/json instead. Any interest in switching to application/json?

Thanks for your consideration and for maintaining flask-rebar. After looking at several options (flask-apispec, flasgger, flask-restplus), this seems like the best.

barakalon commented 5 years ago

Ah, this is purely an accident! flask-rebar started as an internal package, and this must've just been left in there.

I'll put up a fix

twosigmajab commented 5 years ago

Thanks for the quick fix! I'll follow #19. Just out of curiosity, it looks like you're waiting for someone to review before you can merge, but are not sure who to ask? From https://github.com/plangrid/flask-rebar/graphs/contributors it looks like you wrote most of this library, but GitHub isn't showing any "owner", "collaborator", or even "contributor" badge by your comments... wat?

barakalon commented 5 years ago

I created flask-rebar while working at plangrid. I've since started working elsewhere and thus am not a member of the plangrid Github organization anymore, so I don't have write access to the repository anymore.

I'm not sure if it's possible to give write access to someone outside of the organization? If not, I think the only other option is transfer the repository to a neutral organization. But it hasn't been a big issue yet, since my friends at PlanGrid have been quick 😬

As for why i don't get a badge by my comments... I'm sure the above has something to do with it, but I don't know enough about badges to say. Alas! I'm doomed to a life of obscurity.

barakalon commented 5 years ago

Ok, https://github.com/plangrid/flask-rebar/pull/19 is merged. It will make it to pypi on the next release. If the change is urgent, I'll look to @juliusiv to make the release (and to mark this issue as resolved)

juliusiv commented 5 years ago

@twosigmajab I just released this as version 1.0.6. Let me know if there are any problems. In the meantime, I'm going to close this issue as resolved.

twosigmajab commented 5 years ago

Just updated to 1.0.6 and confirmed the fix. Thanks for getting it out so quickly!