Add required fields for included items in the response of ListCatalogEntity

.apigentools-info

@@ -4,13 +4,13 @@
     "spec_versions": {
         "v1": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-03-18 16:20:36.363534",
-            "spec_repo_commit": "78376979"
+            "regenerated": "2025-03-21 17:04:19.883447",
+            "spec_repo_commit": "94f7c372"
         },
         "v2": {
             "apigentools_version": "1.6.6",
-            "regenerated": "2025-03-18 16:20:36.379301",
-            "spec_repo_commit": "78376979"
+            "regenerated": "2025-03-21 17:04:19.899185",
+            "spec_repo_commit": "94f7c372"
         }
     }
 }

.generator/schemas/v2/openapi.yaml

@@ -11968,7 +11968,10 @@ components:
       properties:
         rawSchema:
           description: Schema from user input in base64 encoding.
+          example: b3BlbmFwaTogMy4wLjQKaW5mbzoKICB0aXRsZTogU2FtcGxlIEFQSQogIHZlcnNpb246IDAuMS45Cg==
           type: string
+      required:
+      - rawSchema
       type: object
     EntityResponseIncludedRelatedEntity:
       description: Included related entity.
@@ -11989,16 +11992,21 @@ components:
       properties:
         kind:
           description: Entity kind.
+          example: team
           type: string
         name:
           description: Entity name.
+          example: bits-ai
           type: string
         namespace:
           description: Entity namespace.
           type: string
         type:
           description: Entity relation type to the associated entity.
           type: string
+      required:
+      - kind
+      - name
       type: object
     EntityResponseIncludedRelatedEntityMeta:
       description: Included related entity meta.
@@ -12036,7 +12044,10 @@ components:
           type: string
         title:
           description: Incident title.
+          example: fake-incident-title
           type: string
+      required:
+      - title
       type: object
     EntityResponseIncludedRelatedOncallAttributes:
       description: Included related oncall attributes.
@@ -12045,7 +12056,10 @@ components:
           $ref: '#/components/schemas/EntityResponseIncludedRelatedOncallEscalations'
         provider:
           description: Oncall provider.
+          example: pagerduty
           type: string
+      required:
+      - provider
       type: object
     EntityResponseIncludedRelatedOncallEscalationItem:
       description: Oncall escalation.
@@ -12083,6 +12097,8 @@ components:
       properties:
         schema:
           $ref: '#/components/schemas/EntityV3'
+      required:
+      - schema
       type: object
     EntityResponseMeta:
       description: Entity metadata.
@@ -12486,7 +12502,7 @@ components:
       properties:
         name:
           description: Team name.
-          example: ''
+          example: fake-team-name
           type: string
         type:
           description: Team type.

examples/v2/software-catalog/UpsertCatalogEntity.java

