Skip to content
This repository has been archived by the owner on Nov 22, 2022. It is now read-only.

VB 22 - correct swagger data #118

Open
johnsmithm opened this issue Oct 17, 2020 · 3 comments
Open

VB 22 - correct swagger data #118

johnsmithm opened this issue Oct 17, 2020 · 3 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest help wanted Extra attention is needed hight priority

Comments

@johnsmithm
Copy link
Contributor

some of the routes parameters and return object are not set the right way, the input json for a post endpoint and the data in the database are not the same format, for example at the /api/request, in the endpoint for POST we have just:

{
                  "beneficiary": "123456",
                  "type":"grocery",
                  "status": "new",
                  "secret": "345%443$$",
                  "urgent": false,
                  "comments": "string",
                  "has_symptoms": false
                }

but in the swagger is indicated:

{
  "beneficiary": 0,
  "status": "new",
  "secret": "string",
  "urgent": true,
  "comments": "string",
  "has_symptoms": true,
  "cluster": 0,
  "created_at": "2020-10-17T20:43:18.965Z"
}

also, need to add the type property.

location: static/swagger.yml

@johnsmithm johnsmithm added documentation Improvements or additions to documentation good first issue Good for newcomers help wanted Extra attention is needed hight priority hacktoberfest labels Oct 17, 2020
@alexciornii alexciornii self-assigned this Oct 19, 2020
@johnsmithm
Copy link
Contributor Author

also for /api/volunteer post/put/get are not correct, and swagger is very important for the frontend @alexciornii

@johnsmithm
Copy link
Contributor Author

@alexciornii any updates?

@johnsmithm
Copy link
Contributor Author

have updated the request and cluster endpoint info

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers hacktoberfest help wanted Extra attention is needed hight priority
Projects
None yet
Development

No branches or pull requests

2 participants