docs: added documentation to all API endpoint routes so far

[adithyasunil04]

No description provided.

[KreativeThinker]

Add response documentation in the following manner:

@router.get(
    "/list",
    summary="Get all teams",
    response_model=list[Team_Pydantic],
    response_description="""Returns a complete list of registered teams.
    
    Example response:
    ```json
    [
        {
            "id": 1,
            "name": "Team Alpha",
            "coins": 100,
            "points": 250
        }
    ]
    ```
    """,
)

Ensure the response_model field has data and move technical description to response_description or remove altogether.

In docs you should be able to see something like this:

[adithyasunil04]

@ThEditor @KreativeThinker how can i fix this tox build check failing??

[KreativeThinker]

@ThEditor @KreativeThinker how can i fix this tox build check failing??

Don't worry about that

[KreativeThinker]

summary should be removed
response_description should only contain specifics like message codes. No need to put it in markdown/json format

[adithyasunil04]

I reckon we shud keep response_description for all in very short concise format, instead of removing it

[KreativeThinker]

Merge with lugvitc:docs for now as more changes are incoming. We will update there.

[KreativeThinker]

response_description field should only contain specific edge cases or error codes. No need to have other text.

Once changes are made, create a new PR to lugvitc/pwncore:docs

[KreativeThinker]

Add response documentation in the following manner:

@router.get(
    "/list",
    summary="Get all teams",
    response_model=list[Team_Pydantic],
    response_description="""Returns a complete list of registered teams.
    
    Example response:
    ```json
    [
        {
            "id": 1,
            "name": "Team Alpha",
            "coins": 100,
            "points": 250
        }
    ]
    ```
    """,
)

Ensure the response_model field has data and move technical description to response_description or remove altogether.

In docs you should be able to see something like this:

Use this instead:

@router.get(
    "/list",
    response_model=list[Team_Pydantic],
    response_description="""
        specifics like msg_codes or error messages.
    """,
)

[adithyasunil04]

all Pydantic response models that use the BaseModel pydantic model are moved to one common folder

[KreativeThinker]

Just delete wherever mentioned and make PR to pwncore:docs