Skip to content

docs: add API pagination, filtering and sorting specification#113

Open
JosirexLegacy wants to merge 1 commit intobos-com:mainfrom
JosirexLegacy:docs/api-pagination-filtering-sorting
Open

docs: add API pagination, filtering and sorting specification#113
JosirexLegacy wants to merge 1 commit intobos-com:mainfrom
JosirexLegacy:docs/api-pagination-filtering-sorting

Conversation

@JosirexLegacy
Copy link
Copy Markdown

Summary

Closes #9

This PR adds a comprehensive documentation file specifying how pagination, filtering, and sorting should work across GreenCode's list API endpoints.

Changes

  • Added docs/api-pagination-filtering-sorting.md with:
    • Standard query parameters for pagination (page, size)
    • Filtering conventions with example requests and responses
    • Sorting parameters and usage
    • Spring Boot backend implementation example
    • React/Axios frontend implementation example
    • Contributor checklist for new list endpoints

Why this matters

Without a clear standard, different developers implement pagination differently, leading to inconsistent APIs. This document establishes a single convention for the whole project.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Title: Pagination, Filtering, Sorting for Lists

1 participant