fix: Kotlin Openapi

[zacharyblasczyk]

Github issue: fabrikt-io/fabrikt#264

Summary by CodeRabbit

• New Features
  • Introduced a consolidated API representation for system details that now encompasses related environments and deployments, streamlining the response structure for improved clarity and maintainability.

[coderabbitai]

Walkthrough

The changes introduce a new OpenAPI schema, SystemWithEnvironmentsAndDeployments, which combines the existing System schema with added environments and deployments arrays. Additionally, two API definitions have been updated to reference this consolidated schema instead of using an allOf construct. These modifications streamline the API specification and improve its clarity.

Changes

File(s)	Change Summary
apps/webservice/.../api/v1/openapi.ts	Added new schema SystemWithEnvironmentsAndDeployments in the components section, using allOf to merge System with additional environments and deployments arrays.
apps/webservice/.../api/v1/systems/[systemId]/openapi.ts, openapi.v1.json	Updated GET response schema references to directly use $ref: "#/components/schemas/SystemWithEnvironmentsAndDeployments", replacing the previous composite allOf structure.

Possibly related PRs

• fix: Create deployment endpoints #296: Updates the API response schema to use the new SystemWithEnvironmentsAndDeployments, directly relating to the schema changes introduced here.

Poem

I'm a rabbit with a hop in my code,
Leaping through schemas on a streamlined road.
New fields blossom, environments and deploys in view,
Celebrating neat changes with a bounce anew 🐇.
Happy coding, let your APIs renew!

Tip

⚡💬 Agentic Chat (Pro Plan, General Availability)

• We're introducing multi-step agentic chat in review comments and issue comments, within and outside of PR's. This feature enhances review and issue discussions with the CodeRabbit agentic chat by enabling advanced interactions, including the ability to create pull requests directly from comments and add commits to existing pull requests.

---

📜 Recent review details

Configuration used: .coderabbit.yaml
Review profile: CHILL
Plan: Pro

📥 Commits

Reviewing files that changed from the base of the PR and between 9b36d91 and 86fd5d9.

📒 Files selected for processing (3)

• apps/webservice/src/app/api/v1/openapi.ts (1 hunks)
• apps/webservice/src/app/api/v1/systems/[systemId]/openapi.ts (1 hunks)
• openapi.v1.json (2 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

`**/*.{ts,tsx}`: **Note on Error Handling:** Avoid strict enforcement of try/catch blocks. Code may use early returns, Promise chains (.then().catch()), or other patterns for error...

**/*.{ts,tsx}: Note on Error Handling:
Avoid strict enforcement of try/catch blocks. Code may use early returns, Promise chains (.then().catch()), or other patterns for error handling. These are acceptable as long as they maintain clarity and predictability.

• apps/webservice/src/app/api/v1/openapi.ts
• apps/webservice/src/app/api/v1/systems/[systemId]/openapi.ts

⏰ Context from checks skipped due to timeout of 90000ms (3)

• GitHub Check: build (linux/amd64)
• GitHub Check: Typecheck
• GitHub Check: Lint

🔇 Additional comments (4)

apps/webservice/src/app/api/v1/openapi.ts (1)

334-351: Well-structured schema addition that enhances code organization.

The new SystemWithEnvironmentsAndDeployments schema effectively uses the allOf pattern to extend the base System schema with arrays of related environments and deployments. This approach follows the DRY principle by creating a reusable schema that can be referenced throughout the API specification, rather than duplicating this structure in multiple places.

The schema is well-defined with appropriate references to the Environment and Deployment schemas for the array items.

apps/webservice/src/app/api/v1/systems/[systemId]/openapi.ts (1)

29-29: Good simplification of schema reference.

This change improves the API specification by replacing what was likely a more complex structure with a direct reference to the newly created SystemWithEnvironmentsAndDeployments schema. This approach promotes consistency across the API and improves maintainability by centralizing the schema definition.

openapi.v1.json (2)

2541-2541: Appropriate schema reference update.

The schema reference has been correctly updated to use the newly defined SystemWithEnvironmentsAndDeployments schema, ensuring consistent responses when retrieving system information via the API.

---

4044-4068: Consistent schema implementation across OpenAPI definitions.

The implementation of SystemWithEnvironmentsAndDeployments matches the TypeScript definition, properly using the allOf construct to extend the base System schema with environment and deployment arrays. This ensures consistency between different representations of the API specification.

✨ Finishing Touches

• 📝 Generate Docstrings

---

Thanks for using CodeRabbit! It's free for OSS, and your support helps us grow. If you like it, consider giving us a shout-out.

❤️ Share

• X
• Mastodon
• Reddit
• LinkedIn

🪧 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>, please review it.
  • 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 gather interesting stats about this repository and render them as a table. Additionally, render a pie chart showing the language distribution in the codebase.
  • @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 using 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 generate docstrings to generate docstrings for this PR.
• @coderabbitai resolve resolve all the CodeRabbit review comments.
• @coderabbitai plan to trigger planning for file edits and PR creation.
• @coderabbitai configuration to show the current CodeRabbit configuration for the repository.
• @coderabbitai help to get help.

Other keywords and placeholders

• Add @coderabbitai ignore anywhere in the PR description to prevent this PR from being reviewed.
• Add @coderabbitai summary to generate the high-level summary at a specific location in the PR description.
• Add @coderabbitai anywhere in the PR title to generate the title automatically.

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.

[Copilot]

Copilot reviewed 2 out of 3 changed files in this pull request and generated no comments.

Files not reviewed (1)

• openapi.v1.json: Language not supported

Comments suppressed due to low confidence (2)

apps/webservice/src/app/api/v1/systems/[systemId]/openapi.ts:29

• Ensure that API tests are updated to validate responses against the new 'SystemWithEnvironmentsAndDeployments' schema reference.

$ref: "#/components/schemas/SystemWithEnvironmentsAndDeployments"

apps/webservice/src/app/api/v1/openapi.ts:334

• Confirm that comprehensive tests cover the new 'SystemWithEnvironmentsAndDeployments' schema to ensure correct serialization of 'environments' and 'deployments' properties.

SystemWithEnvironmentsAndDeployments: {