search

Girl-Code-It / Opportunity-Calendar-Backend

Opportunity Calendar is the one-stop place to refer important opportunities available in tech-space like newly posted jobs, internships, hackathons, tech-conferences, scholarships, etc.
https://opportunity-calendar.herokuapp.com/
MIT License
15 stars 30 forks source link

Document POST API on Swagger #19

Closed Manvityagi closed 3 years ago

Manvityagi commented 3 years ago
Haneesha123 commented 3 years ago

I want to work on this issue as part of GSSOC21

Manvityagi commented 3 years ago

I want to work on this issue as part of GSSOC21

Assigned to you @Haneesha123

Haneesha123 commented 3 years ago

@Manvityagi Can you give me a detailed explanation on this issue? It is not clear.

abdus commented 3 years ago

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.

Haneesha123 commented 3 years ago

Okay. I will wait until you push it @abdus

abdus commented 3 years ago

Pushed. you can start working. @Haneesha123

Haneesha123 commented 3 years ago

@Manvityagi @abdus Can you check if this is ok? If yes, I will proceed to create a pull request. Capture Capture1 Capture2

abdus commented 3 years ago

@Haneesha123 open a PR. that way, I would be able to pull changes locally and test.

Haneesha123 commented 3 years ago

@abdus I have opened PR #24. Please check it.