search

tmobile / sawtooth-next-directory

Home for NEXT Directory - Powered by Hyperledger Sawtooth. Chat with the team at https://chat.hyperledger.org/channel/sawtooth-next-directory/
Apache License 2.0
11 stars 7 forks source link

Upgrade sanic-openapi library to 0.6.0 #664

Closed mtn217 closed 5 years ago

mtn217 commented 5 years ago
User Story Meaningful Name here
T-shirt size: S
User Story "As a user of a certain type (specify), I want to do something (action) so I can provide business value"
Description There are three problems with the sanic-openapi library at the moment: 1)Websocket endpoints are currently not supported in either sanic-openapi and Swagger OpenAPI. Because our websocket endpoints are automatically added to sanic via blueprints, the websockets are being read and are showing up in our swagger. We can't add decorators to the websocket endpoints because they aren't supported, thus we can't exclude them from the swagger documentation. 2) In version 0.5.3 of sanic-openapi, endpoints with the same URI (i.e. /api/users/) share the same operationID which causes them to all open at the same time when you're browsing the swagger documentation. The master code of the library has the ability to set the operationID value on each endpoint so that each endpoint is unique. We have to wait until sanic-openapi releases their next version of 0.6.0. We have contacted two of their authors and we are waiting to hear back from them. 3) In v0.5.3 the same endpoint shows up twice, one with a trailing backslash and one without (i.e. api/users/ and api/users).
Requirements 1) Upgrade to sanic-openapi v0.6.0 2) Fix the issues from 0.5.3 if possible
Acceptance Criteria/Tests 1) Upgraded to sanic-openapi v0.6.0 to fix the issues from 0.5.3.