Add tags to each endpoints.

[nikhil25803]

Description

Note

• One needs to add tags to each endpoint as shown in the code below

  # Engineering Colleges
  @app.get('/engineering_colleges', description='All engineering colleges', tags=['engineering_colleges'])
  async def engineeringColleges(page: int = 1, limit: int = 50):
  try:
      async with aiofiles.open(os.path.join(os.getcwd(), "data", "allEngineeringColleges.json")) as file:
          output = await file.read()
  except:
      raise HTTPException(status_code=404)
  return paginate(json.loads(output), page, limit)

• The tag must be according to the endpoint. Eg. tags=['medical_colleges'] for medical colleges endpoint.

• This will help in improving the documentation of the project and also enhance code readability.

Screenshots

No response

Additional information

No response

[zmusaddique]

Hey! @nikhil25803 ! I would like to work on this

[nikhil25803]

Sure @zmusaddique, go ahead :))

[zmusaddique]

What should be the tag for colleges section? Just "colleges"?

[nikhil25803]

What should be the tag for colleges section? Just "colleges"?

Yes xD

[zmusaddique]

Have made a PR.