yujunjun/OpenMetadata
1
0
Fork 0
mirror of https://github.com/open-metadata/OpenMetadata.git synced 2025-12-14 09:05:58 +00:00
Code Issues Packages Projects Releases Wiki Activity

Enhance TypeResource API documentation to clarify custom property definitions. Updated descriptions for managing custom properties and creating property templates using existing OpenMetadata data types. (#22883)

Browse Source
This commit is contained in:
Ayush Shah 2025-08-12 10:09:43 +05:30 committed by GitHub
parent 2525e40db1
commit 76bd3d2ba4
No known key found for this signature in database
GPG Key ID: B5690EEEBB952194
1 changed files with 12 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

17
openmetadata-service/src/main/java/org/openmetadata/service/resources/types/TypeResource.java
View File

@ -76,8 +76,10 @@ import org.openmetadata.service.util.SchemaFieldExtractor;
@Tag( @Tag(
name = "Metadata", name = "Metadata",
description = description =
"These APIs are for adding new `Types` to OpenMetadata and use those `Types` to " "These APIs are for managing custom property definitions in OpenMetadata. Use these APIs to "
+ "extend the metadata of an entity with custom properties.") + "create custom properties with predefined data types (String, Integer, Date, etc.) that "
+ "extend entity metadata. Note: This does not support creating new custom data types - "
+ "only custom properties using existing OpenMetadata data types.")
@Produces(MediaType.APPLICATION_JSON) @Produces(MediaType.APPLICATION_JSON)
@Consumes(MediaType.APPLICATION_JSON) @Consumes(MediaType.APPLICATION_JSON)
@Collection(name = "types") @Collection(name = "types")
@ -311,12 +313,17 @@ public class TypeResource extends EntityResource<Type, TypeRepository> {
@POST @POST
@Operation( @Operation(
operationId = "createType", operationId = "createType",
summary = "Create a type", summary = "Create a custom property definition",
description = "Create a new type.", description =
"Create a new custom property definition that can be applied to entities. "
+ "This creates a property template using existing OpenMetadata data types "
+ "(String, Integer, Date, Enum, etc.). The created property can then be used to "
+ "extend metadata for data assets like tables, dashboards, and pipelines. "
+ "Note: This does not create new data types - only custom property definitions.",
responses = { responses = {
@ApiResponse( @ApiResponse(
responseCode = "200", responseCode = "200",
description = "The type", description = "The custom property definition",
content = content =
@Content( @Content(
mediaType = "application/json", mediaType = "application/json",