api-documentation issueshttps://gitlab.gwdg.de/subugoe/ahiqar/api-documentation/-/issues2021-07-08T07:24:58Zhttps://gitlab.gwdg.de/subugoe/ahiqar/api-documentation/-/issues/17basic specification2021-07-08T07:24:58ZMathias Goebelbasic specificationadd a very basic specification for an API to the documentation.
next step would be implementation.
see: subugoe/ahiqar/ahiqar#26add a very basic specification for an API to the documentation.
next step would be implementation.
see: subugoe/ahiqar/ahiqar#26Mathias GoebelMathias Goebelhttps://gitlab.gwdg.de/subugoe/ahiqar/api-documentation/-/issues/16Link TIDO with arabic collection2021-06-09T20:22:02ZKristine VoigtLink TIDO with arabic collectionhttps://gitlab.gwdg.de/subugoe/ahiqar/api-documentation/-/issues/15Remove `total` and `startIndex`2021-06-08T06:00:44ZMichelle WeidlingRemove `total` and `startIndex`Both `total` and `startIndex` require some computation which slows the display of the annotations down.
Since these fields are marked as `should` in the W3C Data Annotation Model (and the TextAPI) they can be removed.Both `total` and `startIndex` require some computation which slows the display of the annotations down.
Since these fields are marked as `should` in the W3C Data Annotation Model (and the TextAPI) they can be removed.Michelle WeidlingMichelle Weidlinghttps://gitlab.gwdg.de/subugoe/ahiqar/api-documentation/-/issues/14Consider Support Object2021-03-09T12:00:04ZMichelle WeidlingConsider Support ObjectThe Support Object isn't mentioned in this API docs, although we use it.The Support Object isn't mentioned in this API docs, although we use it.Michelle WeidlingMichelle Weidlinghttps://gitlab.gwdg.de/subugoe/ahiqar/api-documentation/-/issues/13Update Content Object2021-02-18T07:11:04ZMichelle WeidlingUpdate Content ObjectCf. subugoe/emo/text-api!12Cf. subugoe/emo/text-api!12Ahikar Version 0.17.0Michelle WeidlingMichelle Weidlinghttps://gitlab.gwdg.de/subugoe/ahiqar/api-documentation/-/issues/12fix data paths2021-02-12T12:28:47ZMichelle Weidlingfix data pathsAhikar Version 0.17.0Michelle WeidlingMichelle Weidlinghttps://gitlab.gwdg.de/subugoe/ahiqar/api-documentation/-/issues/11Annotation types2021-02-19T13:01:06ZMichelle WeidlingAnnotation typesCf. subugoe/ahiqar/backend#112Cf. subugoe/ahiqar/backend#112Ahikar Version 0.17.0Michelle WeidlingMichelle Weidlinghttps://gitlab.gwdg.de/subugoe/ahiqar/api-documentation/-/issues/10move x- prefixed info to Metadata Object2021-02-04T11:53:54ZMichelle Weidlingmove x- prefixed info to Metadata ObjectWe decided to remove the extensions from the API and provide the information in the Metadata Object instead.
This way we can leverage the display of the Metadata Object in TIDO instead of having to provide extra code for that.We decided to remove the extensions from the API and provide the information in the Metadata Object instead.
This way we can leverage the display of the Metadata Object in TIDO instead of having to provide extra code for that.Ahikar Version 0.16.0Michelle WeidlingMichelle Weidlinghttps://gitlab.gwdg.de/subugoe/ahiqar/api-documentation/-/issues/9Licence Update for Text API Docu2021-02-03T05:40:19ZKristine VoigtLicence Update for Text API Docudocumentation of the Ahiqar TextAPI has to updateddocumentation of the Ahiqar TextAPI has to updatedAhikar Version 0.16.0Michelle WeidlingMichelle Weidlinghttps://gitlab.gwdg.de/subugoe/ahiqar/api-documentation/-/issues/8License information (images)2021-02-02T12:08:20ZMichelle WeidlingLicense information (images)since the latest update of the TextAPI, providing license info for images is mandatory. The docs have to be updated in this respect.since the latest update of the TextAPI, providing license info for images is mandatory. The docs have to be updated in this respect.Ahikar Version 0.16.0Michelle WeidlingMichelle Weidlinghttps://gitlab.gwdg.de/subugoe/ahiqar/api-documentation/-/issues/7Update according to Collection changes2021-01-28T11:52:56ZMichelle WeidlingUpdate according to Collection changesAs a result of subugoe/ahiqar/backend#85 we have to change the API as described in subugoe/ahiqar/backend!62.
These changes have to documented properly in the API specs.As a result of subugoe/ahiqar/backend#85 we have to change the API as described in subugoe/ahiqar/backend!62.
These changes have to documented properly in the API specs.Michelle WeidlingMichelle Weidlinghttps://gitlab.gwdg.de/subugoe/ahiqar/api-documentation/-/issues/6Update examples for titles2021-01-28T11:53:39ZMichelle WeidlingUpdate examples for titlesWhile the API docs state (correctly), that the value of the `title` field of a Collection or Item Object has to be a Title Object, the examples provide a simple string in this case.While the API docs state (correctly), that the value of the `title` field of a Collection or Item Object has to be a Title Object, the examples provide a simple string in this case.Michelle WeidlingMichelle Weidlinghttps://gitlab.gwdg.de/subugoe/ahiqar/api-documentation/-/issues/5Metadata fields for Salhani2021-07-08T07:12:28ZMichelle WeidlingMetadata fields for SalhaniOne of the edited texts (Salhani) is based on a print instead of a manuscript and needs other metadata fields than the rest.
The metadata is encoded as follows:
```xml
<biblStruct>
<analytic>
<title level="a" type="main">XX...One of the edited texts (Salhani) is based on a print instead of a manuscript and needs other metadata fields than the rest.
The metadata is encoded as follows:
```xml
<biblStruct>
<analytic>
<title level="a" type="main">XX Title of the section/manuscript/... as can be obtained from the monography XX</title>
</analytic>
<monogr>
<editor>Editor</editor>
<title level="m" type="main">Main Title</title>
<title level="m" type="alt">Alternative Title</title>
<imprint>
<publisher>Publisher</publisher>
<pubPlace>Publication Place</pubPlace>
<date>1890</date>
<biblScope>XX–YY</biblScope>
</imprint>
</monogr>
</biblStruct>
```Michelle WeidlingMichelle Weidlinghttps://gitlab.gwdg.de/subugoe/ahiqar/api-documentation/-/issues/4Update viewer name2020-12-03T12:32:47ZMichelle WeidlingUpdate viewer nameSince our viewer has a new name, TIDO, this one should be used instead of the old one.Since our viewer has a new name, TIDO, this one should be used instead of the old one.Michelle WeidlingMichelle Weidlinghttps://gitlab.gwdg.de/subugoe/ahiqar/api-documentation/-/issues/3Image endpoint2020-11-16T07:45:31ZMichelle WeidlingImage endpointIn the course of subugoe/ahiqar/backend#74 we introduced a new endpoint for images which has to be considered in the docs.In the course of subugoe/ahiqar/backend#74 we introduced a new endpoint for images which has to be considered in the docs.Ahikar Version 0.13.0Michelle WeidlingMichelle Weidlinghttps://gitlab.gwdg.de/subugoe/ahiqar/api-documentation/-/issues/2Annotations: REST path2020-11-16T07:44:40ZMichelle WeidlingAnnotations: REST paththe REST path for Annotations on item level has to be adjusted according to subugoe/ahiqar/backend!53.the REST path for Annotations on item level has to be adjusted according to subugoe/ahiqar/backend!53.Ahikar Version 0.13.0Michelle WeidlingMichelle Weidlinghttps://gitlab.gwdg.de/subugoe/ahiqar/api-documentation/-/issues/1Update README2020-09-24T06:46:42ZMichelle WeidlingUpdate READMEThe README has several flaws which stem from being copied from the original Hugo repository.
These should be corrected.The README has several flaws which stem from being copied from the original Hugo repository.
These should be corrected.Ahikar Version 0.11.0Michelle WeidlingMichelle Weidling