rename include delete parameter for consistency with HEAD api

datahub-project · Jul 2, 2024 · 410355d · 410355d
1 parent c3af45a
commit 410355d
Show file tree

Hide file tree

Showing 2 changed files with 6 additions and 7 deletions.
diff --git a/...servlet/src/main/java/io/datahubproject/openapi/controller/GenericEntitiesController.java b/...servlet/src/main/java/io/datahubproject/openapi/controller/GenericEntitiesController.java
@@ -148,8 +148,8 @@ public ResponseEntity<S> getEntities(
           Boolean withSystemMetadata,
       @RequestParam(value = "skipCache", required = false, defaultValue = "false")
           Boolean skipCache,
-      @RequestParam(value = "includeSoftDeleted", required = false, defaultValue = "false")
-          Boolean includeSoftDeleted)
+      @RequestParam(value = "includeSoftDelete", required = false, defaultValue = "false")
+          Boolean includeSoftDelete)
       throws URISyntaxException {
 
     EntitySpec entitySpec = entityRegistry.getEntitySpec(entityName);
@@ -178,7 +178,7 @@ public ResponseEntity<S> getEntities(
             opContext
                 .withSearchFlags(flags -> DEFAULT_SEARCH_FLAGS)
                 .withSearchFlags(flags -> flags.setSkipCache(skipCache))
-                .withSearchFlags(flags -> flags.setIncludeSoftDeleted(includeSoftDeleted)),
+                .withSearchFlags(flags -> flags.setIncludeSoftDeleted(includeSoftDelete)),
             List.of(entitySpec.getName()),
             query,
             null,

diff --git a/...ervice/openapi-servlet/src/main/java/io/datahubproject/openapi/v3/OpenAPIV3Generator.java b/...ervice/openapi-servlet/src/main/java/io/datahubproject/openapi/v3/OpenAPIV3Generator.java
@@ -57,8 +57,7 @@ public class OpenAPIV3Generator {
   private static final String ASPECT_RESPONSE_SUFFIX = "Aspect" + RESPONSE_SUFFIX;
   private static final String ENTITY_REQUEST_SUFFIX = "Entity" + REQUEST_SUFFIX;
   private static final String ENTITY_RESPONSE_SUFFIX = "Entity" + RESPONSE_SUFFIX;
-  private static final String SKIP_CACHE = "skipCache";
-  private static final String INCLUDE_DELETED = "includeDeleted";
+  private static final String NAME_SKIP_CACHE = "skipCache";
 
   public static OpenAPI generateOpenApiSpec(EntityRegistry entityRegistry) {
     final Set<String> aspectNames = entityRegistry.getAspectSpecs().keySet();
@@ -256,12 +255,12 @@ private static PathItem buildListEntityPath(final EntitySpec entity) {
                 .schema(new Schema().type(TYPE_BOOLEAN)._default(false)),
             new Parameter()
                 .in(NAME_QUERY)
-                .name(INCLUDE_DELETED)
+                .name(NAME_INCLUDE_SOFT_DELETE)
                 .description("Include soft-deleted aspects with response.")
                 .schema(new Schema().type(TYPE_BOOLEAN)._default(false)),
             new Parameter()
                 .in(NAME_QUERY)
-                .name(SKIP_CACHE)
+                .name(NAME_SKIP_CACHE)
                 .description("Skip cache when listing entities.")
                 .schema(new Schema().type(TYPE_BOOLEAN)._default(false)),
             new Parameter()