feat(api): add REST endpoint with JSON/plain-text & filter params #220
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Implement content negotiation to return plain text by default for API clients while preserving HTML responses for browser requests. This improves API usability for non-browser clients while maintaining the existing user experience for web users. - Add browser detection via User-Agent header - Return PlainTextResponse for API clients - Preserve HTML template responses for browser requests
This commit enhances the API functionality by allowing programmatic access
with customizable parameters through URL query strings. The changes include:
- Add support for max_size, pattern_type, and pattern query parameters
in non-browser GET requests to /{repository_path}
- Create comprehensive API documentation in docs/api.md with:
* Detailed endpoint descriptions
* Parameter specifications
* Response format documentation
* Usage examples
* Best practices
- Update API web interface (api.jinja) to reflect new capabilities
and provide clear usage instructions
These changes enable API consumers to filter repositories by file patterns
and size limits without using the web interface, making the API more
flexible for integration with external tools and scripts.
This commit enhances the API functionality by allowing programmatic access with JSON response format through URL query parameters or Accept headers. The changes include: - Add support for format parameter in non-browser GET requests - Implement JSON response format in query processor - Update API documentation with format options and examples - Add comprehensive tests for format detection and response handling This change maintains backward compatibility while providing a more structured response format for API consumers.
filipchristiansen
changed the title
Member
Author
|
Closing because outdated, will be implemented again from a more recent version |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This PR is an attempt at implementing a single REST endpoint for ingests from url