GolosChain / golos-explorer

MIT License
5 stars 3 forks source link

доработать swagger.json #75

Open epexa opened 6 years ago

epexa commented 6 years ago

в Swagger нужно описать подробно параметры filterModel и sortModel у методов getAccounts и getComments.

для filterModel параметры:

пример: https://api-explorer.golos.io/getAccounts?filterModel[name][type]=contains&filterModel[name][filter]=goloscore&filterModel[name][filterType]=text

для sortModel параметры:

пример: https://api-explorer.golos.io/getAccounts?sortModel[0][colId]=post_count&sortModel[0][sort]=desc

JSON: https://explorer.golos.io/swagger.json SwaggerHub: https://app.swaggerhub.com/apis/goloschain/explorer/1.0.0

epexa commented 6 years ago

сложная структура описана: golos explorer golos blockchain explorer 1 однако в песочнице SwaggerUI она не работает. ответ от тех. поддержки SwaggerHub:

But, this isn't supported by SwaggerUI at the moment. Also, there is no good way to show in the spec that the method can have several "sortModel" params. I'm discussing with the Product Team what improvement requests we need to create out of it. First, there should be a specification improvement (this is an open question how such params should be represented in the spec) and, when the spec supports this, there should be a corresponding SwaggerUI modification. So, it's going to be a long way...

build collaborate integrate apis swaggerhub