Skip to content
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.

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

feat: Add API fields for the descriptions of entity type and property in the document schema #27301

Merged
merged 2 commits into from
Sep 11, 2024
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

Original file line number Diff line number Diff line change
Expand Up @@ -135,6 +135,10 @@ class DocumentSchema
# - The `/` is sometimes used to denote a property of a type. For example
# `line_item/amount`. This convention is deprecated, but will still be
# honored for backward compatibility.
# @!attribute [rw] description
# @return [::String]
# The description of the entity type. Could be used to provide more
# information about the entity type for model calls.
# @!attribute [rw] base_types
# @return [::Array<::String>]
# The entity type that this type is derived from. For now, one and only
Expand Down Expand Up @@ -163,6 +167,10 @@ class EnumValues
# @return [::String]
# The name of the property. Follows the same guidelines as the
# EntityType name.
# @!attribute [rw] description
# @return [::String]
# The description of the property. Could be used to provide more
# information about the property for model calls.
# @!attribute [rw] display_name
# @return [::String]
# User defined name for the property.
Expand Down