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.

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

[Tooling] Remove some OpenAPI warning and docker build warning #1336

Merged
merged 1 commit into from
Jul 30, 2024

Conversation

tbavelier
Copy link
Member

What does this PR do?

Motivation

  • Warnings sent when using make generate-openapi / make docker-build :
vscode ➜ /workspaces/datadog-operator (main) $ make generate-openapi
bin/linux-aarch64/openapi-gen --logtostderr=true -o "./" -i ./apis/datadoghq/v1alpha1 -O zz_generated.openapi -p ./apis/datadoghq/v1alpha1 -h ./hack/boilerplate.go.txt -r "-"
API rule violation: list_type_missing,./apis/datadoghq/v1alpha1,DatadogMonitorOptions,NotifyBy
API rule violation: list_type_missing,./apis/datadoghq/v1alpha1,DatadogMonitorOptions,RenotifyStatuses
API rule violation: names_match,./apis/datadoghq/v1alpha1,DatadogMonitorDowntimeStatus,DowntimeID
API rule violation: names_match,./apis/datadoghq/v1alpha1,DatadogMonitorStatus,MonitorStateSyncStatus
bin/linux-aarch64/openapi-gen --logtostderr=true -o "./" -i ./apis/datadoghq/v2alpha1 -O zz_generated.openapi -p ./apis/datadoghq/v2alpha1 -h ./hack/boilerplate.go.txt -r "-"

and

 1 warning found (use docker --debug to expand):
 - FromAsCasing: 'as' and 'FROM' keywords' casing do not match (line 2)

Additional Notes

  • Following this PR, 2 warnings remain :
API rule violation: names_match,./apis/datadoghq/v1alpha1,DatadogMonitorDowntimeStatus,DowntimeID
API rule violation: names_match,./apis/datadoghq/v1alpha1,DatadogMonitorStatus,MonitorStateSyncStatus

The "required" changes to get rid of these warnings have adverse consequences (e.g. modifying the JSON spec) or symbol renaming, so they're not in scope

Minimum Agent Versions

Are there minimum versions of the Datadog Agent and/or Cluster Agent required?

  • Agent: vX.Y.Z
  • Cluster Agent: vX.Y.Z

Describe your test plan

Write there any instructions and details you may have to test your PR.

Checklist

  • PR has at least one valid label: bug, enhancement, refactoring, documentation, tooling, and/or dependencies
  • PR has a milestone or the qa/skip-qa label

@tbavelier tbavelier marked this pull request as ready for review July 30, 2024 13:51
@tbavelier tbavelier requested a review from a team as a code owner July 30, 2024 13:51
@codecov-commenter
Copy link

codecov-commenter commented Jul 30, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 47.51%. Comparing base (b30f915) to head (bb5b9b7).

Additional details and impacted files

Impacted file tree graph

@@           Coverage Diff           @@
##             main    #1336   +/-   ##
=======================================
  Coverage   47.51%   47.51%           
=======================================
  Files         230      230           
  Lines       22040    22040           
=======================================
  Hits        10472    10472           
  Misses      10976    10976           
  Partials      592      592           
Flag Coverage Δ
unittests 47.51% <ø> (ø)

Flags with carried forward coverage won't be shown. Click here to find out more.

Files Coverage Δ
apis/datadoghq/v1alpha1/datadogmonitor_types.go 100.00% <ø> (ø)

Continue to review full report in Codecov by Sentry.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update b30f915...bb5b9b7. Read the comment docs.

@fanny-jiang fanny-jiang merged commit ca6ce6c into main Jul 30, 2024
23 checks passed
@fanny-jiang fanny-jiang deleted the tbavelier/fix_openapi_warning branch July 30, 2024 20:11
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants