Skip to content

Add hadiths list endpoint with filtering support #1811

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
26 changes: 26 additions & 0 deletions main.py
Original file line number Diff line number Diff line change
Expand Up @@ -107,6 +107,32 @@ def api_collection_book_chapter(collection_name, bookNumber, chapterId):
return Chapter.query.filter_by(collection=collection_name, arabicBookID=book_id, babID=chapterId)


@app.route("/v1/hadiths", methods=["GET"])
@paginate_results
def api_hadiths():
query = Hadith.query

# Apply filters based on query parameters
collection = request.args.get("collection")
if collection:
query = query.filter_by(collection=collection)

book_number = request.args.get("bookNumber")
if book_number:
query = query.filter_by(bookNumber=book_number)

chapter_id = request.args.get("chapterId")
if chapter_id:
query = query.filter_by(babID=float(chapter_id))

hadith_number = request.args.get("hadithNumber")
if hadith_number:
query = query.filter_by(hadithNumber=hadith_number)

# Order by URN for consistent results
return query.order_by(Hadith.englishURN)


@app.route("/v1/hadiths/<int:urn>", methods=["GET"])
@single_resource
def api_hadith(urn):
Expand Down
42 changes: 42 additions & 0 deletions spec.v1.yml
Original file line number Diff line number Diff line change
Expand Up @@ -227,6 +227,48 @@ paths:
required: true
schema:
type: string
/hadiths:
get:
summary: Get a list of hadiths
description: ""
responses:
"200":
description: Paginated list of hadiths
content:
application/json:
schema:
type: object
allOf:
- properties:
data:
type: array
items:
$ref: "#/components/schemas/Hadith"
- $ref: "#/components/schemas/PaginatedResponse"
parameters:
- in: query
name: collection
description: Name of the collection
schema:
type: string
- in: query
name: bookNumber
description: Number of the book
schema:
type: string
- in: query
name: chapterId
description: ID of the chapter
schema:
type: number
format: float
- in: query
name: hadithNumber
description: Hadith number
schema:
type: string
- $ref: "#/components/parameters/limit"
- $ref: "#/components/parameters/page"
"/hadiths/{urn}":
get:
summary: Get a hadith by its URN
Expand Down