mirror of
https://github.com/versia-pub/docs.git
synced 2026-03-13 02:49:16 +01:00
refactor: 📝 Use References nomenclature instead of URI
This commit is contained in:
parent
d886b83e62
commit
bcdf0ec251
16 changed files with 137 additions and 90 deletions
|
|
@ -16,8 +16,8 @@ Collections are a way to represent paginated groups of entities. They are used e
|
|||
<Row>
|
||||
<Col>
|
||||
<Properties name="Collection">
|
||||
<Property name="author" type="URI | null" required={true} typeLink="/types#uri">
|
||||
Author of the collection. Usually the user who owns the collection. [Can be set to `null` to represent the instance](/entities/instance-metadata#the-null-author).
|
||||
<Property name="author" type="Reference | null" required={true} typeLink="/types#reference">
|
||||
[Reference](/types#reference) to the author of the collection. Usually the user who owns the collection. [Can be set to `null` to represent the instance](/entities/instance-metadata#the-null-author).
|
||||
</Property>
|
||||
<Property name="total" type="number" required={true} numberType="u64">
|
||||
Total number of entities in the collection, across all pages.
|
||||
|
|
@ -64,14 +64,14 @@ URI Collections are identical to regular collections, but they contain only URIs
|
|||
<Row>
|
||||
<Col>
|
||||
<Properties name="URICollection">
|
||||
<Property name="author" type="URI | null" required={true} typeLink="/types#uri">
|
||||
Author of the collection. Usually the user who owns the collection. [Can be set to `null` to represent the instance](/entities/instance-metadata#the-null-author).
|
||||
<Property name="author" type="Reference | null" required={true} typeLink="/types#reference">
|
||||
[Reference](/types#reference) to the author of the collection. Usually the user who owns the collection. [Can be set to `null` to represent the instance](/entities/instance-metadata#the-null-author).
|
||||
</Property>
|
||||
<Property name="total" type="number" required={true} numberType="u64">
|
||||
Total number of entities in the collection, across all pages.
|
||||
</Property>
|
||||
<Property name="items" type="URI[]" required={true}>
|
||||
Collection contents. Must be an array of URIs.
|
||||
<Property name="items" type="Reference[]" required={true}>
|
||||
Collection contents. Must be an array of [References](/types#reference).
|
||||
</Property>
|
||||
</Properties>
|
||||
</Col>
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue