Skip to content

Custom Framework API Spec #28798

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

Merged

Conversation

api-clients-generation-pipeline[bot]
Copy link
Contributor

@api-clients-generation-pipeline api-clients-generation-pipeline bot requested a review from a team as a code owner April 15, 2025 21:24
@github-actions github-actions bot added the Architecture Everything related to the Doc backend label Apr 15, 2025
Copy link
Contributor

@aliciascott aliciascott left a comment

Choose a reason for hiding this comment

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

Hi @nkonjeti there are some formatting snafu's that need fixed along with requested changes in https://github.com/DataDog/datadog-api-spec/pull/3739.
Let me know once fixed and we can re-review. Thanks!

origin: request
source: data.attributes.version
type: unsafe
x-unstable: '**Note**: This endpoint is in beta and may be subject to changes.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
x-unstable: '**Note**: This endpoint is in beta and may be subject to changes.
x-unstable: **Note**: This endpoint is in Preview and may be subject to changes.

type: unsafe
x-unstable: '**Note**: This endpoint is in beta and may be subject to changes.

Please check the documentation regularly for updates.'
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Please check the documentation regularly for updates.'
Please check the documentation regularly for updates.

- security_monitoring_rules_write
x-undo:
type: idempotent
x-unstable: '**Note**: This endpoint is in beta and may be subject to changes.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
x-unstable: '**Note**: This endpoint is in beta and may be subject to changes.
x-unstable: **Note**: This endpoint is in beta and may be subject to changes.

- security_monitoring_rules_write
x-undo:
type: idempotent
x-unstable: '**Note**: This endpoint is in beta and may be subject to changes.
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
x-unstable: '**Note**: This endpoint is in beta and may be subject to changes.
x-unstable: **Note**: This endpoint is in beta and may be subject to changes.

type: idempotent
x-unstable: '**Note**: This endpoint is in beta and may be subject to changes.

Please check the documentation regularly for updates.'
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
Please check the documentation regularly for updates.'
Please check the documentation regularly for updates.

}
"type": "idempotent"
},
"x-unstable": "**Note**: This endpoint is in beta and may be subject to changes.\nPlease check the documentation regularly for updates."
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
"x-unstable": "**Note**: This endpoint is in beta and may be subject to changes.\nPlease check the documentation regularly for updates."
"x-unstable": **Note**: This endpoint is in Preview and may be subject to changes.\nPlease check the documentation regularly for updates."

],
"type": "unsafe"
},
"x-unstable": "**Note**: This endpoint is in beta and may be subject to changes.\nPlease check the documentation regularly for updates."
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
"x-unstable": "**Note**: This endpoint is in beta and may be subject to changes.\nPlease check the documentation regularly for updates."
"x-unstable": **Note**: This endpoint is in beta and may be subject to changes.\nPlease check the documentation regularly for updates."

"x-undo": {
"type": "idempotent"
},
"x-unstable": "**Note**: This endpoint is in beta and may be subject to changes.\nPlease check the documentation regularly for updates."
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
"x-unstable": "**Note**: This endpoint is in beta and may be subject to changes.\nPlease check the documentation regularly for updates."
"x-unstable": **Note**: This endpoint is in beta and may be subject to changes.\nPlease check the documentation regularly for updates."

@api-clients-generation-pipeline api-clients-generation-pipeline bot force-pushed the datadog-api-spec/generated/3739 branch from cef2bb3 to bf2b140 Compare April 22, 2025 17:30
@api-clients-generation-pipeline api-clients-generation-pipeline bot force-pushed the datadog-api-spec/generated/3739 branch 13 times, most recently from cca0147 to 5496930 Compare April 28, 2025 15:34
Copy link
Contributor

@aliciascott aliciascott left a comment

Choose a reason for hiding this comment

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

One small comment in the DeleteCustomFramework that is missing a description, but approved

"json": {
"data": {
"attributes": {
"description": "this is an example description",
Copy link
Contributor

Choose a reason for hiding this comment

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

Suggested change
"description": "this is an example description",
"description": "this is an example description",

Small suggestion, should this be filled out with the actual description ?

Choose a reason for hiding this comment

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

oh the description was "this is an example description" I will try to think of a better example

Copy link
Contributor

Choose a reason for hiding this comment

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

ok thanks for the context there! I think this is probably fine, I was just missing the context.

@api-clients-generation-pipeline api-clients-generation-pipeline bot force-pushed the datadog-api-spec/generated/3739 branch from 5496930 to b80f645 Compare April 28, 2025 17:19
@api-clients-generation-pipeline api-clients-generation-pipeline bot force-pushed the datadog-api-spec/generated/3739 branch from b80f645 to 4bf4fd4 Compare April 29, 2025 16:15
@api-clients-generation-pipeline api-clients-generation-pipeline bot merged commit 7cb6eb7 into master Apr 29, 2025
9 checks passed
@api-clients-generation-pipeline api-clients-generation-pipeline bot deleted the datadog-api-spec/generated/3739 branch April 29, 2025 17:10
estherk15 pushed a commit that referenced this pull request May 8, 2025
Co-authored-by: ci.datadog-api-spec <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Architecture Everything related to the Doc backend changelog/no-changelog
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants