Document POST API on Swagger
Manvityagi opened this issue · comments
- Find the POST Opportunity API and write YAML documentation for it.
- Text Documentation for reference
I want to work on this issue as part of GSSOC21
I want to work on this issue as part of GSSOC21
Assigned to you @Haneesha123
@Manvityagi Can you give me a detailed explanation on this issue? It is not clear.
hey @Haneesha123, we have some API endpoints ready. We are going to use Swagger for API documentation. So, the issue is about writing documentations for those endpoints.
Your task: find out the POST /opportunity(/opportunity endpoint for adding new opportunities) endpoint and document it in a way that is compatible with Swagger.
PS: I finished setting up Swagger for this project. Unfortunately, I forgot to push it. You can either wait until I push it. Or you can do the set-up by yourself. If you choose the latter option, please use these packages: swagger-ui-express and swagger-jsdoc(please use version 6xx. 7xx is not compatible with require())
If you need further assistance, you can reply here or use Discord. My Discord tag is Abdus#1541.
Pushed. you can start working. @Haneesha123
@Manvityagi @abdus Can you check if this is ok? If yes, I will proceed to create a pull request.
@Haneesha123 open a PR. that way, I would be able to pull changes locally and test.