Skip to content

Add OpenAPI documentation for scorecards endpoints #3433

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

Merged
nogates merged 1 commit into from
Apr 8, 2026
Merged

Add OpenAPI documentation for scorecards endpoints #3433

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
1,046 changes: 1,007 additions & 39 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

0 ...d-Request-response_4112202994/frozen.json → ...d-Request-response_4112202994/frozen.json
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion ...Request-response_4112202994/recording.har → ...Request-response_4112202994/recording.har
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"log": {
"_recordingName": "Service Scorecards/Create a new rule returns \"Bad Request\" response",
"_recordingName": "Scorecards/Create a new rule returns \"Bad Request\" response",
"creator": {
"comment": "persister:fs",
"name": "Polly.JS",
Expand Down
0 ...ns-Created-response_522570232/frozen.json → ...ns-Created-response_522570232/frozen.json
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion ...-Created-response_522570232/recording.har → ...-Created-response_522570232/recording.har
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"log": {
"_recordingName": "Service Scorecards/Create a new rule returns \"Created\" response",
"_recordingName": "Scorecards/Create a new rule returns \"Created\" response",
"creator": {
"comment": "persister:fs",
"name": "Polly.JS",
Expand Down
0 ...d-Request-response_4200540942/frozen.json → ...d-Request-response_4200540942/frozen.json
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion ...Request-response_4200540942/recording.har → ...Request-response_4200540942/recording.har
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"log": {
"_recordingName": "Service Scorecards/Create outcomes batch returns \"Bad Request\" response",
"_recordingName": "Scorecards/Create outcomes batch returns \"Bad Request\" response",
"creator": {
"comment": "persister:fs",
"name": "Polly.JS",
Expand Down
0 ...eturns-OK-response_3991487588/frozen.json → ...eturns-OK-response_3991487588/frozen.json
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion ...urns-OK-response_3991487588/recording.har → ...urns-OK-response_3991487588/recording.har
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"log": {
"_recordingName": "Service Scorecards/Create outcomes batch returns \"OK\" response",
"_recordingName": "Scorecards/Create outcomes batch returns \"OK\" response",
"creator": {
"comment": "persister:fs",
"name": "Polly.JS",
Expand Down
0 ...-Not-Found-response_164235844/frozen.json → ...-Not-Found-response_164235844/frozen.json
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion ...ot-Found-response_164235844/recording.har → ...ot-Found-response_164235844/recording.har
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"log": {
"_recordingName": "Service Scorecards/Delete a rule returns \"Not Found\" response",
"_recordingName": "Scorecards/Delete a rule returns \"Not Found\" response",
"creator": {
"comment": "persister:fs",
"name": "Polly.JS",
Expand Down
0 ...eturns-OK-response_1881171271/frozen.json → ...eturns-OK-response_1881171271/frozen.json
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion ...urns-OK-response_1881171271/recording.har → ...urns-OK-response_1881171271/recording.har
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"log": {
"_recordingName": "Service Scorecards/Delete a rule returns \"OK\" response",
"_recordingName": "Scorecards/Delete a rule returns \"OK\" response",
"creator": {
"comment": "persister:fs",
"name": "Polly.JS",
Expand Down
0 ...eturns-OK-response_1077715861/frozen.json → ...eturns-OK-response_1077715861/frozen.json
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion ...urns-OK-response_1077715861/recording.har → ...urns-OK-response_1077715861/recording.har
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"log": {
"_recordingName": "Service Scorecards/Get all rules returns \"OK\" response",
"_recordingName": "Scorecards/Get all rules returns \"OK\" response",
"creator": {
"comment": "persister:fs",
"name": "Polly.JS",
Expand Down
0 ...se-with-pagination_1119793127/frozen.json → ...se-with-pagination_1119793127/frozen.json
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion ...-with-pagination_1119793127/recording.har → ...-with-pagination_1119793127/recording.har
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"log": {
"_recordingName": "Service Scorecards/List all rule outcomes returns \"OK\" response with pagination",
"_recordingName": "Scorecards/List all rule outcomes returns \"OK\" response with pagination",
"creator": {
"comment": "persister:fs",
"name": "Polly.JS",
Expand Down
0 ...returns-OK-response_427126415/frozen.json → ...returns-OK-response_427126415/frozen.json
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion ...turns-OK-response_427126415/recording.har → ...turns-OK-response_427126415/recording.har
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"log": {
"_recordingName": "Service Scorecards/List all rule outcomes returns \"OK\" response",
"_recordingName": "Scorecards/List all rule outcomes returns \"OK\" response",
"creator": {
"comment": "persister:fs",
"name": "Polly.JS",
Expand Down
0 ...se-with-pagination_1123075563/frozen.json → ...se-with-pagination_1123075563/frozen.json
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion ...-with-pagination_1123075563/recording.har → ...-with-pagination_1123075563/recording.har
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"log": {
"_recordingName": "Service Scorecards/List all rules returns \"OK\" response with pagination",
"_recordingName": "Scorecards/List all rules returns \"OK\" response with pagination",
"creator": {
"comment": "persister:fs",
"name": "Polly.JS",
Expand Down
0 ...eturns-OK-response_4242635547/frozen.json → ...eturns-OK-response_4242635547/frozen.json
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion ...urns-OK-response_4242635547/recording.har → ...urns-OK-response_4242635547/recording.har
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"log": {
"_recordingName": "Service Scorecards/List all rules returns \"OK\" response",
"_recordingName": "Scorecards/List all rules returns \"OK\" response",
"creator": {
"comment": "persister:fs",
"name": "Polly.JS",
Expand Down
0 ...-Accepted-response_3550004421/frozen.json → ...-Accepted-response_3550004421/frozen.json
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion ...ccepted-response_3550004421/recording.har → ...ccepted-response_3550004421/recording.har
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"log": {
"_recordingName": "Service Scorecards/Update Scorecard outcomes asynchronously returns \"Accepted\" response",
"_recordingName": "Scorecards/Update Scorecard outcomes asynchronously returns \"Accepted\" response",
"creator": {
"comment": "persister:fs",
"name": "Polly.JS",
Expand Down
0 ...d-Request-response_3858316768/frozen.json → ...d-Request-response_3858316768/frozen.json
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion ...Request-response_3858316768/recording.har → ...Request-response_3858316768/recording.har
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"log": {
"_recordingName": "Service Scorecards/Update Scorecard outcomes asynchronously returns \"Bad Request\" response",
"_recordingName": "Scorecards/Update Scorecard outcomes asynchronously returns \"Bad Request\" response",
"creator": {
"comment": "persister:fs",
"name": "Polly.JS",
Expand Down
0 ...-Conflict-response_2488160814/frozen.json → ...-Conflict-response_2488160814/frozen.json
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion ...onflict-response_2488160814/recording.har → ...onflict-response_2488160814/recording.har
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"log": {
"_recordingName": "Service Scorecards/Update Scorecard outcomes asynchronously returns \"Conflict\" response",
"_recordingName": "Scorecards/Update Scorecard outcomes asynchronously returns \"Conflict\" response",
"creator": {
"comment": "persister:fs",
"name": "Polly.JS",
Expand Down
0 ...cessfully-response_2113887026/frozen.json → ...cessfully-response_2113887026/frozen.json
View file
Open in desktop
File renamed without changes.
8 changes: 4 additions & 4 deletions ...ssfully-response_2113887026/recording.har → ...ssfully-response_2113887026/recording.har
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"log": {
"_recordingName": "Service Scorecards/Update an existing rule returns \"Rule updated successfully\" response",
"_recordingName": "Scorecards/Update an existing rule returns \"Rule updated successfully\" response",
"creator": {
"comment": "persister:fs",
"name": "Polly.JS",
Expand Down Expand Up @@ -61,11 +61,11 @@
"time": 118
},
{
"_id": "c173c2c3af4ee37c6f4319a3182dd04d",
"_id": "14405d8c52a73cea87ac1473d69830e0",
"_order": 0,
"cache": {},
"request": {
"bodySize": 229,
"bodySize": 243,
"cookies": [],
"headers": [
{
Expand All @@ -85,7 +85,7 @@
"postData": {
"mimeType": "application/json",
"params": [],
"text": "{\"data\":{\"attributes\":{\"description\":\"Updated description via test\",\"enabled\":true,\"name\":\"Test-Update_an_existing_rule_returns_Rule_updated_successfully_response-1722307632\",\"scorecard_name\":\"OpenAPI Spec Test Best Practices\"}}}"
"text": "{\"data\":{\"attributes\":{\"description\":\"Updated description via test\",\"enabled\":true,\"name\":\"Test-Update_an_existing_rule_returns_Rule_updated_successfully_response-1722307632\",\"scorecard_name\":\"OpenAPI Spec Test Best Practices\"},\"type\":\"rule\"}}"
},
"queryString": [],
"url": "https://api.datadoghq.com/api/v2/scorecard/rules/L2uJseIxQCRLg_2z"
Expand Down
0 ...d-Request-response_3943964706/frozen.json → ...d-Request-response_3943964706/frozen.json
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion ...Request-response_3943964706/recording.har → ...Request-response_3943964706/recording.har
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"log": {
"_recordingName": "Service Scorecards/Update an existing scorecard rule returns \"Bad Request\" response",
"_recordingName": "Scorecards/Update an existing scorecard rule returns \"Bad Request\" response",
"creator": {
"comment": "persister:fs",
"name": "Polly.JS",
Expand Down
0 ...-Not-Found-response_955343473/frozen.json → ...-Not-Found-response_955343473/frozen.json
View file
Open in desktop
File renamed without changes.
2 changes: 1 addition & 1 deletion ...ot-Found-response_955343473/recording.har → ...ot-Found-response_955343473/recording.har
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
{
"log": {
"_recordingName": "Service Scorecards/Update an existing scorecard rule returns \"Not Found\" response",
"_recordingName": "Scorecards/Update an existing scorecard rule returns \"Not Found\" response",
"creator": {
"comment": "persister:fs",
"name": "Polly.JS",
Expand Down
2 changes: 1 addition & 1 deletion features/v2/given.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -1087,7 +1087,7 @@
],
"step": "there is a valid \"create_scorecard_rule\" in the system",
"key": "create_scorecard_rule",
"tag": "Service Scorecards",
"tag": "Scorecards",
"operationId": "CreateScorecardRule"
},
{
Expand Down
Loading
Loading