add server url to swagger ui spec

coderabbitai[bot] commented 3 months ago

Walkthrough

This update enhances the API documentation by incorporating environment-specific server information into the SwaggerUI. The PublicApiDocsApiEndpointsComponent now uses the ENV configuration to dynamically set server URLs. In addition, new styles improve the visual presentation of server elements, ensuring a smoother user experience when navigating the documentation.

Changes

Files	Change Summary
`app/components/public-api-docs/api-endpoints/index.ts`	Added import for `ENV`, defined `servers` constant, and integrated it into `SwaggerUI`.
`app/styles/_public-api.scss`	Introduced new styles for `.schemes-server-container`, `.servers-title`, and `.servers`.
`app/components/home-page/organization-dashboard/side-nav/index.ts`	Updated menu item label from `'apiDocument'` to `'apiDocumentation'` for clarity.
`app/components/public-api-docs/index.ts`	Commented out the schema entry in the exported array, removing the 'Schemas' section.
`.github/workflows/e2e-tests.yaml`	Added `wait-on-timeout: 200` to enhance timeout control in end-to-end tests.
`tests/integration/components/home-page/organization-dashboard/side-nav-test.js`	Updated label from `'t:apiDocument:()'` to `'t:apiDocumentation:()'` in the test file.
`translations/en.json`	Changed translation key from `"apiDocument"` to `"apiDocumentation"` for improved clarity.
`translations/ja.json`	Updated translation key from `"apiDocument"` to `"apiDocumentation"` for better accuracy.

Poem

🐇 In fields of code where rabbits play,
New paths of API light the way.
With ENV in tow, we hop along,
To Swagger's tune, we sing our song!
So let’s document each endpoint true,
For every dev, there's joy anew! 🌼

Thank you for using CodeRabbit. We offer it for free to the OSS community and would appreciate your support in helping us grow. If you find it useful, would you consider giving us a shout-out on your favorite social media?

Share

- [X](https://twitter.com/intent/tweet?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A&url=https%3A//coderabbit.ai) - [Mastodon](https://mastodon.social/share?text=I%20just%20used%20%40coderabbitai%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20the%20proprietary%20code.%20Check%20it%20out%3A%20https%3A%2F%2Fcoderabbit.ai) - [Reddit](https://www.reddit.com/submit?title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&text=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code.%20Check%20it%20out%3A%20https%3A//coderabbit.ai) - [LinkedIn](https://www.linkedin.com/sharing/share-offsite/?url=https%3A%2F%2Fcoderabbit.ai&mini=true&title=Great%20tool%20for%20code%20review%20-%20CodeRabbit&summary=I%20just%20used%20CodeRabbit%20for%20my%20code%20review%2C%20and%20it%27s%20fantastic%21%20It%27s%20free%20for%20OSS%20and%20offers%20a%20free%20trial%20for%20proprietary%20code)

Tips

### Chat There are 3 ways to chat with [CodeRabbit](https://coderabbit.ai): - Review comments: Directly reply to a review comment made by CodeRabbit. Example: - `I pushed a fix in commit .` - `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.` - `@coderabbitai help me debug CodeRabbit configuration file.` 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 an incremental review. This is useful when automatic reviews are disabled for the repository. - `@coderabbitai full review` to do a full review from scratch and review all the files again. - `@coderabbitai summary` to regenerate the summary of the PR. - `@coderabbitai resolve` resolve all the CodeRabbit review comments. - `@coderabbitai configuration` to show the current CodeRabbit configuration for the repository. - `@coderabbitai help` to get help. Additionally, you can add `@coderabbitai ignore` anywhere in the PR description to prevent this PR from being reviewed. ### CodeRabbit Configuration 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](https://docs.coderabbit.ai/guides/configure-coderabbit) 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](https://coderabbit.ai/docs) for detailed information on how to use CodeRabbit. - Join our [Discord Community](https://discord.com/invite/GsXnASn26c) to get help, request features, and share feedback. - Follow us on [X/Twitter](https://twitter.com/coderabbitai) for updates and announcements.

cloudflare-workers-and-pages[bot] commented 3 months ago

Deploying irenestaging with Cloudflare Pages

Latest commit:	`2bc00f0`
Status:	✅ Deploy successful!
Preview URL:	https://7d4e4d13.irenestaging.pages.dev
Branch Preview URL:	https://pd-1393-public-api-docs-inte.irenestaging.pages.dev

View logs

cypress[bot] commented 3 months ago

Test summary

8 • 1 • 0 • 1

Run details


Project	Irene
Status	Failed
Commit	f4ecf09a33
Started	Aug 19, 2024 10:16 AM
Ended	Aug 19, 2024 10:19 AM
Duration	03:27 💡
OS	Linux Debian -
Browser	Chrome 123

View run in Cypress Cloud ➡️

Failures

	cypress/tests/dynamic-scan.spec.ts		1
1	Dynamic Scan > it tests dynamic scan for an apk file: 58062

This comment has been generated by cypress-bot as a result of this project's GitHub integration settings. You can manage this integration in this project's settings in the Cypress Cloud