Skip to content

feat: marking public APIs with annotations#3428

Draft
csviri wants to merge 8 commits into
operator-framework:nextfrom
csviri:public-api-annotation
Draft

feat: marking public APIs with annotations#3428
csviri wants to merge 8 commits into
operator-framework:nextfrom
csviri:public-api-annotation

Conversation

@csviri

@csviri csviri commented Jun 18, 2026 •
edited
Loading

Copy link
Copy Markdown
Collaborator

No description provided.

csviri and others added 7 commits June 17, 2026 14:26
@csviri
chore: update version to 999-SNAPSHOT
0bf061a 
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
@csviri
fix: set migration module version to correct one (operator-framework#…
c395262 
…3263)

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
@afalhambra-hivemq @csviri
feat(core): add by-name secondary resource lookup on Context (operato…
881fb19 
…r-framework#3373)
@csviri
improve: getSecondaryResourcesAsStream(expectedType,eventSourceName) …
41be22b 
…does not have to be Kubernetes resources (operator-framework#3377)

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
@csviri
improve: reconciliation counts as retry attempt only if close to retr…
3a58e7a 
…y deadline (operator-framework#3380)

Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
@csviri
feat: marking public APIs with annotations
b19869d 
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
@csviri
docs
e6350ad 
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
@openshift-ci openshift-ci Bot added the do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress. label Jun 18, 2026
@csviri csviri linked an issue Jun 18, 2026 that may be closed by this pull request
Marking public APIs with @Public annotation #3419
Open
@csviri
wip
e6dabe6 
Signed-off-by: Attila Mészáros <a_meszaros@apple.com>
xstefank
xstefank requested changes Jun 23, 2026
View reviewed changes

@xstefank xstefank left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

As we discussed on the meeting, I don't think introducing this kind of new API that we would need to continuously maitain would add much better approach of what is public and what is not. We should have a clearly defined rules, but users will not check this and we would need to remember to take care of keeping all annotations in check.

@csviri

csviri commented Jun 29, 2026 •
edited
Loading

Copy link
Copy Markdown
Collaborator Author

As we discussed on the meeting, I don't think introducing this kind of new API that we would need to continuously maitain would add much better approach of what is public and what is not. We should have a clearly defined rules, but users will not check this and we would need to remember to take care of keeping all annotations in check.

I'm also not fully convinced TBH either, will come back to this a bit later. Also we can discuss more in community calls.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@xstefank xstefank xstefank requested changes
Copilot code review Copilot Awaiting requested review from Copilot Copilot will automatically review once the pull request is marked ready for review

Assignees

No one assigned

Labels

do-not-merge/work-in-progress Indicates that a PR should not merge because it is a work in progress.

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Marking public APIs with @Public annotation

3 participants

@csviri @xstefank @afalhambra-hivemq