do not generate spec for /livez or /readyz

[jordane]

No description provided.

[coderabbitai]

Walkthrough

Added swagger generation suppression metadata to the readyz and livez endpoints in design/query-svc.go using dsl.Meta("swagger:generate", "false"). No other changes to routes, results, or errors.

Changes

Cohort / File(s)	Summary
API design metadata design/query-svc.go	Inserted dsl.Meta("swagger:generate", "false") on readyz and livez endpoints to suppress Swagger generation; no functional or signature changes.

Estimated code review effort

🎯 1 (Trivial) | ⏱️ ~3 minutes

Tip

🔌 Remote MCP (Model Context Protocol) integration is now available!

Pro plan users can now connect to remote MCP servers from the Integrations page. Connect with popular remote MCPs such as Notion and Linear to add more context to your reviews and chats.

---

📜 Recent review details

Configuration used: CodeRabbit UI
Review profile: CHILL
Plan: Pro

💡 Knowledge Base configuration:

• MCP integration is disabled by default for public repositories
• Jira integration is disabled by default for public repositories
• Linear integration is disabled by default for public repositories

You can enable these sources in your CodeRabbit configuration.

📥 Commits

Reviewing files that changed from the base of the PR and between 0cc6d05 and 063b69c.

⛔ Files ignored due to path filters (4)

• gen/http/openapi.json is excluded by !**/gen/**
• gen/http/openapi.yaml is excluded by !**/gen/**
• gen/http/openapi3.json is excluded by !**/gen/**
• gen/http/openapi3.yaml is excluded by !**/gen/**

📒 Files selected for processing (1)

• design/query-svc.go (2 hunks)

🧰 Additional context used

📓 Path-based instructions (1)

design/**

📄 CodeRabbit Inference Engine (CLAUDE.md)

design/**: After design changes in the design/ directory, always run make apigen to regenerate API code
Design specifications for the API should be placed in the design/ directory

Files:

• design/query-svc.go

⏰ Context from checks skipped due to timeout of 90000ms. You can increase the timeout in your CodeRabbit configuration to a maximum of 15 minutes (900000ms). (2)

• GitHub Check: MegaLinter
• GitHub Check: Build and Test

🔇 Additional comments (2)

design/query-svc.go (2)

90-90: OpenAPI readyz/livez suppression confirmed
Added the dsl.Meta("openapi:generate", "false") alongside the existing Swagger meta and reran codegen; both gen/http/openapi3.json and gen/http/openapi.json no longer contain /readyz or /livez.

---

110-110: Correct Goa v3 meta key to disable Swagger generation

In Goa v3 the only supported key for disabling Swagger/OpenAPI codegen is

dsl.Meta("swagger:generate", "false")

The openapi:generate metadata was introduced in Goa v4+, so you can omit it here.

Likely an incorrect or invalid review comment.

✨ Finishing Touches

• 📝 Generate Docstrings

🧪 Generate unit tests

• Create PR with unit tests
• Post copyable unit tests in a comment
• Commit unit tests in branch jme/LFXV2-321

---

🪧 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.
  • 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.
• 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 the files in the src/scheduler package and generate a class diagram using mermaid and a README in the markdown format.

Support

Need help? Create a ticket on our support page for assistance with any issues or questions.

CodeRabbit Commands (Invoked using PR/Issue comments)

Type @coderabbitai help to get the list of available commands.

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.

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 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

Status, Documentation and Community

• Visit our Status Page to check the current availability of CodeRabbit.
• 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]

Pull Request Overview

This PR removes the health check endpoints (/livez and /readyz) from the generated OpenAPI specifications to simplify the public API documentation. These endpoints are typically for internal infrastructure use and don't need to be exposed in client-facing API specs.

• Added swagger:generate metadata to exclude health check endpoints from OpenAPI generation
• Removed /livez and /readyz endpoints from all generated OpenAPI files
• Cleaned up related error schemas that are no longer needed

Reviewed Changes

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

Show a summary per file

File	Description
design/query-svc.go	Added metadata to exclude health check endpoints from Swagger generation
gen/http/openapi3.yaml	Removed /livez and /readyz endpoints and unused Error schema
gen/http/openapi3.json	Removed health check endpoints from JSON specification
gen/http/openapi.yaml	Removed health check endpoints from Swagger 2.0 specification
gen/http/openapi.json	Removed health check endpoints from Swagger 2.0 JSON specification

---

_{Tip: Customize your code reviews with copilot-instructions.md. Create the file or learn how to get started.}