Skip to content

Add missing response examples to all v1 and v2 spec operations [AAWF-1196] #3764

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

Open
api-clients-generation-pipeline wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Add missing response examples to all v1 and v2 spec operations [AAWF-1196] #3764

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
2,151 changes: 2,140 additions & 11 deletions .generator/schemas/v1/openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

10,028 changes: 9,983 additions & 45 deletions .generator/schemas/v2/openapi.yaml
View file
Open in desktop

Large diffs are not rendered by default.

4 changes: 2 additions & 2 deletions examples/v2/llm-observability/CreateLLMObsAnnotationQueue.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ public static void main(String[] args) {
.description("Rating of the response quality.")
.hasAssessment(false)
.hasReasoning(false)
.id("ab12cd34")
.id("abc-123")
.isAssessment(false)
.isInteger(false)
.isRequired(true)
Expand All @@ -44,7 +44,7 @@ public static void main(String[] args) {
.values(Arrays.asList("good", "bad", "neutral")))))
.description("Queue for annotating customer support traces")
.name("My annotation queue")
.projectId("a33671aa-24fd-4dcd-9b33-a8ec7dde7751"))
.projectId("00000000-0000-0000-0000-000000000002"))
.type(LLMObsAnnotationQueueType.QUEUES));

try {
Expand Down
2 changes: 1 addition & 1 deletion examples/v2/llm-observability/CreateLLMObsAnnotationQueueInteractions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ public static void main(String[] args) {
try {
LLMObsAnnotationQueueInteractionsResponse result =
apiInstance.createLLMObsAnnotationQueueInteractions(
"b5e7f3a1-9c2d-4f8b-a1e6-3d7e9f0a2b4c", body);
"00000000-0000-0000-0000-000000000001", body);
System.out.println(result);
} catch (ApiException e) {
System.err.println(
Expand Down
2 changes: 1 addition & 1 deletion examples/v2/llm-observability/DeleteLLMObsAnnotationQueue.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ public static void main(String[] args) {
LlmObservabilityApi apiInstance = new LlmObservabilityApi(defaultClient);

try {
apiInstance.deleteLLMObsAnnotationQueue("b5e7f3a1-9c2d-4f8b-a1e6-3d7e9f0a2b4c");
apiInstance.deleteLLMObsAnnotationQueue("00000000-0000-0000-0000-000000000001");
} catch (ApiException e) {
System.err.println("Exception when calling LlmObservabilityApi#deleteLLMObsAnnotationQueue");
System.err.println("Status code: " + e.getCode());
Expand Down
2 changes: 1 addition & 1 deletion examples/v2/llm-observability/DeleteLLMObsAnnotationQueueInteractions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ public static void main(String[] args) {

try {
apiInstance.deleteLLMObsAnnotationQueueInteractions(
"b5e7f3a1-9c2d-4f8b-a1e6-3d7e9f0a2b4c", body);
"00000000-0000-0000-0000-000000000001", body);
} catch (ApiException e) {
System.err.println(
"Exception when calling LlmObservabilityApi#deleteLLMObsAnnotationQueueInteractions");
Expand Down
2 changes: 1 addition & 1 deletion examples/v2/llm-observability/GetLLMObsAnnotatedInteractions.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ public static void main(String[] args) {

try {
LLMObsAnnotatedInteractionsResponse result =
apiInstance.getLLMObsAnnotatedInteractions("b5e7f3a1-9c2d-4f8b-a1e6-3d7e9f0a2b4c");
apiInstance.getLLMObsAnnotatedInteractions("00000000-0000-0000-0000-000000000001");
System.out.println(result);
} catch (ApiException e) {
System.err.println(
Expand Down
2 changes: 1 addition & 1 deletion examples/v2/llm-observability/GetLLMObsAnnotationQueueLabelSchema.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,7 +13,7 @@ public static void main(String[] args) {

try {
LLMObsAnnotationQueueLabelSchemaResponse result =
apiInstance.getLLMObsAnnotationQueueLabelSchema("b5e7f3a1-9c2d-4f8b-a1e6-3d7e9f0a2b4c");
apiInstance.getLLMObsAnnotationQueueLabelSchema("00000000-0000-0000-0000-000000000001");
System.out.println(result);
} catch (ApiException e) {
System.err.println(
Expand Down
4 changes: 2 additions & 2 deletions examples/v2/llm-observability/UpdateLLMObsAnnotationQueue.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ public static void main(String[] args) {
.description("Rating of the response quality.")
.hasAssessment(false)
.hasReasoning(false)
.id("ab12cd34")
.id("abc-123")
.isAssessment(false)
.isInteger(false)
.isRequired(true)
Expand All @@ -48,7 +48,7 @@ public static void main(String[] args) {

try {
LLMObsAnnotationQueueResponse result =
apiInstance.updateLLMObsAnnotationQueue("b5e7f3a1-9c2d-4f8b-a1e6-3d7e9f0a2b4c", body);
apiInstance.updateLLMObsAnnotationQueue("00000000-0000-0000-0000-000000000001", body);
System.out.println(result);
} catch (ApiException e) {
System.err.println("Exception when calling LlmObservabilityApi#updateLLMObsAnnotationQueue");
Expand Down
4 changes: 2 additions & 2 deletions examples/v2/llm-observability/UpdateLLMObsAnnotationQueueLabelSchema.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ public static void main(String[] args) {
.description("Rating of the response quality.")
.hasAssessment(false)
.hasReasoning(false)
.id("ab12cd34")
.id("abc-123")
.isAssessment(false)
.isInteger(false)
.isRequired(true)
Expand All @@ -47,7 +47,7 @@ public static void main(String[] args) {
try {
LLMObsAnnotationQueueLabelSchemaResponse result =
apiInstance.updateLLMObsAnnotationQueueLabelSchema(
"b5e7f3a1-9c2d-4f8b-a1e6-3d7e9f0a2b4c", body);
"00000000-0000-0000-0000-000000000001", body);
System.out.println(result);
} catch (ApiException e) {
System.err.println(
Expand Down
2 changes: 1 addition & 1 deletion examples/v2/security-monitoring/MuteSecurityFindings.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ public static void main(String[] args) {
.expireAt(1778721573794L)
.isMuted(true)
.reason(MuteFindingsReason.PENDING_FIX)))
.id("93bfeb70-af47-424d-908a-948d3f08e37f")
.id("00000000-0000-0000-0000-000000000001")
.relationships(
new MuteFindingsRequestDataRelationships()
.findings(
Expand Down
20 changes: 10 additions & 10 deletions src/main/java/com/datadog/api/client/v2/model/SecurityEntityRiskScoreAttributes.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -71,10 +71,10 @@ public class SecurityEntityRiskScoreAttributes {
private Long lastDetected;

public static final String JSON_PROPERTY_RISK_SCORE = "riskScore";
private Double riskScore;
private Long riskScore;

public static final String JSON_PROPERTY_RISK_SCORE_EVOLUTION = "riskScoreEvolution";
private Double riskScoreEvolution;
private Long riskScoreEvolution;

public static final String JSON_PROPERTY_SEVERITY = "severity";
private SecurityEntityRiskScoreAttributesSeverity severity;
Expand All @@ -98,9 +98,9 @@ public SecurityEntityRiskScoreAttributes(
@JsonProperty(required = true, value = JSON_PROPERTY_LAST_ACTIVITY_TITLE)
String lastActivityTitle,
@JsonProperty(required = true, value = JSON_PROPERTY_LAST_DETECTED) Long lastDetected,
@JsonProperty(required = true, value = JSON_PROPERTY_RISK_SCORE) Double riskScore,
@JsonProperty(required = true, value = JSON_PROPERTY_RISK_SCORE) Long riskScore,
@JsonProperty(required = true, value = JSON_PROPERTY_RISK_SCORE_EVOLUTION)
Double riskScoreEvolution,
Long riskScoreEvolution,
@JsonProperty(required = true, value = JSON_PROPERTY_SEVERITY)
SecurityEntityRiskScoreAttributesSeverity severity,
@JsonProperty(required = true, value = JSON_PROPERTY_SIGNALS_DETECTED) Long signalsDetected) {
Expand Down Expand Up @@ -338,7 +338,7 @@ public void setLastDetected(Long lastDetected) {
this.lastDetected = lastDetected;
}

public SecurityEntityRiskScoreAttributes riskScore(Double riskScore) {
public SecurityEntityRiskScoreAttributes riskScore(Long riskScore) {
this.riskScore = riskScore;
return this;
}
Expand All @@ -350,15 +350,15 @@ public SecurityEntityRiskScoreAttributes riskScore(Double riskScore) {
*/
@JsonProperty(JSON_PROPERTY_RISK_SCORE)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public Double getRiskScore() {
public Long getRiskScore() {
return riskScore;
}

public void setRiskScore(Double riskScore) {
public void setRiskScore(Long riskScore) {
this.riskScore = riskScore;
}

public SecurityEntityRiskScoreAttributes riskScoreEvolution(Double riskScoreEvolution) {
public SecurityEntityRiskScoreAttributes riskScoreEvolution(Long riskScoreEvolution) {
this.riskScoreEvolution = riskScoreEvolution;
return this;
}
Expand All @@ -370,11 +370,11 @@ public SecurityEntityRiskScoreAttributes riskScoreEvolution(Double riskScoreEvol
*/
@JsonProperty(JSON_PROPERTY_RISK_SCORE_EVOLUTION)
@JsonInclude(value = JsonInclude.Include.ALWAYS)
public Double getRiskScoreEvolution() {
public Long getRiskScoreEvolution() {
return riskScoreEvolution;
}

public void setRiskScoreEvolution(Double riskScoreEvolution) {
public void setRiskScoreEvolution(Long riskScoreEvolution) {
this.riskScoreEvolution = riskScoreEvolution;
}

Expand Down
16 changes: 8 additions & 8 deletions src/test/resources/com/datadog/api/client/v2/api/llm_observability.feature
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,15 +79,15 @@ Feature: LLM Observability
Scenario: Create an LLM Observability annotation queue returns "Bad Request" response
Given operation "CreateLLMObsAnnotationQueue" enabled
And new "CreateLLMObsAnnotationQueue" request
And body with value {"data": {"attributes": {"annotation_schema": {"label_schemas": [{"description": "Rating of the response quality.", "has_assessment": false, "has_reasoning": false, "id": "ab12cd34", "is_assessment": false, "is_integer": false, "is_required": true, "max": 5.0, "min": 0.0, "name": "quality", "type": "score", "values": ["good", "bad", "neutral"]}]}, "description": "Queue for annotating customer support traces", "name": "My annotation queue", "project_id": "a33671aa-24fd-4dcd-9b33-a8ec7dde7751"}, "type": "queues"}}
And body with value {"data": {"attributes": {"annotation_schema": {"label_schemas": [{"description": "Rating of the response quality.", "has_assessment": false, "has_reasoning": false, "id": "abc-123", "is_assessment": false, "is_integer": false, "is_required": true, "max": 5.0, "min": 0.0, "name": "quality", "type": "score", "values": ["good", "bad", "neutral"]}]}, "description": "Queue for annotating customer support traces", "name": "My annotation queue", "project_id": "00000000-0000-0000-0000-000000000002"}, "type": "queues"}}
When the request is sent
Then the response status is 400 Bad Request

@generated @skip @team:DataDog/ml-observability
Scenario: Create an LLM Observability annotation queue returns "Created" response
Given operation "CreateLLMObsAnnotationQueue" enabled
And new "CreateLLMObsAnnotationQueue" request
And body with value {"data": {"attributes": {"annotation_schema": {"label_schemas": [{"description": "Rating of the response quality.", "has_assessment": false, "has_reasoning": false, "id": "ab12cd34", "is_assessment": false, "is_integer": false, "is_required": true, "max": 5.0, "min": 0.0, "name": "quality", "type": "score", "values": ["good", "bad", "neutral"]}]}, "description": "Queue for annotating customer support traces", "name": "My annotation queue", "project_id": "a33671aa-24fd-4dcd-9b33-a8ec7dde7751"}, "type": "queues"}}
And body with value {"data": {"attributes": {"annotation_schema": {"label_schemas": [{"description": "Rating of the response quality.", "has_assessment": false, "has_reasoning": false, "id": "abc-123", "is_assessment": false, "is_integer": false, "is_required": true, "max": 5.0, "min": 0.0, "name": "quality", "type": "score", "values": ["good", "bad", "neutral"]}]}, "description": "Queue for annotating customer support traces", "name": "My annotation queue", "project_id": "00000000-0000-0000-0000-000000000002"}, "type": "queues"}}
When the request is sent
Then the response status is 201 Created

Expand Down Expand Up @@ -586,7 +586,7 @@ Feature: LLM Observability
Given operation "UpdateLLMObsAnnotationQueue" enabled
And new "UpdateLLMObsAnnotationQueue" request
And request contains "queue_id" parameter from "REPLACE.ME"
And body with value {"data": {"attributes": {"annotation_schema": {"label_schemas": [{"description": "Rating of the response quality.", "has_assessment": false, "has_reasoning": false, "id": "ab12cd34", "is_assessment": false, "is_integer": false, "is_required": true, "max": 5.0, "min": 0.0, "name": "quality", "type": "score", "values": ["good", "bad", "neutral"]}]}, "description": "Updated description", "name": "Updated queue name"}, "type": "queues"}}
And body with value {"data": {"attributes": {"annotation_schema": {"label_schemas": [{"description": "Rating of the response quality.", "has_assessment": false, "has_reasoning": false, "id": "abc-123", "is_assessment": false, "is_integer": false, "is_required": true, "max": 5.0, "min": 0.0, "name": "quality", "type": "score", "values": ["good", "bad", "neutral"]}]}, "description": "Updated description", "name": "Updated queue name"}, "type": "queues"}}
When the request is sent
Then the response status is 400 Bad Request

Expand All @@ -595,7 +595,7 @@ Feature: LLM Observability
Given operation "UpdateLLMObsAnnotationQueue" enabled
And new "UpdateLLMObsAnnotationQueue" request
And request contains "queue_id" parameter from "REPLACE.ME"
And body with value {"data": {"attributes": {"annotation_schema": {"label_schemas": [{"description": "Rating of the response quality.", "has_assessment": false, "has_reasoning": false, "id": "ab12cd34", "is_assessment": false, "is_integer": false, "is_required": true, "max": 5.0, "min": 0.0, "name": "quality", "type": "score", "values": ["good", "bad", "neutral"]}]}, "description": "Updated description", "name": "Updated queue name"}, "type": "queues"}}
And body with value {"data": {"attributes": {"annotation_schema": {"label_schemas": [{"description": "Rating of the response quality.", "has_assessment": false, "has_reasoning": false, "id": "abc-123", "is_assessment": false, "is_integer": false, "is_required": true, "max": 5.0, "min": 0.0, "name": "quality", "type": "score", "values": ["good", "bad", "neutral"]}]}, "description": "Updated description", "name": "Updated queue name"}, "type": "queues"}}
When the request is sent
Then the response status is 404 Not Found

Expand All @@ -604,7 +604,7 @@ Feature: LLM Observability
Given operation "UpdateLLMObsAnnotationQueue" enabled
And new "UpdateLLMObsAnnotationQueue" request
And request contains "queue_id" parameter from "REPLACE.ME"
And body with value {"data": {"attributes": {"annotation_schema": {"label_schemas": [{"description": "Rating of the response quality.", "has_assessment": false, "has_reasoning": false, "id": "ab12cd34", "is_assessment": false, "is_integer": false, "is_required": true, "max": 5.0, "min": 0.0, "name": "quality", "type": "score", "values": ["good", "bad", "neutral"]}]}, "description": "Updated description", "name": "Updated queue name"}, "type": "queues"}}
And body with value {"data": {"attributes": {"annotation_schema": {"label_schemas": [{"description": "Rating of the response quality.", "has_assessment": false, "has_reasoning": false, "id": "abc-123", "is_assessment": false, "is_integer": false, "is_required": true, "max": 5.0, "min": 0.0, "name": "quality", "type": "score", "values": ["good", "bad", "neutral"]}]}, "description": "Updated description", "name": "Updated queue name"}, "type": "queues"}}
When the request is sent
Then the response status is 200 OK

Expand Down Expand Up @@ -697,7 +697,7 @@ Feature: LLM Observability
Given operation "UpdateLLMObsAnnotationQueueLabelSchema" enabled
And new "UpdateLLMObsAnnotationQueueLabelSchema" request
And request contains "queue_id" parameter from "REPLACE.ME"
And body with value {"data": {"attributes": {"annotation_schema": {"label_schemas": [{"description": "Rating of the response quality.", "has_assessment": false, "has_reasoning": false, "id": "ab12cd34", "is_assessment": false, "is_integer": false, "is_required": true, "max": 5.0, "min": 0.0, "name": "quality", "type": "score", "values": ["good", "bad", "neutral"]}]}}, "type": "queues"}}
And body with value {"data": {"attributes": {"annotation_schema": {"label_schemas": [{"description": "Rating of the response quality.", "has_assessment": false, "has_reasoning": false, "id": "abc-123", "is_assessment": false, "is_integer": false, "is_required": true, "max": 5.0, "min": 0.0, "name": "quality", "type": "score", "values": ["good", "bad", "neutral"]}]}}, "type": "queues"}}
When the request is sent
Then the response status is 400 Bad Request

Expand All @@ -706,7 +706,7 @@ Feature: LLM Observability
Given operation "UpdateLLMObsAnnotationQueueLabelSchema" enabled
And new "UpdateLLMObsAnnotationQueueLabelSchema" request
And request contains "queue_id" parameter from "REPLACE.ME"
And body with value {"data": {"attributes": {"annotation_schema": {"label_schemas": [{"description": "Rating of the response quality.", "has_assessment": false, "has_reasoning": false, "id": "ab12cd34", "is_assessment": false, "is_integer": false, "is_required": true, "max": 5.0, "min": 0.0, "name": "quality", "type": "score", "values": ["good", "bad", "neutral"]}]}}, "type": "queues"}}
And body with value {"data": {"attributes": {"annotation_schema": {"label_schemas": [{"description": "Rating of the response quality.", "has_assessment": false, "has_reasoning": false, "id": "abc-123", "is_assessment": false, "is_integer": false, "is_required": true, "max": 5.0, "min": 0.0, "name": "quality", "type": "score", "values": ["good", "bad", "neutral"]}]}}, "type": "queues"}}
When the request is sent
Then the response status is 404 Not Found

Expand All @@ -715,6 +715,6 @@ Feature: LLM Observability
Given operation "UpdateLLMObsAnnotationQueueLabelSchema" enabled
And new "UpdateLLMObsAnnotationQueueLabelSchema" request
And request contains "queue_id" parameter from "REPLACE.ME"
And body with value {"data": {"attributes": {"annotation_schema": {"label_schemas": [{"description": "Rating of the response quality.", "has_assessment": false, "has_reasoning": false, "id": "ab12cd34", "is_assessment": false, "is_integer": false, "is_required": true, "max": 5.0, "min": 0.0, "name": "quality", "type": "score", "values": ["good", "bad", "neutral"]}]}}, "type": "queues"}}
And body with value {"data": {"attributes": {"annotation_schema": {"label_schemas": [{"description": "Rating of the response quality.", "has_assessment": false, "has_reasoning": false, "id": "abc-123", "is_assessment": false, "is_integer": false, "is_required": true, "max": 5.0, "min": 0.0, "name": "quality", "type": "score", "values": ["good", "bad", "neutral"]}]}}, "type": "queues"}}
When the request is sent
Then the response status is 200 OK
Loading
Loading