You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
The reason will be displayed to describe this comment to others. Learn more.
Code Review
This pull request introduces the initial OpenAPI specification for the DocuForge API, which includes endpoints for Excel, CSV, and PDF processing. The review feedback highlights a critical security issue regarding the use of HTTP and a raw IPv6 address for the production server, which should be updated to HTTPS and a domain name. Additionally, several endpoints are missing 'content' definitions in their responses, which is necessary for proper documentation and client generation. Finally, the 'created_at' field in the account endpoint should include a 'date-time' format for better schema precision.
The reason will be displayed to describe this comment to others. Learn more.
The production server is configured with a raw IPv6 address and uses the insecure http protocol. For a production API that requires authentication via X-API-Key, it is critical to use https to prevent credentials from being transmitted in cleartext. Additionally, using a domain name instead of a static IP is standard practice for API stability and discoverability.
The reason will be displayed to describe this comment to others. Learn more.
The response for a successful CSV conversion is missing a content definition. Without specifying the media type (e.g., text/csv) and schema, client generators and documentation tools cannot correctly handle the output.
The reason will be displayed to describe this comment to others. Learn more.
The response for the auto-format endpoint is missing the content definition. It should specify the Excel media type to ensure proper handling by clients.
The reason will be displayed to describe this comment to others. Learn more.
The response for the CSV-to-Excel conversion is missing the content definition. It should specify the Excel media type as seen in the /excel/clean endpoint.
The reason will be displayed to describe this comment to others. Learn more.
The PDF metadata endpoint is missing the content definition. Since the description mentions JSON, it should define application/json along with the expected schema for the metadata object (e.g., properties for pages, author, title, etc.).
The reason will be displayed to describe this comment to others. Learn more.
The PDF merge endpoint is missing the content definition for the resulting PDF file. This is necessary for tools to recognize the binary output as a PDF.
The reason will be displayed to describe this comment to others. Learn more.
The created_at property should include a format: date-time to provide better information for client generators and ensure consistent parsing of the timestamp.
type: stringformat: date-time
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
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.
Add DocuForge API OpenAPI 3.0 spec.
Document processing REST API for Excel, CSV, and PDF files.
Free tier: 50 calls/month.
GitHub: https://github.com/rnhowcla/docuforge-api