Skip to content

"category" query string option is not honored in Swagger documentation #57

@omiras

Description

@omiras

Analysis

The Swagger documentation needs to be updated to inform REST API consumers about the availability of the categories filter.

Currently, it is possible to use a GET request to retrieve questions from specific categories, such as CSS. For example:
[Example Request](https://codequestapi.onrender.com/api/v1/questions/random?amount=1&categories=css)

However, this functionality is not documented in Swagger.

Could someone address this issue?

Additionally, the documentation should include a list of available categories (e.g., css, angular, etc.).


Acceptance Criteria

  • Swagger documentation supports GET requests using the _categories_ query parameter.
  • Swagger documentation provides a list of available categories to guide users.

Metadata

Metadata

Assignees

Labels

documentationImprovements or additions to documentationenhancementNew feature or request

Projects

Status

Todo

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions