Skip to content
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

Jump to bottom

TOI doc says ExecutorSpecification:resourceRef is an array when it is an optional field #339

Closed
dee0 opened this issue Dec 15, 2024 · 0 comments · Fixed by open-component-model/ocm#1196
Closed

TOI doc says ExecutorSpecification:resourceRef is an array when it is an optional field #339

dee0 opened this issue Dec 15, 2024 · 0 comments · Fixed by open-component-model/ocm#1196
Labels
area/ipcei Important Project of Common European Interest kind/bugfix Bug

Comments

@dee0
Copy link

dee0 commented Dec 15, 2024

What happened:

The doc here shows

resourceRef []ResourceReference

. But here I see

ResourceRef       *metav1.ResourceReference `json:"resourceRef,omitempty"`

What you expected to happen:

Expect the doc to match the code :)

How to reproduce it (as minimally and precisely as possible):

Just compare the doc to the code

Anything else we need to know:

Nope

Environment:

Current doc and code as of 2024-12-14 20:37 Pacific Time
@dee0 dee0 added the kind/bugfix Bug label Dec 15, 2024
@github-actions github-actions bot added the area/ipcei Important Project of Common European Interest label Dec 15, 2024
@mandelsoft mandelsoft mentioned this issue Dec 16, 2024
Merged
hilmarf pushed a commit to open-component-model/ocm that referenced this issue Dec 16, 2024
@mandelsoft
fix: fix toi doc (#1196)
b41f962 
<!-- markdownlint-disable MD041 -->
#### What this PR does / why we need it

The command doc for ocm toi-bootstrapping shows the wrong type for the
reference to a TOI executor.

#### Which issue(s) this PR fixes

Fixes
[#339](open-component-model/ocm-project#339)
@github-project-automation github-project-automation bot moved this from 🆕 ToDo to 🍺 Done in OCM Backlog Board Dec 16, 2024
@ocmbot ocmbot bot moved this from 🍺 Done to 🔒Closed in OCM Backlog Board Dec 27, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
area/ipcei Important Project of Common European Interest kind/bugfix Bug
Projects
OCM Backlog Board
Status: 🔒Closed
Milestone
No milestone
Development

Successfully merging a pull request may close this issue.

fix: fix toi doc mandelsoft/ocm
1 participant
@dee0