@@ -58,7 +58,8 @@ public static void main(String[] args) {
                         new EntityV3Metadata()
                             .additionalOwners(
                                 Collections.singletonList(
-                                    new EntityV3MetadataAdditionalOwnersItems().name("")))
+                                    new EntityV3MetadataAdditionalOwnersItems()
+                                        .name("fake-team-name")))
                             .contacts(
                                 Collections.singletonList(
                                     new EntityV3MetadataContactsItems()

src/main/java/com/datadog/api/client/v2/model/EntityResponseIncludedRawSchemaAttributes.java

@@ -8,6 +8,7 @@
 
 import com.fasterxml.jackson.annotation.JsonAnyGetter;
 import com.fasterxml.jackson.annotation.JsonAnySetter;
+import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonProperty;
@@ -25,6 +26,14 @@ public class EntityResponseIncludedRawSchemaAttributes {
   public static final String JSON_PROPERTY_RAW_SCHEMA = "rawSchema";
   private String rawSchema;
 
+  public EntityResponseIncludedRawSchemaAttributes() {}
+
+  @JsonCreator
+  public EntityResponseIncludedRawSchemaAttributes(
+      @JsonProperty(required = true, value = JSON_PROPERTY_RAW_SCHEMA) String rawSchema) {
+    this.rawSchema = rawSchema;
+  }
+
   public EntityResponseIncludedRawSchemaAttributes rawSchema(String rawSchema) {
     this.rawSchema = rawSchema;
     return this;
@@ -35,9 +44,8 @@ public EntityResponseIncludedRawSchemaAttributes rawSchema(String rawSchema) {
    *
    * @return rawSchema
    */
-  @jakarta.annotation.Nullable
   @JsonProperty(JSON_PROPERTY_RAW_SCHEMA)
-  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
+  @JsonInclude(value = JsonInclude.Include.ALWAYS)
   public String getRawSchema() {
     return rawSchema;
   }

src/main/java/com/datadog/api/client/v2/model/EntityResponseIncludedRelatedEntityAttributes.java

@@ -8,6 +8,7 @@
 
 import com.fasterxml.jackson.annotation.JsonAnyGetter;
 import com.fasterxml.jackson.annotation.JsonAnySetter;
+import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonProperty;
@@ -39,6 +40,16 @@ public class EntityResponseIncludedRelatedEntityAttributes {
   public static final String JSON_PROPERTY_TYPE = "type";
   private String type;
 
+  public EntityResponseIncludedRelatedEntityAttributes() {}
+
+  @JsonCreator
+  public EntityResponseIncludedRelatedEntityAttributes(
+      @JsonProperty(required = true, value = JSON_PROPERTY_KIND) String kind,
+      @JsonProperty(required = true, value = JSON_PROPERTY_NAME) String name) {
+    this.kind = kind;
+    this.name = name;
+  }
+
   public EntityResponseIncludedRelatedEntityAttributes kind(String kind) {
     this.kind = kind;
     return this;
@@ -49,9 +60,8 @@ public EntityResponseIncludedRelatedEntityAttributes kind(String kind) {
    *
    * @return kind
    */
-  @jakarta.annotation.Nullable
   @JsonProperty(JSON_PROPERTY_KIND)
-  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
+  @JsonInclude(value = JsonInclude.Include.ALWAYS)
   public String getKind() {
     return kind;
   }
@@ -70,9 +80,8 @@ public EntityResponseIncludedRelatedEntityAttributes name(String name) {
    *
    * @return name
    */
-  @jakarta.annotation.Nullable
   @JsonProperty(JSON_PROPERTY_NAME)
-  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
+  @JsonInclude(value = JsonInclude.Include.ALWAYS)
   public String getName() {
     return name;
   }

src/main/java/com/datadog/api/client/v2/model/EntityResponseIncludedRelatedIncidentAttributes.java

@@ -8,6 +8,7 @@
 
 import com.fasterxml.jackson.annotation.JsonAnyGetter;
 import com.fasterxml.jackson.annotation.JsonAnySetter;
+import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonProperty;
@@ -44,6 +45,14 @@ public class EntityResponseIncludedRelatedIncidentAttributes {
   public static final String JSON_PROPERTY_TITLE = "title";
   private String title;
 
+  public EntityResponseIncludedRelatedIncidentAttributes() {}
+
+  @JsonCreator
+  public EntityResponseIncludedRelatedIncidentAttributes(
+      @JsonProperty(required = true, value = JSON_PROPERTY_TITLE) String title) {
+    this.title = title;
+  }
+
   public EntityResponseIncludedRelatedIncidentAttributes createdAt(OffsetDateTime createdAt) {
     this.createdAt = createdAt;
     return this;
@@ -138,9 +147,8 @@ public EntityResponseIncludedRelatedIncidentAttributes title(String title) {
    *
    * @return title
    */
-  @jakarta.annotation.Nullable
   @JsonProperty(JSON_PROPERTY_TITLE)
-  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
+  @JsonInclude(value = JsonInclude.Include.ALWAYS)
   public String getTitle() {
     return title;
   }

src/main/java/com/datadog/api/client/v2/model/EntityResponseIncludedRelatedOncallAttributes.java

@@ -8,6 +8,7 @@
 
 import com.fasterxml.jackson.annotation.JsonAnyGetter;
 import com.fasterxml.jackson.annotation.JsonAnySetter;
+import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonProperty;
@@ -33,6 +34,14 @@ public class EntityResponseIncludedRelatedOncallAttributes {
   public static final String JSON_PROPERTY_PROVIDER = "provider";
   private String provider;
 
+  public EntityResponseIncludedRelatedOncallAttributes() {}
+
+  @JsonCreator
+  public EntityResponseIncludedRelatedOncallAttributes(
+      @JsonProperty(required = true, value = JSON_PROPERTY_PROVIDER) String provider) {
+    this.provider = provider;
+  }
+
   public EntityResponseIncludedRelatedOncallAttributes escalations(
       List<EntityResponseIncludedRelatedOncallEscalationItem> escalations) {
     this.escalations = escalations;
@@ -78,9 +87,8 @@ public EntityResponseIncludedRelatedOncallAttributes provider(String provider) {
    *
    * @return provider
    */
-  @jakarta.annotation.Nullable
   @JsonProperty(JSON_PROPERTY_PROVIDER)
-  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
+  @JsonInclude(value = JsonInclude.Include.ALWAYS)
   public String getProvider() {
     return provider;
   }

src/main/java/com/datadog/api/client/v2/model/EntityResponseIncludedSchemaAttributes.java

@@ -8,6 +8,7 @@
 
 import com.fasterxml.jackson.annotation.JsonAnyGetter;
 import com.fasterxml.jackson.annotation.JsonAnySetter;
+import com.fasterxml.jackson.annotation.JsonCreator;
 import com.fasterxml.jackson.annotation.JsonIgnore;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.annotation.JsonProperty;
@@ -25,6 +26,15 @@ public class EntityResponseIncludedSchemaAttributes {
   public static final String JSON_PROPERTY_SCHEMA = "schema";
   private EntityV3 schema;
 
+  public EntityResponseIncludedSchemaAttributes() {}
+
+  @JsonCreator
+  public EntityResponseIncludedSchemaAttributes(
+      @JsonProperty(required = true, value = JSON_PROPERTY_SCHEMA) EntityV3 schema) {
+    this.schema = schema;
+    this.unparsed |= schema.unparsed;
+  }
+
   public EntityResponseIncludedSchemaAttributes schema(EntityV3 schema) {
     this.schema = schema;
     this.unparsed |= schema.unparsed;
@@ -36,9 +46,8 @@ public EntityResponseIncludedSchemaAttributes schema(EntityV3 schema) {
    *
    * @return schema
    */
-  @jakarta.annotation.Nullable
   @JsonProperty(JSON_PROPERTY_SCHEMA)
-  @JsonInclude(value = JsonInclude.Include.USE_DEFAULTS)
+  @JsonInclude(value = JsonInclude.Include.ALWAYS)
   public EntityV3 getSchema() {
     return schema;
   }

src/test/resources/com/datadog/api/client/v2/api/software_catalog.feature

@@ -10,14 +10,14 @@ Feature: Software Catalog
   @generated @skip @team:DataDog/service-catalog
   Scenario: Create or update entities returns "ACCEPTED" response
     Given new "UpsertCatalogEntity" request
-    And body with value {"apiVersion": "v3", "datadog": {"codeLocations": [{"paths": []}], "events": [{}], "logs": [{}], "performanceData": {"tags": []}, "pipelines": {"fingerprints": []}}, "integrations": {"opsgenie": {"serviceURL": "https://www.opsgenie.com/service/shopping-cart"}, "pagerduty": {"serviceURL": "https://www.pagerduty.com/service-directory/Pshopping-cart"}}, "kind": "service", "metadata": {"additionalOwners": [{"name": ""}], "contacts": [{"contact": "https://slack/", "type": "slack"}], "id": "4b163705-23c0-4573-b2fb-f6cea2163fcb", "inheritFrom": "application:default/myapp", "links": [{"name": "mylink", "type": "link", "url": "https://mylink"}], "name": "myService", "namespace": "default", "tags": ["this:tag", "that:tag"]}, "spec": {"dependsOn": [], "languages": []}}
+    And body with value {"apiVersion": "v3", "datadog": {"codeLocations": [{"paths": []}], "events": [{}], "logs": [{}], "performanceData": {"tags": []}, "pipelines": {"fingerprints": []}}, "integrations": {"opsgenie": {"serviceURL": "https://www.opsgenie.com/service/shopping-cart"}, "pagerduty": {"serviceURL": "https://www.pagerduty.com/service-directory/Pshopping-cart"}}, "kind": "service", "metadata": {"additionalOwners": [{"name": "fake-team-name"}], "contacts": [{"contact": "https://slack/", "type": "slack"}], "id": "4b163705-23c0-4573-b2fb-f6cea2163fcb", "inheritFrom": "application:default/myapp", "links": [{"name": "mylink", "type": "link", "url": "https://mylink"}], "name": "myService", "namespace": "default", "tags": ["this:tag", "that:tag"]}, "spec": {"dependsOn": [], "languages": []}}
     When the request is sent
     Then the response status is 202 ACCEPTED
 
   @generated @skip @team:DataDog/service-catalog
   Scenario: Create or update entities returns "Bad Request" response
     Given new "UpsertCatalogEntity" request
-    And body with value {"apiVersion": "v3", "datadog": {"codeLocations": [{"paths": []}], "events": [{}], "logs": [{}], "performanceData": {"tags": []}, "pipelines": {"fingerprints": []}}, "integrations": {"opsgenie": {"serviceURL": "https://www.opsgenie.com/service/shopping-cart"}, "pagerduty": {"serviceURL": "https://www.pagerduty.com/service-directory/Pshopping-cart"}}, "kind": "service", "metadata": {"additionalOwners": [{"name": ""}], "contacts": [{"contact": "https://slack/", "type": "slack"}], "id": "4b163705-23c0-4573-b2fb-f6cea2163fcb", "inheritFrom": "application:default/myapp", "links": [{"name": "mylink", "type": "link", "url": "https://mylink"}], "name": "myService", "namespace": "default", "tags": ["this:tag", "that:tag"]}, "spec": {"dependsOn": [], "languages": []}}
+    And body with value {"apiVersion": "v3", "datadog": {"codeLocations": [{"paths": []}], "events": [{}], "logs": [{}], "performanceData": {"tags": []}, "pipelines": {"fingerprints": []}}, "integrations": {"opsgenie": {"serviceURL": "https://www.opsgenie.com/service/shopping-cart"}, "pagerduty": {"serviceURL": "https://www.pagerduty.com/service-directory/Pshopping-cart"}}, "kind": "service", "metadata": {"additionalOwners": [{"name": "fake-team-name"}], "contacts": [{"contact": "https://slack/", "type": "slack"}], "id": "4b163705-23c0-4573-b2fb-f6cea2163fcb", "inheritFrom": "application:default/myapp", "links": [{"name": "mylink", "type": "link", "url": "https://mylink"}], "name": "myService", "namespace": "default", "tags": ["this:tag", "that:tag"]}, "spec": {"dependsOn": [], "languages": []}}
     When the request is sent
     Then the response status is 400 Bad Request