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

Entity as a core concept is missing properties field. #174

Closed
thadguidry opened this issue Jun 17, 2024 · 2 comments · Fixed by #175
Closed

Entity as a core concept is missing properties field. #174

thadguidry opened this issue Jun 17, 2024 · 2 comments · Fixed by #175
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@thadguidry
Copy link
Contributor

Maybe I'm missing something but when reading section 2. Core Concepts, we didn't list the field properties.
Yet later on in section 2.3 Properties, we say:

A property represents a type of attribute that entities can have in the data source.

Luckily, our schema examples however show the "properties" field in the Suggest Entities Response Schema.

Anyways, not a huge deal, but we need to add the properties field to the concept Entity in section 2.1 to be descriptively complete.

@thadguidry thadguidry self-assigned this Jun 17, 2024
@thadguidry thadguidry added the documentation Improvements or additions to documentation label Jun 17, 2024
thadguidry added a commit that referenced this issue Jun 17, 2024
I also don't think we need the sentence after this:
> Moreover, for each property it contains a set of associated property values, possibly empty.
@wetneb
Copy link
Member

wetneb commented Jun 19, 2024

To me this is intentional. The fields that are listed in this section are the "core" fields that can be serialized easily in most places where an entity is represented. If we were to include all of the property values in each entity every time we serialize it, it would make for quite big payloads.

I think the "properties" you are seeing in the "Suggest Entities Response Schema" is not a field of our JSON objects, but rather a part of the JSON Schema vocabulary. So that seems to be a mix-up.

@thadguidry
Copy link
Contributor Author

thadguidry commented Jun 19, 2024

Perhaps, let's see what others think.

I don't quite understand what you mean, why would you want to include property "values" instead of "fields", or at least the properties field like I've done on the PR to acknowledge its relationship early on with the concept of an Entity? To me "properties" is almost a "core" field, I think, when we talk about the concept of Entities from a semantic perspective which is what we're doing in section 2 overall; explaining the 3 basic concepts of Entities, Types, Properties.

fsteeg added a commit that referenced this issue Jul 11, 2024
…ty-concept

Fix #174 Improve grammar in Entity concept
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants