yujunjun/datahub
2
0
Fork 0
mirror of https://github.com/datahub-project/datahub.git synced 2025-06-27 05:03:31 +00:00
Code Issues Packages Projects Releases Wiki Activity

clean(openapi): remove unneeded schema (#12691)

Browse Source
This commit is contained in:
david-leifker 2025-02-20 12:26:36 -06:00 committed by GitHub
parent 9e18fa04ae
commit 0cf89d60f6
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
2 changed files with 0 additions and 84 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

48
metadata-service/openapi-servlet/src/main/java/io/datahubproject/openapi/v3/OpenAPIV3Generator.java
View File

@ -113,9 +113,6 @@ public class OpenAPIV3Generator {
.nullable(true)); .nullable(true));
// --> Aspect components // --> Aspect components
components.addSchemas(
ASPECTS + ASPECT_RESPONSE_SUFFIX,
buildAspectsRefResponseSchema(entityRegistry, definitionNames));
entityRegistry entityRegistry
.getAspectSpecs() .getAspectSpecs()
.values() .values()
@ -719,51 +716,6 @@ public class OpenAPIV3Generator {
} }
} }
/**
* Generate schema for cross-entity scroll/list response
*
* @param entityRegistry entity registry
* @return schema
*/
private static Schema buildAspectsRefResponseSchema(
final EntityRegistry entityRegistry, final Set<String> definitionNames) {
final Schema result =
new Schema<>()
.type(TYPE_OBJECT)
.description(ASPECT_DESCRIPTION)
.required(List.of(PROPERTY_VALUE));
// Create a list of reference schemas for each aspect
List<Schema> aspectRefs =
entityRegistry.getAspectSpecs().values().stream()
.filter(a -> definitionNames.contains(a.getName()))
.map(
aspect ->
new Schema<>()
.$ref(PATH_DEFINITIONS + toUpperFirst(aspect.getPegasusSchema().getName())))
.distinct()
.collect(Collectors.toList());
// Add the value property with oneOf constraint
result.addProperty(PROPERTY_VALUE, new Schema<>().oneOf(aspectRefs));
result.addProperty(
NAME_SYSTEM_METADATA,
new Schema<>()
.type(TYPE_OBJECT)
.anyOf(List.of(new Schema().$ref(PATH_DEFINITIONS + "SystemMetadata")))
.description("System metadata for the aspect.")
.nullable(true));
result.addProperty(
NAME_AUDIT_STAMP,
new Schema<>()
.type(TYPE_OBJECT)
.anyOf(List.of(new Schema().$ref(PATH_DEFINITIONS + "AuditStamp")))
.description("Audit stamp for the aspect.")
.nullable(true));
return result;
}
private static Schema buildAspectRefResponseSchema(final String aspectName) { private static Schema buildAspectRefResponseSchema(final String aspectName) {
final Schema result = final Schema result =
new Schema<>() new Schema<>()

36
metadata-service/openapi-servlet/src/test/java/io/datahubproject/openapi/v3/OpenAPIV3GeneratorTest.java
View File

@ -105,41 +105,5 @@ public class OpenAPIV3GeneratorTest {
entry -> entry ->
assertEquals( assertEquals(
"#/components/schemas/BatchGetRequestBody", entry.getValue().get$ref())); "#/components/schemas/BatchGetRequestBody", entry.getValue().get$ref()));
// Assert aspect response schemas have value property with oneOf references
Schema<?> aspectResponseSchema =
openAPI.getComponents().getSchemas().get("AspectsAspectResponse_v3");
Schema<?> valueProperty = aspectResponseSchema.getProperties().get("value");
assertTrue(
valueProperty.getOneOf() != null && !valueProperty.getOneOf().isEmpty(),
"value property should use oneOf");
// Check each reference has proper format and capitalization
valueProperty
.getOneOf()
.forEach(
schema -> {
String ref = schema.get$ref();
assertTrue(
ref != null && ref.startsWith("#/components/schemas/"),
"reference should start with '#/components/schemas/': " + ref);
// Extract the last part after the last slash and check first character
String refName = ref.substring(ref.lastIndexOf('/') + 1);
assertTrue(
Character.isUpperCase(refName.charAt(0)),
"schema reference should start with capital letter: " + name);
});
// Check for pegasus name example
assertTrue(
valueProperty.getOneOf().stream()
.anyMatch(
schema ->
schema.get$ref().equals("#/components/schemas/StructuredPropertyDefinition")));
assertTrue(
valueProperty.getOneOf().stream()
.noneMatch(
schema -> schema.get$ref().equals("#/components/schemas/PropertyDefinition")));
} }
} }