Add Swagger api docs

[gaelyn]

Summary by CodeRabbit

• New Features
  • Introduced detailed Swagger documentation for various API endpoints, improving clarity on request and response structures.
  • Added a new API documentation interface using Swagger UI.
• Documentation
  • Enhanced API documentation accessibility and user interaction through the new ReactSwagger component.
• Chores
  • Integrated new dependencies next-swagger-doc and swagger-ui-react to support Swagger UI documentation features.

[coderabbitai]

Walkthrough

The project has integrated Swagger documentation across several API endpoints to enhance API usability and maintainability. This includes detailed documentation for operations like creating spaces, managing custom fields, and resetting accounts. Additionally, new dependencies have been added to support Swagger UI rendering in React.

Changes

Files	Change Summary
app/api-docs/page.tsx app/api-docs/react-swagger.tsx	Introduced files for importing and rendering API documentation using Swagger UI.
app/api/create-space/route.ts app/api/custom-field/route.ts app/api/filefeed-events/route.ts app/api/reset-account/route.ts app/api/v1/attributes/route.ts app/api/v1/products/route.ts app/api/visit-space/[spaceId]/route.ts	Added Swagger documentation for various API endpoints to describe their operations.
lib/swagger.ts package.json	Introduced a function to generate Swagger specifications and added dependencies for Swagger documentation integration.
styles/swagger.css	Introduced styling changes to various elements for Swagger documentation.

Possibly related issues

• add reusable spaces to create-react-app example create-flatfile-react#9: Enhancing the create-react-app example with reusable spaces could benefit from the detailed Swagger documentation added in this PR, as it improves code readability and maintainability.

---

Tips

Chat

There are 3 ways to chat with CodeRabbit:

• Review comments: Directly reply to a review comment made by CodeRabbit. Example:
  • I pushed a fix in commit <commit_id>.
  • Generate unit testing code for this file.
  • Open a follow-up GitHub issue for this discussion.
• Files and specific lines of code (under the "Files changed" tab): Tag @coderabbitai in a new review comment at the desired location with your query. Examples:
  • @coderabbitai generate unit testing code for this file.
  • @coderabbitai modularize this function.
• PR comments: Tag @coderabbitai in a new PR comment to ask questions about the PR branch. For the best results, please provide a very specific query, as very limited context is provided in this mode. Examples:
  • @coderabbitai generate interesting stats about this repository and render them as a table.
  • @coderabbitai show all the console.log statements in this repository.
  • @coderabbitai read src/utils.ts and generate unit testing code.
  • @coderabbitai read the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Note: Be mindful of the bot's finite context window. It's strongly recommended to break down tasks such as reading entire modules into smaller chunks. For a focused discussion, use review comments to chat about specific files and their changes, instead of using the PR comments.

CodeRabbit Commands (invoked as PR comments)

• @coderabbitai pause to pause the reviews on a PR.
• @coderabbitai resume to resume the paused reviews.
• @coderabbitai review to trigger a review. This is useful when automatic reviews are disabled for the repository.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai help to get help.

Additionally, you can add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.

CodeRabbit Configration File (.coderabbit.yaml)

• You can programmatically configure CodeRabbit by adding a .coderabbit.yaml file to the root of your repository.
• Please see the configuration documentation for more information.
• If your editor has YAML language server enabled, you can add the path at the top of this file to enable auto-completion and validation: # yaml-language-server: $schema=https://coderabbit.ai/integrations/schema.v2.json

Documentation and Community

• Visit our Documentation for detailed information on how to use CodeRabbit.
• Join our Discord Community to get help, request features, and share feedback.
• Follow us on X/Twitter for updates and announcements.

[coderabbitai]

Actionable comments posted: 1

[johnmosesman]

Only need external endpoints and then +1