Skip to content

AGENTS: Using API_GROUP_VERSIONS generates incorrect openapi #2575

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

AGENTS: Using API_GROUP_VERSIONS generates incorrect openapi #2575

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions AGENTS.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -37,15 +37,23 @@ When working on a specific API group/version, you can regenerate only the affect

```bash
# Regenerate CRDs for a specific API group/version
make update-codegen-crds API_GROUP_VERSIONS=operator.openshift.io/v1alpha1
make update-codegen-crds API_GROUP_VERSIONS=config.openshift.io/v1
make update-codegen-crds API_GROUP_VERSIONS=route.openshift.io/v1
make update-codegen API_GROUP_VERSIONS=operator.openshift.io/v1alpha1
make update-codegen API_GROUP_VERSIONS=config.openshift.io/v1
make update-codegen API_GROUP_VERSIONS=route.openshift.io/v1

# Multiple API groups can be specified with comma separation
make update-codegen-crds API_GROUP_VERSIONS=operator.openshift.io/v1alpha1,config.openshift.io/v1
make update-codegen API_GROUP_VERSIONS=operator.openshift.io/v1alpha1,config.openshift.io/v1
```

This is more efficient than running `make update` (which regenerates all CRDs) when you're only working on specific API groups.
**Important:** While using `API_GROUP_VERSIONS` is faster for iteration (e.g., when developing tests),
it generates invalid OpenAPI data. This targeted generation is useful during development cycles, but you
**must run `make update`** (without `API_GROUP_VERSIONS`) to regenerate all files correctly before
committing changes. The full `make update` ensures all generated files, including OpenAPI schemas, are
properly synchronized.

**Workflow:**
- During iteration: `make update-codegen API_GROUP_VERSIONS=your.group/v1` (fast feedback)
- Before committing: `make update` (ensures correctness)

### Testing
```bash
Expand Down