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

feat(api): add annotations #719

Merged
merged 1 commit into from
Sep 29, 2023
Merged

feat(api): add annotations #719

merged 1 commit into from
Sep 29, 2023

Conversation

paralta
Copy link
Contributor

@paralta paralta commented Sep 28, 2023

Description

  • Add annotations API object to close Add annotations field to root level API objects #718
  • BaseAPIObject is intended to include a Metadata object as well
  • All the main API objects (like assets, asset scans, etc) should contain this new BaseAPIObject property (to be added in a separate PR per object)

Please let me know if you have any naming alternatives specially for BaseAPIObject , thanks!

Type of Change

[ ] Bug Fix
[x] New Feature
[ ] Breaking Change
[ ] Refactor
[ ] Documentation
[ ] Other (please describe)

Checklist

  • I have read the contributing guidelines
  • Existing issues have been referenced (where applicable)
  • I have verified this change is not present in other open pull requests
  • Functionality is documented
  • All code style checks pass
  • New code contribution is covered by automated tests
  • All new and existing tests pass

@paralta paralta added the component:api Issues related to API label Sep 28, 2023
@paralta paralta self-assigned this Sep 28, 2023
@paralta paralta marked this pull request as ready for review September 28, 2023 12:31
@paralta paralta requested a review from a team as a code owner September 28, 2023 12:31
FrimIdan
FrimIdan reviewed Sep 28, 2023
View reviewed changes
api/openapi.yaml Outdated Show resolved Hide resolved
fishkerez
fishkerez reviewed Sep 28, 2023
View reviewed changes
api/openapi.yaml Outdated Show resolved Hide resolved
chrisgacsal
chrisgacsal approved these changes Sep 29, 2023
View reviewed changes
Copy link
Contributor

@chrisgacsal chrisgacsal left a comment

Choose a reason for hiding this comment

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

LGTM!

@paralta paralta added this pull request to the merge queue Sep 29, 2023
Merged via the queue into main with commit 0f5e273 Sep 29, 2023
10 checks passed
@paralta paralta deleted the issue718-annotations branch September 29, 2023 09:38
@chrisgacsal chrisgacsal mentioned this pull request Nov 6, 2023
Merged
7 tasks
@chrisgacsal chrisgacsal mentioned this pull request Feb 21, 2024
Merged
7 tasks
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@Tehsmash Tehsmash Tehsmash left review comments

@FrimIdan FrimIdan FrimIdan left review comments

@fishkerez fishkerez fishkerez left review comments

@chrisgacsal chrisgacsal chrisgacsal approved these changes

Assignees

@paralta paralta

Labels
component:api Issues related to API
Projects
OpenClarity
Status: Done
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

Add annotations field to root level API objects
5 participants
@paralta @Tehsmash @chrisgacsal @FrimIdan @fishkerez