Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Improve API documentation with better examples, especially for search endpoints #1862

Open
takaro-ci-bot bot opened this issue Jan 5, 2025 · 0 comments
Open

Improve API documentation with better examples, especially for search endpoints #1862

takaro-ci-bot bot opened this issue Jan 5, 2025 · 0 comments
Assignees
@niekcandaele
Labels
documentation Improvements or additions to documentation enhancement New feature or request needs-triage

Comments

@takaro-ci-bot
Copy link
Contributor

takaro-ci-bot bot commented Jan 5, 2025

Description

The current API documentation lacks clear and comprehensive examples, particularly for search endpoints. This issue is to improve the documentation by adding better examples that demonstrate how to use the API effectively.

Requirements/use-cases

  • Add more detailed examples for search endpoints
  • Include examples that show different search parameters and their combinations
  • Provide examples for pagination and sorting
  • Ensure examples are clear and easy to understand for users of varying technical levels

Possible duplicates:
@takaro-ci-bot takaro-ci-bot bot added documentation Improvements or additions to documentation enhancement New feature or request needs-triage labels Jan 5, 2025
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@niekcandaele niekcandaele

Labels
documentation Improvements or additions to documentation enhancement New feature or request needs-triage
Projects
None yet
Milestone
No milestone
Development

No branches or pull requests
1 participant
@niekcandaele