Commit 198e5cdc authored by mrodzis's avatar mrodzis 🌿
Browse files

docs: update according to changes in collection

Cf. backend!62
parent 79a28b3f
......@@ -14,8 +14,8 @@ The [Ahiqar TextAPI]({{< ref "text-api-specs" >}}) is fully compliant to the gen
The terminology of the generic TextAPI applies as follows:
* **Collection**: In Ahiqar, refers to two levels: First it means the *main collection* of the Ahiqar project which contains the all manuscripts to be edited.
Second, it refers to the *three language collections*, `arabic`, `karshuni`, and `syriac` with which the manuscripts are associated.
Having two layers of collections also results in the API calls to have two collection URIs.
Second, it refers to the *language collections*, `arabic-karshuni` and `syriac` with which the manuscripts are associated.
While `syriac` corresponds to the Syriac language collection, `arabic-karshuni` combines the Arabic and the Karshuni language collection.
* **Manifest**: The term „Manifest“ refers to the TextGrid edition object which holds information about the associated XML document as well as the facsimiles.
* **Item**: „Items“ means pages within an edition in Ahiqar.
These are encoded in `tei:pb/@n`.
......
......@@ -61,19 +61,27 @@ It is REQUIRED to use the `https` protocol.
Returns a [Collection Object](#collection-object).
`collection` MUST be either `syriac` or `arabic-karshuni`.
#### Sample Call
`https://ahikar.sub.uni-goettingen.de/api/textapi/ahikar/{collection}/collection.json`
### Manifest
Returns a [Manifest Object](#manifest-object).
`https://ahikar.sub.uni-goettingen.de/api/textapi/ahikar/{collection}/{document}/manifest.json`
#### Sample Call
`https://ahikar.sub.uni-goettingen.de/api/textapi/ahikar/{collection}/{manifest}/manifest.json`
### Item
Returns an [Item Object](#item-object).
`https://ahikar.sub.uni-goettingen.de/api/textapi/ahikar/{collection}/{document}/latest/item.json`
#### Sample Call
`https://ahikar.sub.uni-goettingen.de/api/textapi/ahikar/{collection}/{manifest}/{item}/latest/item.json`
## Schema
......@@ -98,7 +106,7 @@ It is served at the corresponding [endpoint](#collection).
### Manifest Object
This is the main object in the schema to represent a single text, its derivatives
(e.g. HTML) and therefore containing the metadata.
(e.g. HTML) and associated images.
It is REQUIRED to be served at the corresponding [endpoint](#manifest).
| Field Name | Cardinality | Type | Description |
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment