This page serves as the central hub for our help center, providing users with access to a wealth of informative articles. With its intuitive search functionality, users can easily find the articles they need to address their questions or concerns. Additionally, the help center page implements rate limiting on its search endpoints.
Acceptance Criteria
Articles can be searched for.
Rate limiting is set on search endpoints.
Purpose
Users can search for articles by titles / topics.
Requirements
[ ] Articles can be searched for.
[ ] Rate limiting is set.
Endpoints
[GET] /api/v1/topics/search?title={title}
Description
Will accept query parameters that would be used to filter the result based on the passed title
Description
This page serves as the central hub for our help center, providing users with access to a wealth of informative articles. With its intuitive search functionality, users can easily find the articles they need to address their questions or concerns. Additionally, the help center page implements rate limiting on its search endpoints.
Acceptance Criteria
Purpose
Users can search for articles by titles / topics.
Requirements
Endpoints
[GET] /api/v1/topics/search?title={title}
Description
Successful Response
Status code: 200
Error Response
Status code: 404
No article matches the title search param.
Status code: 429
Too many requests, Rate limit reached.
Status code: 500
Internal Server Error
Database Schema
Table name: articles_table
Database diagram
Database image
Testing
/api/v1/topics
matches the documentation.