search

okfn-brasil / gastos_abertos

Código principal do projeto Gastos Abertos.
GNU Affero General Public License v3.0
9 stars 7 forks source link

List revenues - schema #93

Closed andresmrm closed 9 years ago

andresmrm commented 9 years ago

Criar schema para o endpoint.

andresmrm commented 9 years ago

Procurando por aí achei o exemplo do Schema da API do Heroku: https://blog.heroku.com/archives/2014/1/8/json_schema_for_heroku_platform_api https://devcenter.heroku.com/articles/platform-api-reference Colei o Schema aqui: https://gist.github.com/andresmrm/a0ba484721a7cb925642

Baseado nele fiz esse: https://github.com/andresmrm/gastos_abertos/blob/d4b2c460095049accca962990fc2cd5ebafd25c5/gastosabertos/receita/schemas.json

Mas ainda estou com uma dúvida grande (e muitas menores =P ), o Schema do Heroku (pelo que entendi) especifica parâmetros passados pelo URL (como estamos fazendo) assim: https://gist.github.com/andresmrm/a0ba484721a7cb925642#file-gistfile1-json-L1356 Especificamos nosso Schema da mesma forma? Porque no Schema que fiz, novamente pelo que entendi, está como se os parâmetros fossem enviados em um JSON, e não no próprio URL: https://github.com/andresmrm/gastos_abertos/blob/d4b2c460095049accca962990fc2cd5ebafd25c5/gastosabertos/receita/schemas.json#L42-L63

andresmrm commented 9 years ago

Dei uma simplificada, deixando o Schema específico para esse endpoint mesmo: https://github.com/andresmrm/gastos_abertos/blob/be9cbd8aa201fdd59ade3c844e950a6788b870e6/gastosabertos/receita/schemas/revenue-list.json