Skip to content

Commit

Permalink
Docs: fix naming and meaning of entity vs. entity type
Browse files Browse the repository at this point in the history
  • Loading branch information
DavidB137 committed Aug 10, 2023
1 parent 14b1e9f commit facea00
Show file tree
Hide file tree
Showing 2 changed files with 9 additions and 9 deletions.
8 changes: 4 additions & 4 deletions docs/api.md
Original file line number Diff line number Diff line change
Expand Up @@ -194,7 +194,7 @@ v -> some_embedded_dict_field

## List entities

List latest snapshots of all ids present in database under entity.
List latest snapshots of all ids present in database under entity type.

Contains only latest snapshot.

Expand Down Expand Up @@ -224,7 +224,7 @@ Uses pagination.

## Get Eid data

Get data of entity's eid.
Get data of entity type's eid.

Contains all snapshots and master record. Snapshots are ordered by ascending creation time.

Expand Down Expand Up @@ -315,9 +315,9 @@ This endpoint is meant for `editable` plain attributes -- for direct user edit o

## Entities

List entities
List entity types

Returns dictionary containing all entities configured -- their simplified configuration and current state information.
Returns dictionary containing all entity types configured -- their simplified configuration and current state information.

### Request

Expand Down
10 changes: 5 additions & 5 deletions docs/data_model.md
Original file line number Diff line number Diff line change
@@ -1,8 +1,8 @@
# DP³ data model

Basic elements of the DP³ data model are *entities* (or objects), each entity
record (object instance) has a set of *attributes*.
Each attribute has some value (associated to a particular entity),
Basic elements of the DP³ data model are *entity types* (like classes), each
*entity* (or class instance) has a set of *attributes*.
Each attribute has some value (associated to a particular entity type),
timestamp (history of previous values can be stored)
and optionally confidence value.

Expand Down Expand Up @@ -121,10 +121,10 @@ Very useful for:
- any kind of relationship between entities
- linkning dynamic entities to entities with static data

> As our example so far contains only one entity, we currently have no need for relationships.
> As our example so far contains only one entity type, we currently have no need for relationships.
> However, if we wanted to track the different **bus drivers** driving individual buses,
> relationships would come in quite handy.
> The bus driver is a separate entity, and can drive multiple buses during the day.
> The bus driver is a separate entity type, and can drive multiple buses during the day.
> The current bus driver will be represented as an observation link between the bus and the driver,
> as can be seen in the [resulting configuration](../configuration/db_entities/).
Expand Down

0 comments on commit facea00

Please sign in to comment.