diff --git a/CHANGELOG.md b/CHANGELOG.md index eaeaa355ed..393fec4a14 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -2,14 +2,12 @@ ## [13.6.0](https://www.github.com/dasch-swiss/dsp-api/compare/v13.5.1...v13.6.0) (2021-03-16) - ### Enhancements * **api-v2:** Improve error message when an XSLT transformation file is not found (DSP-1404) ([#1831](https://www.github.com/dasch-swiss/dsp-api/issues/1831)) ([153a674](https://www.github.com/dasch-swiss/dsp-api/commit/153a674fda6085a338a390788e74985e071f1d4d)) ### [13.5.1](https://www.github.com/dasch-swiss/dsp-api/compare/v13.5.0...v13.5.1) (2021-03-11) - ### Bug Fixes * **OntologiesRouteV2:** Reject internal ontology names in external schema (DSP-1394) ([#1827](https://www.github.com/dasch-swiss/dsp-api/issues/1827)) ([e392bf1](https://www.github.com/dasch-swiss/dsp-api/commit/e392bf16645e8472d3760e84177f5880c22304cd)) @@ -17,17 +15,14 @@ ## [13.5.0](https://www.github.com/dasch-swiss/dsp-api/compare/v13.4.0...v13.5.0) (2021-03-08) - ### Bug Fixes * **replaceCardinalities.scala.txt:** Fix blank node insertion. ([#1829](https://www.github.com/dasch-swiss/dsp-api/issues/1829)) ([d24c5d2](https://www.github.com/dasch-swiss/dsp-api/commit/d24c5d2ccdd476fe4a58cf37ad15c74cc273e46e)) - ### Maintenance * **gh-ci:** update release please configuration (DSP-1382) ([#1825](https://www.github.com/dasch-swiss/dsp-api/issues/1825)) ([7ce4b65](https://www.github.com/dasch-swiss/dsp-api/commit/7ce4b650f1213a275b3af70a379d72d8c91303b7)) - ### Enhancements * Add support for audio files (DSP-1343) ([#1818](https://www.github.com/dasch-swiss/dsp-api/issues/1818)) ([7497023](https://www.github.com/dasch-swiss/dsp-api/commit/7497023c3cc117d08c3d5eaae807ac53451dae64)) @@ -36,45 +31,38 @@ ## [13.4.0](https://www.github.com/dasch-swiss/dsp-api/compare/v13.3.1...v13.4.0) (2021-02-17) - ### Bug Fixes * **Lists:** fix bug in shifting the second of two children after deletion of the first one. ([#1820](https://www.github.com/dasch-swiss/dsp-api/issues/1820)) ([d92bb01](https://www.github.com/dasch-swiss/dsp-api/commit/d92bb0194d3245cef86dc91b1cbd83a8dfc0eb05)) - ### Enhancements * **projects:** add default set of permissions when creating new project (DSP-1347) ([#1822](https://www.github.com/dasch-swiss/dsp-api/issues/1822)) ([b7c71ca](https://www.github.com/dasch-swiss/dsp-api/commit/b7c71ca0ac3360bf1e9434f7525fe0a9a122edbc)) ### [13.3.1](https://www.github.com/dasch-swiss/dsp-api/compare/v13.3.0...v13.3.1) (2021-02-09) - ### Bug Fixes * **Lists:** fix bug in deleting the single child of a node (DSP-1355) ([#1816](https://www.github.com/dasch-swiss/dsp-api/issues/1816)) ([1d06572](https://www.github.com/dasch-swiss/dsp-api/commit/1d0657205cdc96704551902b6cac4ef8fec46ccc)) ## [13.3.0](https://www.github.com/dasch-swiss/dsp-api/compare/v13.2.0...v13.3.0) (2021-02-05) - ### Enhancements * **sipi:** add storing of original and sidecar (DSP-1318) ([#1808](https://www.github.com/dasch-swiss/dsp-api/issues/1808)) ([022ed7e](https://www.github.com/dasch-swiss/dsp-api/commit/022ed7e977601543eca47b48ab65ea830c04e2f4)) ## [13.2.0](https://www.github.com/dasch-swiss/dsp-api/compare/v13.1.1...v13.2.0) (2021-02-04) - ### Bug Fixes * **api-v1:** Optimise SPARQL queries. ([#1814](https://www.github.com/dasch-swiss/dsp-api/issues/1814)) ([4edc27c](https://www.github.com/dasch-swiss/dsp-api/commit/4edc27cc64000e599b4b89db8ace1eee7e088908)) * **Lists:** Repositioning the node when new position equals length of new parent's children (DSP-1322) ([#1811](https://www.github.com/dasch-swiss/dsp-api/issues/1811)) ([3fead13](https://www.github.com/dasch-swiss/dsp-api/commit/3fead1379ff1c7c7ccb977db983e1a22ee24100a)) - ### Enhancements * **api-v1:** Add support for PDF files (DSP-1267) ([#1797](https://www.github.com/dasch-swiss/dsp-api/issues/1797)) ([c3b2e84](https://www.github.com/dasch-swiss/dsp-api/commit/c3b2e842c6b6524e11227d564300f4a074cec228)) * **api-v2:** Allow resubmitting existing class/property lablels/comments. ([#1812](https://www.github.com/dasch-swiss/dsp-api/issues/1812)) ([6a13852](https://www.github.com/dasch-swiss/dsp-api/commit/6a1385201876e17fc07a50666b1d504cff1b64cc)) - ### Maintenance * make targets for adding metadata (DSP-1289) ([#1810](https://www.github.com/dasch-swiss/dsp-api/issues/1810)) ([9c1a70a](https://www.github.com/dasch-swiss/dsp-api/commit/9c1a70a5423d07684716c7b2823bb11777c24859)) @@ -87,7 +75,6 @@ * **gh-ci:** Bring back the client-test-data command to github actions ([#1804](https://www.github.com/dasch-swiss/dsp-api/issues/1804)) ([e6b0fbf](https://www.github.com/dasch-swiss/dsp-api/commit/e6b0fbf14d20c3d3bd9c74da523a18160338d4b0)) * revert release 13.1.0 ([#1800](https://www.github.com/dasch-swiss/dsp-api/issues/1800)) ([565e5ac](https://www.github.com/dasch-swiss/dsp-api/commit/565e5ac9d2c73ac0bcd91a13c358c02d27b0f93e)) - ## [13.1.0](https://www.github.com/dasch-swiss/dsp-api/compare/v13.0.0...v13.1.0) (2021-01-29) ### Bug Fixes @@ -103,7 +90,6 @@ * **gh-ci:** fix issue in the release process ([#1782](https://www.github.com/dasch-swiss/dsp-api/issues/1782)) ([afe61b7](https://www.github.com/dasch-swiss/dsp-api/commit/afe61b767248fda03a6f879075a4d19ecf72f1f6)) * **ghi-ci:** google chat release notification ([#1785](https://www.github.com/dasch-swiss/dsp-api/issues/1785)) ([4718cdc](https://www.github.com/dasch-swiss/dsp-api/commit/4718cdcbaee6f9e366c4ec8671b52c498deb5005)) - ### Enhancements * **permissions:** add delete permissions: (DSP-1169) ([#1787](https://www.github.com/dasch-swiss/dsp-api/issues/1787)) ([3fe8c14](https://www.github.com/dasch-swiss/dsp-api/commit/3fe8c14f482b1ff003ee34935ab61ecca1b4f286)) @@ -140,7 +126,6 @@ * **webapi:** unique username/email check on change user ([#1561](https://www.github.com/dasch-swiss/dsp-api/issues/1561)) ([4f26e22](https://www.github.com/dasch-swiss/dsp-api/commit/4f26e224fd062e1627f1e1350594e41764ff7614)) * **rdf-api**: Use the Jena RDF API implementation by default (DSP-1153) ([1772](https://github.com/dasch-swiss/dsp-api/pull/1772)) ([389feb4](https://github.com/dasch-swiss/dsp-api/commit/389feb49b504f619b2164befd9c54e5595e06cb6)) - ### Documentation * **api-v2:** Document what happens when a resource has a link to a deleted resource ([#1685](https://www.github.com/dasch-swiss/dsp-api/issues/1685)) ([1c88651](https://www.github.com/dasch-swiss/dsp-api/commit/1c886511e3863ae24d51447144d2bcd30e29a592)) @@ -149,7 +134,6 @@ * Update README (DSP-1142) ([#1771](https://www.github.com/dasch-swiss/dsp-api/issues/1771)) ([7ba7fc6](https://www.github.com/dasch-swiss/dsp-api/commit/7ba7fc6a85879ca336fe1b4dcf03bed3189699fd)) * Update required mkdocs package ([#1725](https://www.github.com/dasch-swiss/dsp-api/issues/1725)) ([27de65e](https://www.github.com/dasch-swiss/dsp-api/commit/27de65e4f5e35db0b8249c93a603b93dbb06e331)) - ### Maintenance * **api-v2:** Delete obsolete files. ([#1634](https://www.github.com/dasch-swiss/dsp-api/issues/1634)) ([e80bf52](https://www.github.com/dasch-swiss/dsp-api/commit/e80bf527ee6d8494a4ed54669d1936a189cff00e)) @@ -200,37 +184,37 @@ ## Enhancements -- #1768 DSP-1106 Update Permission -- #1767 enhancement(triplestore): Use N-Quads instead of TriG for repository upgrade (DSP-1129) -- #1764 DSP-1033 Reposition List Nodes -- #1762 feat(rdf-api): Add a general-purpose SHACL validation utility (DSP-930) -- #1759 feat: Add an RDF processing façade (2nd iteration) (DSP-1083) -- #1760 (DSP-1031) Delete list items -- #1753 Edit lists routes (DSP-597 ) -- #1758 feat(api-v2): Control JSON-LD nesting via an HTTP header (DSP-1084) +* [#1768](https://github.com/dasch-swiss/knora-api/pull/1768) | DSP-1106 Update Permission +* [#1767](https://github.com/dasch-swiss/knora-api/pull/1767) | enhancement(triplestore): Use N-Quads instead of TriG for repository upgrade (DSP-1129) +* [#1764](https://github.com/dasch-swiss/knora-api/pull/1764) | DSP-1033 Reposition List Nodes +* [#1762](https://github.com/dasch-swiss/knora-api/pull/1762) | feat(rdf-api): Add a general-purpose SHACL validation utility (DSP-930) +* [#1759](https://github.com/dasch-swiss/knora-api/pull/1759) | feat: Add an RDF processing façade (2nd iteration) (DSP-1083) +* [#1760](https://github.com/dasch-swiss/knora-api/pull/1760) | (DSP-1031) Delete list items +* [#1753](https://github.com/dasch-swiss/knora-api/pull/1753) | Edit lists routes (DSP-597 ) +* [#1758](https://github.com/dasch-swiss/knora-api/pull/1758) | feat(api-v2): Control JSON-LD nesting via an HTTP header (DSP-1084) ## Bug fixes -- #1763 fix(sipi): Don't expect API v1 status code (DSP-1114) +* [#1763](https://github.com/dasch-swiss/knora-api/pull/1763) | fix(sipi): Don't expect API v1 status code (DSP-1114) ## Documentation -- #1771 docs: Update README (DSP-1142) +* [#1771](https://github.com/dasch-swiss/knora-api/pull/1771) | docs: Update README (DSP-1142) ## Maintenance -- #1770 refactor: Use java.nio.file.Path instead of java.io.File (DSP-1124) -- #1765 DSP-1094 Upgrade Swagger version -- #1766 style: Add Scalafmt config file -- #1769 style: Reformat code with Scalafmt (DSP-1137) -- #1754 feat(api-v2): Add an RDF processing façade (DSP-1020) -- #1757 build: bazel workspace cleanup +* [#1770](https://github.com/dasch-swiss/knora-api/pull/1770) | refactor: Use java.nio.file.Path instead of java.io.File (DSP-1124) +* [#1765](https://github.com/dasch-swiss/knora-api/pull/1765) | DSP-1094 Upgrade Swagger version +* [#1766](https://github.com/dasch-swiss/knora-api/pull/1766) | style: Add Scalafmt config file +* [#1769](https://github.com/dasch-swiss/knora-api/pull/1769) | style: Reformat code with Scalafmt (DSP-1137) +* [#1754](https://github.com/dasch-swiss/knora-api/pull/1754) | feat(api-v2): Add an RDF processing façade (DSP-1020) +* [#1757](https://github.com/dasch-swiss/knora-api/pull/1757) | build: bazel workspace cleanup --- ## v13.0.0-rc.24 (13/11/2020) -- #1756 DSP-1052 : Migration task to replace empty strings with dummy "FIXME" +* [#1756](https://github.com/dasch-swiss/knora-api/pull/1756) | DSP-1052 : Migration task to replace empty strings with dummy "FIXME" --- @@ -238,220 +222,220 @@ ## Bug fixes -- #1755 DSP-1029: Add the missing dependency +* [#1755](https://github.com/dasch-swiss/knora-api/pull/1755) | DSP-1029: Add the missing dependency --- ## v13.0.0-rc.22 (09/11/2020) -#### Breaking changes: - -- [#1724](https://github.com/dasch-swiss/knora-api/pull/1724) | test: Collect client test data from E2E tests (DSP-724) -- [#1727](https://github.com/dasch-swiss/knora-api/pull/1727) | DSP-740 Update List Name -- [#1722](https://github.com/dasch-swiss/knora-api/pull/1722) | feat(api-v1): Change API v1 file uploads to work like API v2 (DSP-41, PR 3) -- [#1233](https://github.com/dasch-swiss/knora-api/pull/1233) | feat(api-v1): Change API v1 file uploads to work like API v2 -- [#1708](https://github.com/dasch-swiss/knora-api/pull/1708) | Get Project Permissions - -#### Enhancements: - -- [#1403](https://github.com/dasch-swiss/knora-api/pull/1403) | feat: Add time value type -- [#1537](https://github.com/dasch-swiss/knora-api/pull/1537) | build: Add env var to set triplestore actor pool -- [#1649](https://github.com/dasch-swiss/knora-api/pull/1649) | feat(api-v2): Allow querying for rdfs:label in Gravsearch -- [#1742](https://github.com/dasch-swiss/knora-api/pull/1742) | feat: Add feature toggles (DSP-910) -- [#1741](https://github.com/dasch-swiss/knora-api/pull/1741) | DSP-804: create a child node with a custom IRI -- [#1734](https://github.com/dasch-swiss/knora-api/pull/1734) | feat(api-v2): Add metadata routes (DSP-662) -- [#1739](https://github.com/dasch-swiss/knora-api/pull/1739) | enhancement(api-v2): Optimise checking isDeleted (DSP-848) -- [#1664](https://github.com/dasch-swiss/knora-api/pull/1664) | feat(api-v2): Add support for text file upload (DSP-44) -- [#1652](https://github.com/dasch-swiss/knora-api/pull/1652) | DSP-377 Support Islamic calendar -- [#1717](https://github.com/dasch-swiss/knora-api/pull/1717) | enhancement(gravsearch): Optimise queries by moving up statements with resource IRIs -- [#1713](https://github.com/dasch-swiss/knora-api/pull/1713) | feat(gravsearch): Allow comparing variables representing resource IRIs -- [#1710](https://github.com/dasch-swiss/knora-api/pull/1710) | update ontology metadata with a comment -- [#1704](https://github.com/dasch-swiss/knora-api/pull/1704) | feat(api-v2): Add test data -- [#1703](https://github.com/dasch-swiss/knora-api/pull/1703) | Add comments to ontology metadata -- [#1686](https://github.com/dasch-swiss/knora-api/pull/1686) | feat(api-v2): Accept custom timestamps in update/delete requests -- [#1692](https://github.com/dasch-swiss/knora-api/pull/1692) | Create Permissions -- [#1696](https://github.com/dasch-swiss/knora-api/pull/1696) | feat(api-v2): Make inference optional in Gravsearch -- [#1697](https://github.com/dasch-swiss/knora-api/pull/1697) | fix(sipi): Improve performance of file value query -- [#1698](https://github.com/dasch-swiss/knora-api/pull/1698) | feat(api-v2): Accept custom new value IRI when updating value -- [#1700](https://github.com/dasch-swiss/knora-api/pull/1700) | hierarchically ordered Sequence of base classes -- [#1689](https://github.com/dasch-swiss/knora-api/pull/1689) | build: bump SIPI to v3.0.0-rc.5 (DSP-547) -- [#1679](https://github.com/dasch-swiss/knora-api/pull/1679) | Gravsearch optimisations -- [#1663](https://github.com/dasch-swiss/knora-api/pull/1663) | build: add support for SIPI v3.0.0-rc.3 (DSP-433) -- [#1660](https://github.com/dasch-swiss/knora-api/pull/1660) | feat(gravsearch): Remove deprecated functions -- [#1653](https://github.com/dasch-swiss/knora-api/pull/1653) | build: dockerize fuseki (dsp-30) - -#### Bug Fixes: - -- [#1626](https://github.com/dasch-swiss/knora-api/pull/1626) | fix(gravsearch): Prevent duplicate results -- [#1587](https://github.com/dasch-swiss/knora-api/pull/1587) | fix (webapi): Add enforcing of restrictions for username and email -- [#1576](https://github.com/dasch-swiss/knora-api/pull/1576) | Add missing env var -- [#1571](https://github.com/dasch-swiss/knora-api/pull/1571) | fixed date string format -- [#1564](https://github.com/dasch-swiss/knora-api/pull/1564) | enable click on save button in case of recoverable error -- [#1751](https://github.com/dasch-swiss/knora-api/pull/1751) | DSP-1022 SIPI_EXTERNAL_HOSTNAME doesn't contain the external hostname -- [#1749](https://github.com/dasch-swiss/knora-api/pull/1749) | fix(api-v2): Don't check file extensions of XSL files and Gravsearch templates (DSP-1005) -- [#1748](https://github.com/dasch-swiss/knora-api/pull/1748) | DSP-756 Tests failing because Knora version header and route are incorrect -- [#1746](https://github.com/dasch-swiss/knora-api/pull/1746) | DSP-932: Don't allow missing StringLiteralV2 value if language tag given -- [#1744](https://github.com/dasch-swiss/knora-api/pull/1744) | DSP-917 Releases pushed to Dockerhub from DSP-API are "dirty" -- [#1733](https://github.com/dasch-swiss/knora-api/pull/1733) | DSP-470 Intermittent bind errors -- [#1728](https://github.com/dasch-swiss/knora-api/pull/1728) | fix(api-v2): Fix post-update check for resource with standoff link (DSP-841) -- [#1723](https://github.com/dasch-swiss/knora-api/pull/1723) | chore(build): Bump testcontainers version (DSP-755) -- [#1706](https://github.com/dasch-swiss/knora-api/pull/1706) | Fix of update of list node info and update of project info -- [#1712](https://github.com/dasch-swiss/knora-api/pull/1712) | fix: failing repository upgrade at startup (DSP-654) -- [#1709](https://github.com/dasch-swiss/knora-api/pull/1709) | fix(OntologyResponderV2): Fix ontology cache update when ontology metadata changed -- [#1701](https://github.com/dasch-swiss/knora-api/pull/1701) | reverse change of Permission JSONs -- [#1693](https://github.com/dasch-swiss/knora-api/pull/1693) | fix(api-v2): Fix generated SPARQL for updating property comment -- [#1699](https://github.com/dasch-swiss/knora-api/pull/1699) | fix(gravsearch): When link property compared in filter, don't compare link value property, too -- [#1691](https://github.com/dasch-swiss/knora-api/pull/1691) | fix: server header (DSP-537) -- [#1681](https://github.com/dasch-swiss/knora-api/pull/1681) | fix: init db scripts (DSP-511) -- [#1669](https://github.com/dasch-swiss/knora-api/pull/1669) | fix: loading of data (DSP-445) - -#### Documentation: - -- [#1598](https://github.com/dasch-swiss/knora-api/pull/1598) | doc: fix sipi docs link -- [#1609](https://github.com/dasch-swiss/knora-api/pull/1609) | fix complex schema url -- [#1568](https://github.com/dasch-swiss/knora-api/pull/1568) | fixed the URI for the query -- [#1726](https://github.com/dasch-swiss/knora-api/pull/1726) | PersmissionsDocs: remove the attribute -- [#1725](https://github.com/dasch-swiss/knora-api/pull/1725) | docs: Update required mkdocs package -- [#1711](https://github.com/dasch-swiss/knora-api/pull/1711) | update developer and create resource docs -- [#1684](https://github.com/dasch-swiss/knora-api/pull/1684) | developer guideline -- [#1685](https://github.com/dasch-swiss/knora-api/pull/1685) | docs(api-v2): Document what happens when a resource has a link to a deleted resource -- [#1688](https://github.com/dasch-swiss/knora-api/pull/1688) | docs: fix broken links -- [#1694](https://github.com/dasch-swiss/knora-api/pull/1694) | docs: fix publishing -- [#1621](https://github.com/dasch-swiss/knora-api/pull/1621) | fixing typos for list rendering - -#### Other: - -- [#1750](https://github.com/dasch-swiss/knora-api/pull/1750) | Update README.md -- [#1747](https://github.com/dasch-swiss/knora-api/pull/1747) | DSP-920 Renaming default github branch to "main" ; Move to the same base branch -- [#1740](https://github.com/dasch-swiss/knora-api/pull/1740) | DSP-877 Upload api-client-test-data to GitHub release -- [#1738](https://github.com/dasch-swiss/knora-api/pull/1738) | DSP-877 Upload api-client-test-data to GitHub release -- [#1736](https://github.com/dasch-swiss/knora-api/pull/1736) | DSP-877 Upload api-client-test-data to GitHub release -- [#1730](https://github.com/dasch-swiss/knora-api/pull/1730) | DSP-816: Generate client test data for health route -- [#1719](https://github.com/dasch-swiss/knora-api/pull/1719) | change possibly conflictual env var USERNAME (DSP-706) -- [#1720](https://github.com/dasch-swiss/knora-api/pull/1720) | DSP-620 Update release process -- [#1714](https://github.com/dasch-swiss/knora-api/pull/1714) | test: fix generation of test data (DSP-665) -- [#1716](https://github.com/dasch-swiss/knora-api/pull/1716) | bulid: fix sipi image version (DSP-677) -- [#1718](https://github.com/dasch-swiss/knora-api/pull/1718) | DSP-702 Add template for PRs -- [#1715](https://github.com/dasch-swiss/knora-api/pull/1715) | chore(api-v2): Switch from JSONLD-Java to Titanium -- [#1707](https://github.com/dasch-swiss/knora-api/pull/1707) | chore: Update ci workflow -- [#1702](https://github.com/dasch-swiss/knora-api/pull/1702) | Add PR labels (DSP-607) -- [#1695](https://github.com/dasch-swiss/knora-api/pull/1695) | refactor(gravsearch): Clarify optimisations -- [#1678](https://github.com/dasch-swiss/knora-api/pull/1678) | refactor: first steps towards more independent packages (DSP-513) -- [#1680](https://github.com/dasch-swiss/knora-api/pull/1680) | build: bump rules_docker and instructions for installing bazelisk -- [#1674](https://github.com/dasch-swiss/knora-api/pull/1674) | build: add mkdocs for documentation generation (DSP-460) -- [#1480](https://github.com/dasch-swiss/knora-api/pull/1480) | build: add bazel (DSP-437) -- [#1666](https://github.com/dasch-swiss/knora-api/pull/1666) | Fix gren issue in github actions workflow -- [#1662](https://github.com/dasch-swiss/knora-api/pull/1662) | Publish on release only -- [#1661](https://github.com/dasch-swiss/knora-api/pull/1661) | Automated release notes - -#### Dependencies: - -- [#1721](https://github.com/dasch-swiss/knora-api/pull/1721) | chore: bump sipi to rc.7 (DSP-733) -- [#1735](https://github.com/dasch-swiss/knora-api/pull/1735) | DSP-496 Bump Apache Jena Fuseki and Apache Jena Libraries to 3.16 -- [#1737](https://github.com/dasch-swiss/knora-api/pull/1737) | DSP-842 Bump used Bazel version to newly released 3.7.0 -- [#1743](https://github.com/dasch-swiss/knora-api/pull/1743) | chore(build): Upgrade Sipi to 3.0.0-rc.8 (DSP-916) -- [#1745](https://github.com/dasch-swiss/knora-api/pull/1745) | chore(build): Update ScalaTest (DSP-919) -- [#1752](https://github.com/dasch-swiss/knora-api/pull/1752) | DSP-1017 Upgrade to Sipi v3.0.0-rc.9 +#### Breaking changes + +* [#1724](https://github.com/dasch-swiss/knora-api/pull/1724) | test: Collect client test data from E2E tests (DSP-724) +* [#1727](https://github.com/dasch-swiss/knora-api/pull/1727) | DSP-740 Update List Name +* [#1722](https://github.com/dasch-swiss/knora-api/pull/1722) | feat(api-v1): Change API v1 file uploads to work like API v2 (DSP-41, PR 3) +* [#1233](https://github.com/dasch-swiss/knora-api/pull/1233) | feat(api-v1): Change API v1 file uploads to work like API v2 +* [#1708](https://github.com/dasch-swiss/knora-api/pull/1708) | Get Project Permissions + +#### Enhancements + +* [#1403](https://github.com/dasch-swiss/knora-api/pull/1403) | feat: Add time value type +* [#1537](https://github.com/dasch-swiss/knora-api/pull/1537) | build: Add env var to set triplestore actor pool +* [#1649](https://github.com/dasch-swiss/knora-api/pull/1649) | feat(api-v2): Allow querying for rdfs:label in Gravsearch +* [#1742](https://github.com/dasch-swiss/knora-api/pull/1742) | feat: Add feature toggles (DSP-910) +* [#1741](https://github.com/dasch-swiss/knora-api/pull/1741) | DSP-804: create a child node with a custom IRI +* [#1734](https://github.com/dasch-swiss/knora-api/pull/1734) | feat(api-v2): Add metadata routes (DSP-662) +* [#1739](https://github.com/dasch-swiss/knora-api/pull/1739) | enhancement(api-v2): Optimise checking isDeleted (DSP-848) +* [#1664](https://github.com/dasch-swiss/knora-api/pull/1664) | feat(api-v2): Add support for text file upload (DSP-44) +* [#1652](https://github.com/dasch-swiss/knora-api/pull/1652) | DSP-377 Support Islamic calendar +* [#1717](https://github.com/dasch-swiss/knora-api/pull/1717) | enhancement(gravsearch): Optimise queries by moving up statements with resource IRIs +* [#1713](https://github.com/dasch-swiss/knora-api/pull/1713) | feat(gravsearch): Allow comparing variables representing resource IRIs +* [#1710](https://github.com/dasch-swiss/knora-api/pull/1710) | update ontology metadata with a comment +* [#1704](https://github.com/dasch-swiss/knora-api/pull/1704) | feat(api-v2): Add test data +* [#1703](https://github.com/dasch-swiss/knora-api/pull/1703) | Add comments to ontology metadata +* [#1686](https://github.com/dasch-swiss/knora-api/pull/1686) | feat(api-v2): Accept custom timestamps in update/delete requests +* [#1692](https://github.com/dasch-swiss/knora-api/pull/1692) | Create Permissions +* [#1696](https://github.com/dasch-swiss/knora-api/pull/1696) | feat(api-v2): Make inference optional in Gravsearch +* [#1697](https://github.com/dasch-swiss/knora-api/pull/1697) | fix(sipi): Improve performance of file value query +* [#1698](https://github.com/dasch-swiss/knora-api/pull/1698) | feat(api-v2): Accept custom new value IRI when updating value +* [#1700](https://github.com/dasch-swiss/knora-api/pull/1700) | hierarchically ordered Sequence of base classes +* [#1689](https://github.com/dasch-swiss/knora-api/pull/1689) | build: bump SIPI to v3.0.0-rc.5 (DSP-547) +* [#1679](https://github.com/dasch-swiss/knora-api/pull/1679) | Gravsearch optimisations +* [#1663](https://github.com/dasch-swiss/knora-api/pull/1663) | build: add support for SIPI v3.0.0-rc.3 (DSP-433) +* [#1660](https://github.com/dasch-swiss/knora-api/pull/1660) | feat(gravsearch): Remove deprecated functions +* [#1653](https://github.com/dasch-swiss/knora-api/pull/1653) | build: dockerize fuseki (dsp-30) + +#### Bug Fixes + +* [#1626](https://github.com/dasch-swiss/knora-api/pull/1626) | fix(gravsearch): Prevent duplicate results +* [#1587](https://github.com/dasch-swiss/knora-api/pull/1587) | fix (webapi): Add enforcing of restrictions for username and email +* [#1576](https://github.com/dasch-swiss/knora-api/pull/1576) | Add missing env var +* [#1571](https://github.com/dasch-swiss/knora-api/pull/1571) | fixed date string format +* [#1564](https://github.com/dasch-swiss/knora-api/pull/1564) | enable click on save button in case of recoverable error +* [#1751](https://github.com/dasch-swiss/knora-api/pull/1751) | DSP-1022 SIPI_EXTERNAL_HOSTNAME doesn't contain the external hostname +* [#1749](https://github.com/dasch-swiss/knora-api/pull/1749) | fix(api-v2): Don't check file extensions of XSL files and Gravsearch templates (DSP-1005) +* [#1748](https://github.com/dasch-swiss/knora-api/pull/1748) | DSP-756 Tests failing because Knora version header and route are incorrect +* [#1746](https://github.com/dasch-swiss/knora-api/pull/1746) | DSP-932: Don't allow missing StringLiteralV2 value if language tag given +* [#1744](https://github.com/dasch-swiss/knora-api/pull/1744) | DSP-917 Releases pushed to Dockerhub from DSP-API are "dirty" +* [#1733](https://github.com/dasch-swiss/knora-api/pull/1733) | DSP-470 Intermittent bind errors +* [#1728](https://github.com/dasch-swiss/knora-api/pull/1728) | fix(api-v2): Fix post-update check for resource with standoff link (DSP-841) +* [#1723](https://github.com/dasch-swiss/knora-api/pull/1723) | chore(build): Bump testcontainers version (DSP-755) +* [#1706](https://github.com/dasch-swiss/knora-api/pull/1706) | Fix of update of list node info and update of project info +* [#1712](https://github.com/dasch-swiss/knora-api/pull/1712) | fix: failing repository upgrade at startup (DSP-654) +* [#1709](https://github.com/dasch-swiss/knora-api/pull/1709) | fix(OntologyResponderV2): Fix ontology cache update when ontology metadata changed +* [#1701](https://github.com/dasch-swiss/knora-api/pull/1701) | reverse change of Permission JSONs +* [#1693](https://github.com/dasch-swiss/knora-api/pull/1693) | fix(api-v2): Fix generated SPARQL for updating property comment +* [#1699](https://github.com/dasch-swiss/knora-api/pull/1699) | fix(gravsearch): When link property compared in filter, don't compare link value property, too +* [#1691](https://github.com/dasch-swiss/knora-api/pull/1691) | fix: server header (DSP-537) +* [#1681](https://github.com/dasch-swiss/knora-api/pull/1681) | fix: init db scripts (DSP-511) +* [#1669](https://github.com/dasch-swiss/knora-api/pull/1669) | fix: loading of data (DSP-445) + +#### Documentation + +* [#1598](https://github.com/dasch-swiss/knora-api/pull/1598) | doc: fix sipi docs link +* [#1609](https://github.com/dasch-swiss/knora-api/pull/1609) | fix complex schema url +* [#1568](https://github.com/dasch-swiss/knora-api/pull/1568) | fixed the URI for the query +* [#1726](https://github.com/dasch-swiss/knora-api/pull/1726) | PersmissionsDocs: remove the attribute +* [#1725](https://github.com/dasch-swiss/knora-api/pull/1725) | docs: Update required mkdocs package +* [#1711](https://github.com/dasch-swiss/knora-api/pull/1711) | update developer and create resource docs +* [#1684](https://github.com/dasch-swiss/knora-api/pull/1684) | developer guideline +* [#1685](https://github.com/dasch-swiss/knora-api/pull/1685) | docs(api-v2): Document what happens when a resource has a link to a deleted resource +* [#1688](https://github.com/dasch-swiss/knora-api/pull/1688) | docs: fix broken links +* [#1694](https://github.com/dasch-swiss/knora-api/pull/1694) | docs: fix publishing +* [#1621](https://github.com/dasch-swiss/knora-api/pull/1621) | fixing typos for list rendering + +#### Other + +* [#1750](https://github.com/dasch-swiss/knora-api/pull/1750) | Update README.md +* [#1747](https://github.com/dasch-swiss/knora-api/pull/1747) | DSP-920 Renaming default github branch to "main" ; Move to the same base branch +* [#1740](https://github.com/dasch-swiss/knora-api/pull/1740) | DSP-877 Upload api-client-test-data to GitHub release +* [#1738](https://github.com/dasch-swiss/knora-api/pull/1738) | DSP-877 Upload api-client-test-data to GitHub release +* [#1736](https://github.com/dasch-swiss/knora-api/pull/1736) | DSP-877 Upload api-client-test-data to GitHub release +* [#1730](https://github.com/dasch-swiss/knora-api/pull/1730) | DSP-816: Generate client test data for health route +* [#1719](https://github.com/dasch-swiss/knora-api/pull/1719) | change possibly conflictual env var USERNAME (DSP-706) +* [#1720](https://github.com/dasch-swiss/knora-api/pull/1720) | DSP-620 Update release process +* [#1714](https://github.com/dasch-swiss/knora-api/pull/1714) | test: fix generation of test data (DSP-665) +* [#1716](https://github.com/dasch-swiss/knora-api/pull/1716) | bulid: fix sipi image version (DSP-677) +* [#1718](https://github.com/dasch-swiss/knora-api/pull/1718) | DSP-702 Add template for PRs +* [#1715](https://github.com/dasch-swiss/knora-api/pull/1715) | chore(api-v2): Switch from JSONLD-Java to Titanium +* [#1707](https://github.com/dasch-swiss/knora-api/pull/1707) | chore: Update ci workflow +* [#1702](https://github.com/dasch-swiss/knora-api/pull/1702) | Add PR labels (DSP-607) +* [#1695](https://github.com/dasch-swiss/knora-api/pull/1695) | refactor(gravsearch): Clarify optimisations +* [#1678](https://github.com/dasch-swiss/knora-api/pull/1678) | refactor: first steps towards more independent packages (DSP-513) +* [#1680](https://github.com/dasch-swiss/knora-api/pull/1680) | build: bump rules_docker and instructions for installing bazelisk +* [#1674](https://github.com/dasch-swiss/knora-api/pull/1674) | build: add mkdocs for documentation generation (DSP-460) +* [#1480](https://github.com/dasch-swiss/knora-api/pull/1480) | build: add bazel (DSP-437) +* [#1666](https://github.com/dasch-swiss/knora-api/pull/1666) | Fix gren issue in github actions workflow +* [#1662](https://github.com/dasch-swiss/knora-api/pull/1662) | Publish on release only +* [#1661](https://github.com/dasch-swiss/knora-api/pull/1661) | Automated release notes + +#### Dependencies + +* [#1721](https://github.com/dasch-swiss/knora-api/pull/1721) | chore: bump sipi to rc.7 (DSP-733) +* [#1735](https://github.com/dasch-swiss/knora-api/pull/1735) | DSP-496 Bump Apache Jena Fuseki and Apache Jena Libraries to 3.16 +* [#1737](https://github.com/dasch-swiss/knora-api/pull/1737) | DSP-842 Bump used Bazel version to newly released 3.7.0 +* [#1743](https://github.com/dasch-swiss/knora-api/pull/1743) | chore(build): Upgrade Sipi to 3.0.0-rc.8 (DSP-916) +* [#1745](https://github.com/dasch-swiss/knora-api/pull/1745) | chore(build): Update ScalaTest (DSP-919) +* [#1752](https://github.com/dasch-swiss/knora-api/pull/1752) | DSP-1017 Upgrade to Sipi v3.0.0-rc.9 --- ## v13.0.0-rc.21 (09/11/2020) -#### Breaking changes: - -- [#1724](https://github.com/dasch-swiss/knora-api/pull/1724) | test: Collect client test data from E2E tests (DSP-724) -- [#1727](https://github.com/dasch-swiss/knora-api/pull/1727) | DSP-740 Update List Name -- [#1722](https://github.com/dasch-swiss/knora-api/pull/1722) | feat(api-v1): Change API v1 file uploads to work like API v2 (DSP-41, PR 3) -- [#1233](https://github.com/dasch-swiss/knora-api/pull/1233) | feat(api-v1): Change API v1 file uploads to work like API v2 -- [#1708](https://github.com/dasch-swiss/knora-api/pull/1708) | Get Project Permissions - -#### Enhancements: - -- [#1403](https://github.com/dasch-swiss/knora-api/pull/1403) | feat: Add time value type -- [#1649](https://github.com/dasch-swiss/knora-api/pull/1649) | feat(api-v2): Allow querying for rdfs:label in Gravsearch -- [#1742](https://github.com/dasch-swiss/knora-api/pull/1742) | feat: Add feature toggles (DSP-910) -- [#1741](https://github.com/dasch-swiss/knora-api/pull/1741) | DSP-804: create a child node with a custom IRI -- [#1734](https://github.com/dasch-swiss/knora-api/pull/1734) | feat(api-v2): Add metadata routes (DSP-662) -- [#1739](https://github.com/dasch-swiss/knora-api/pull/1739) | enhancement(api-v2): Optimise checking isDeleted (DSP-848) -- [#1664](https://github.com/dasch-swiss/knora-api/pull/1664) | feat(api-v2): Add support for text file upload (DSP-44) -- [#1652](https://github.com/dasch-swiss/knora-api/pull/1652) | DSP-377 Support Islamic calendar -- [#1717](https://github.com/dasch-swiss/knora-api/pull/1717) | enhancement(gravsearch): Optimise queries by moving up statements with resource IRIs -- [#1713](https://github.com/dasch-swiss/knora-api/pull/1713) | feat(gravsearch): Allow comparing variables representing resource IRIs -- [#1710](https://github.com/dasch-swiss/knora-api/pull/1710) | update ontology metadata with a comment -- [#1704](https://github.com/dasch-swiss/knora-api/pull/1704) | feat(api-v2): Add test data -- [#1703](https://github.com/dasch-swiss/knora-api/pull/1703) | Add comments to ontology metadata -- [#1686](https://github.com/dasch-swiss/knora-api/pull/1686) | feat(api-v2): Accept custom timestamps in update/delete requests -- [#1692](https://github.com/dasch-swiss/knora-api/pull/1692) | Create Permissions -- [#1696](https://github.com/dasch-swiss/knora-api/pull/1696) | feat(api-v2): Make inference optional in Gravsearch -- [#1697](https://github.com/dasch-swiss/knora-api/pull/1697) | fix(sipi): Improve performance of file value query -- [#1698](https://github.com/dasch-swiss/knora-api/pull/1698) | feat(api-v2): Accept custom new value IRI when updating value -- [#1700](https://github.com/dasch-swiss/knora-api/pull/1700) | hierarchically ordered Sequence of base classes -- [#1689](https://github.com/dasch-swiss/knora-api/pull/1689) | build: bump SIPI to v3.0.0-rc.5 (DSP-547) -- [#1679](https://github.com/dasch-swiss/knora-api/pull/1679) | Gravsearch optimisations -- [#1663](https://github.com/dasch-swiss/knora-api/pull/1663) | build: add support for SIPI v3.0.0-rc.3 (DSP-433) -- [#1660](https://github.com/dasch-swiss/knora-api/pull/1660) | feat(gravsearch): Remove deprecated functions -- [#1653](https://github.com/dasch-swiss/knora-api/pull/1653) | build: dockerize fuseki (dsp-30) - -#### Bug Fixes: - -- [#1626](https://github.com/dasch-swiss/knora-api/pull/1626) | fix(gravsearch): Prevent duplicate results -- [#1587](https://github.com/dasch-swiss/knora-api/pull/1587) | fix (webapi): Add enforcing of restrictions for username and email -- [#1751](https://github.com/dasch-swiss/knora-api/pull/1751) | DSP-1022 SIPI_EXTERNAL_HOSTNAME doesn't contain the external hostname -- [#1749](https://github.com/dasch-swiss/knora-api/pull/1749) | fix(api-v2): Don't check file extensions of XSL files and Gravsearch templates (DSP-1005) -- [#1748](https://github.com/dasch-swiss/knora-api/pull/1748) | DSP-756 Tests failing because Knora version header and route are incorrect -- [#1746](https://github.com/dasch-swiss/knora-api/pull/1746) | DSP-932: Don't allow missing StringLiteralV2 value if language tag given -- [#1744](https://github.com/dasch-swiss/knora-api/pull/1744) | DSP-917 Releases pushed to Dockerhub from DSP-API are "dirty" -- [#1733](https://github.com/dasch-swiss/knora-api/pull/1733) | DSP-470 Intermittent bind errors -- [#1728](https://github.com/dasch-swiss/knora-api/pull/1728) | fix(api-v2): Fix post-update check for resource with standoff link (DSP-841) -- [#1723](https://github.com/dasch-swiss/knora-api/pull/1723) | chore(build): Bump testcontainers version (DSP-755) -- [#1706](https://github.com/dasch-swiss/knora-api/pull/1706) | Fix of update of list node info and update of project info -- [#1712](https://github.com/dasch-swiss/knora-api/pull/1712) | fix: failing repository upgrade at startup (DSP-654) -- [#1709](https://github.com/dasch-swiss/knora-api/pull/1709) | fix(OntologyResponderV2): Fix ontology cache update when ontology metadata changed -- [#1701](https://github.com/dasch-swiss/knora-api/pull/1701) | reverse change of Permission JSONs -- [#1693](https://github.com/dasch-swiss/knora-api/pull/1693) | fix(api-v2): Fix generated SPARQL for updating property comment -- [#1699](https://github.com/dasch-swiss/knora-api/pull/1699) | fix(gravsearch): When link property compared in filter, don't compare link value property, too -- [#1691](https://github.com/dasch-swiss/knora-api/pull/1691) | fix: server header (DSP-537) -- [#1681](https://github.com/dasch-swiss/knora-api/pull/1681) | fix: init db scripts (DSP-511) -- [#1669](https://github.com/dasch-swiss/knora-api/pull/1669) | fix: loading of data (DSP-445) - -#### Documentation: - -- [#1598](https://github.com/dasch-swiss/knora-api/pull/1598) | doc: fix sipi docs link -- [#1609](https://github.com/dasch-swiss/knora-api/pull/1609) | fix complex schema url -- [#1568](https://github.com/dasch-swiss/knora-api/pull/1568) | fixed the URI for the query -- [#1726](https://github.com/dasch-swiss/knora-api/pull/1726) | PersmissionsDocs: remove the attribute -- [#1725](https://github.com/dasch-swiss/knora-api/pull/1725) | docs: Update required mkdocs package -- [#1711](https://github.com/dasch-swiss/knora-api/pull/1711) | update developer and create resource docs -- [#1684](https://github.com/dasch-swiss/knora-api/pull/1684) | developer guideline -- [#1685](https://github.com/dasch-swiss/knora-api/pull/1685) | docs(api-v2): Document what happens when a resource has a link to a deleted resource -- [#1688](https://github.com/dasch-swiss/knora-api/pull/1688) | docs: fix broken links -- [#1694](https://github.com/dasch-swiss/knora-api/pull/1694) | docs: fix publishing -- [#1621](https://github.com/dasch-swiss/knora-api/pull/1621) | fixing typos for list rendering - -#### Other: - -- [#1750](https://github.com/dasch-swiss/knora-api/pull/1750) | Update README.md -- [#1747](https://github.com/dasch-swiss/knora-api/pull/1747) | DSP-920 Renaming default github branch to "main" ; Move to the same base branch -- [#1740](https://github.com/dasch-swiss/knora-api/pull/1740) | DSP-877 Upload api-client-test-data to GitHub release -- [#1738](https://github.com/dasch-swiss/knora-api/pull/1738) | DSP-877 Upload api-client-test-data to GitHub release -- [#1736](https://github.com/dasch-swiss/knora-api/pull/1736) | DSP-877 Upload api-client-test-data to GitHub release -- [#1730](https://github.com/dasch-swiss/knora-api/pull/1730) | DSP-816: Generate client test data for health route -- [#1719](https://github.com/dasch-swiss/knora-api/pull/1719) | change possibly conflictual env var USERNAME (DSP-706) -- [#1720](https://github.com/dasch-swiss/knora-api/pull/1720) | DSP-620 Update release process -- [#1714](https://github.com/dasch-swiss/knora-api/pull/1714) | test: fix generation of test data (DSP-665) -- [#1716](https://github.com/dasch-swiss/knora-api/pull/1716) | bulid: fix sipi image version (DSP-677) -- [#1718](https://github.com/dasch-swiss/knora-api/pull/1718) | DSP-702 Add template for PRs -- [#1715](https://github.com/dasch-swiss/knora-api/pull/1715) | chore(api-v2): Switch from JSONLD-Java to Titanium -- [#1707](https://github.com/dasch-swiss/knora-api/pull/1707) | chore: Update ci workflow -- [#1702](https://github.com/dasch-swiss/knora-api/pull/1702) | Add PR labels (DSP-607) -- [#1695](https://github.com/dasch-swiss/knora-api/pull/1695) | refactor(gravsearch): Clarify optimisations -- [#1678](https://github.com/dasch-swiss/knora-api/pull/1678) | refactor: first steps towards more independent packages (DSP-513) -- [#1680](https://github.com/dasch-swiss/knora-api/pull/1680) | build: bump rules_docker and instructions for installing bazelisk -- [#1674](https://github.com/dasch-swiss/knora-api/pull/1674) | build: add mkdocs for documentation generation (DSP-460) -- [#1480](https://github.com/dasch-swiss/knora-api/pull/1480) | build: add bazel (DSP-437) -- [#1666](https://github.com/dasch-swiss/knora-api/pull/1666) | Fix gren issue in github actions workflow -- [#1662](https://github.com/dasch-swiss/knora-api/pull/1662) | Publish on release only -- [#1661](https://github.com/dasch-swiss/knora-api/pull/1661) | Automated release notes +#### Breaking changes + +* [#1724](https://github.com/dasch-swiss/knora-api/pull/1724) | test: Collect client test data from E2E tests (DSP-724) +* [#1727](https://github.com/dasch-swiss/knora-api/pull/1727) | DSP-740 Update List Name +* [#1722](https://github.com/dasch-swiss/knora-api/pull/1722) | feat(api-v1): Change API v1 file uploads to work like API v2 (DSP-41, PR 3) +* [#1233](https://github.com/dasch-swiss/knora-api/pull/1233) | feat(api-v1): Change API v1 file uploads to work like API v2 +* [#1708](https://github.com/dasch-swiss/knora-api/pull/1708) | Get Project Permissions + +#### Enhancements + +* [#1403](https://github.com/dasch-swiss/knora-api/pull/1403) | feat: Add time value type +* [#1649](https://github.com/dasch-swiss/knora-api/pull/1649) | feat(api-v2): Allow querying for rdfs:label in Gravsearch +* [#1742](https://github.com/dasch-swiss/knora-api/pull/1742) | feat: Add feature toggles (DSP-910) +* [#1741](https://github.com/dasch-swiss/knora-api/pull/1741) | DSP-804: create a child node with a custom IRI +* [#1734](https://github.com/dasch-swiss/knora-api/pull/1734) | feat(api-v2): Add metadata routes (DSP-662) +* [#1739](https://github.com/dasch-swiss/knora-api/pull/1739) | enhancement(api-v2): Optimise checking isDeleted (DSP-848) +* [#1664](https://github.com/dasch-swiss/knora-api/pull/1664) | feat(api-v2): Add support for text file upload (DSP-44) +* [#1652](https://github.com/dasch-swiss/knora-api/pull/1652) | DSP-377 Support Islamic calendar +* [#1717](https://github.com/dasch-swiss/knora-api/pull/1717) | enhancement(gravsearch): Optimise queries by moving up statements with resource IRIs +* [#1713](https://github.com/dasch-swiss/knora-api/pull/1713) | feat(gravsearch): Allow comparing variables representing resource IRIs +* [#1710](https://github.com/dasch-swiss/knora-api/pull/1710) | update ontology metadata with a comment +* [#1704](https://github.com/dasch-swiss/knora-api/pull/1704) | feat(api-v2): Add test data +* [#1703](https://github.com/dasch-swiss/knora-api/pull/1703) | Add comments to ontology metadata +* [#1686](https://github.com/dasch-swiss/knora-api/pull/1686) | feat(api-v2): Accept custom timestamps in update/delete requests +* [#1692](https://github.com/dasch-swiss/knora-api/pull/1692) | Create Permissions +* [#1696](https://github.com/dasch-swiss/knora-api/pull/1696) | feat(api-v2): Make inference optional in Gravsearch +* [#1697](https://github.com/dasch-swiss/knora-api/pull/1697) | fix(sipi): Improve performance of file value query +* [#1698](https://github.com/dasch-swiss/knora-api/pull/1698) | feat(api-v2): Accept custom new value IRI when updating value +* [#1700](https://github.com/dasch-swiss/knora-api/pull/1700) | hierarchically ordered Sequence of base classes +* [#1689](https://github.com/dasch-swiss/knora-api/pull/1689) | build: bump SIPI to v3.0.0-rc.5 (DSP-547) +* [#1679](https://github.com/dasch-swiss/knora-api/pull/1679) | Gravsearch optimisations +* [#1663](https://github.com/dasch-swiss/knora-api/pull/1663) | build: add support for SIPI v3.0.0-rc.3 (DSP-433) +* [#1660](https://github.com/dasch-swiss/knora-api/pull/1660) | feat(gravsearch): Remove deprecated functions +* [#1653](https://github.com/dasch-swiss/knora-api/pull/1653) | build: dockerize fuseki (dsp-30) + +#### Bug Fixes + +* [#1626](https://github.com/dasch-swiss/knora-api/pull/1626) | fix(gravsearch): Prevent duplicate results +* [#1587](https://github.com/dasch-swiss/knora-api/pull/1587) | fix (webapi): Add enforcing of restrictions for username and email +* [#1751](https://github.com/dasch-swiss/knora-api/pull/1751) | DSP-1022 SIPI_EXTERNAL_HOSTNAME doesn't contain the external hostname +* [#1749](https://github.com/dasch-swiss/knora-api/pull/1749) | fix(api-v2): Don't check file extensions of XSL files and Gravsearch templates (DSP-1005) +* [#1748](https://github.com/dasch-swiss/knora-api/pull/1748) | DSP-756 Tests failing because Knora version header and route are incorrect +* [#1746](https://github.com/dasch-swiss/knora-api/pull/1746) | DSP-932: Don't allow missing StringLiteralV2 value if language tag given +* [#1744](https://github.com/dasch-swiss/knora-api/pull/1744) | DSP-917 Releases pushed to Dockerhub from DSP-API are "dirty" +* [#1733](https://github.com/dasch-swiss/knora-api/pull/1733) | DSP-470 Intermittent bind errors +* [#1728](https://github.com/dasch-swiss/knora-api/pull/1728) | fix(api-v2): Fix post-update check for resource with standoff link (DSP-841) +* [#1723](https://github.com/dasch-swiss/knora-api/pull/1723) | chore(build): Bump testcontainers version (DSP-755) +* [#1706](https://github.com/dasch-swiss/knora-api/pull/1706) | Fix of update of list node info and update of project info +* [#1712](https://github.com/dasch-swiss/knora-api/pull/1712) | fix: failing repository upgrade at startup (DSP-654) +* [#1709](https://github.com/dasch-swiss/knora-api/pull/1709) | fix(OntologyResponderV2): Fix ontology cache update when ontology metadata changed +* [#1701](https://github.com/dasch-swiss/knora-api/pull/1701) | reverse change of Permission JSONs +* [#1693](https://github.com/dasch-swiss/knora-api/pull/1693) | fix(api-v2): Fix generated SPARQL for updating property comment +* [#1699](https://github.com/dasch-swiss/knora-api/pull/1699) | fix(gravsearch): When link property compared in filter, don't compare link value property, too +* [#1691](https://github.com/dasch-swiss/knora-api/pull/1691) | fix: server header (DSP-537) +* [#1681](https://github.com/dasch-swiss/knora-api/pull/1681) | fix: init db scripts (DSP-511) +* [#1669](https://github.com/dasch-swiss/knora-api/pull/1669) | fix: loading of data (DSP-445) + +#### Documentation + +* [#1598](https://github.com/dasch-swiss/knora-api/pull/1598) | doc: fix sipi docs link +* [#1609](https://github.com/dasch-swiss/knora-api/pull/1609) | fix complex schema url +* [#1568](https://github.com/dasch-swiss/knora-api/pull/1568) | fixed the URI for the query +* [#1726](https://github.com/dasch-swiss/knora-api/pull/1726) | PersmissionsDocs: remove the attribute +* [#1725](https://github.com/dasch-swiss/knora-api/pull/1725) | docs: Update required mkdocs package +* [#1711](https://github.com/dasch-swiss/knora-api/pull/1711) | update developer and create resource docs +* [#1684](https://github.com/dasch-swiss/knora-api/pull/1684) | developer guideline +* [#1685](https://github.com/dasch-swiss/knora-api/pull/1685) | docs(api-v2): Document what happens when a resource has a link to a deleted resource +* [#1688](https://github.com/dasch-swiss/knora-api/pull/1688) | docs: fix broken links +* [#1694](https://github.com/dasch-swiss/knora-api/pull/1694) | docs: fix publishing +* [#1621](https://github.com/dasch-swiss/knora-api/pull/1621) | fixing typos for list rendering + +#### Other + +* [#1750](https://github.com/dasch-swiss/knora-api/pull/1750) | Update README.md +* [#1747](https://github.com/dasch-swiss/knora-api/pull/1747) | DSP-920 Renaming default github branch to "main" ; Move to the same base branch +* [#1740](https://github.com/dasch-swiss/knora-api/pull/1740) | DSP-877 Upload api-client-test-data to GitHub release +* [#1738](https://github.com/dasch-swiss/knora-api/pull/1738) | DSP-877 Upload api-client-test-data to GitHub release +* [#1736](https://github.com/dasch-swiss/knora-api/pull/1736) | DSP-877 Upload api-client-test-data to GitHub release +* [#1730](https://github.com/dasch-swiss/knora-api/pull/1730) | DSP-816: Generate client test data for health route +* [#1719](https://github.com/dasch-swiss/knora-api/pull/1719) | change possibly conflictual env var USERNAME (DSP-706) +* [#1720](https://github.com/dasch-swiss/knora-api/pull/1720) | DSP-620 Update release process +* [#1714](https://github.com/dasch-swiss/knora-api/pull/1714) | test: fix generation of test data (DSP-665) +* [#1716](https://github.com/dasch-swiss/knora-api/pull/1716) | bulid: fix sipi image version (DSP-677) +* [#1718](https://github.com/dasch-swiss/knora-api/pull/1718) | DSP-702 Add template for PRs +* [#1715](https://github.com/dasch-swiss/knora-api/pull/1715) | chore(api-v2): Switch from JSONLD-Java to Titanium +* [#1707](https://github.com/dasch-swiss/knora-api/pull/1707) | chore: Update ci workflow +* [#1702](https://github.com/dasch-swiss/knora-api/pull/1702) | Add PR labels (DSP-607) +* [#1695](https://github.com/dasch-swiss/knora-api/pull/1695) | refactor(gravsearch): Clarify optimisations +* [#1678](https://github.com/dasch-swiss/knora-api/pull/1678) | refactor: first steps towards more independent packages (DSP-513) +* [#1680](https://github.com/dasch-swiss/knora-api/pull/1680) | build: bump rules_docker and instructions for installing bazelisk +* [#1674](https://github.com/dasch-swiss/knora-api/pull/1674) | build: add mkdocs for documentation generation (DSP-460) +* [#1480](https://github.com/dasch-swiss/knora-api/pull/1480) | build: add bazel (DSP-437) +* [#1666](https://github.com/dasch-swiss/knora-api/pull/1666) | Fix gren issue in github actions workflow +* [#1662](https://github.com/dasch-swiss/knora-api/pull/1662) | Publish on release only +* [#1661](https://github.com/dasch-swiss/knora-api/pull/1661) | Automated release notes --- @@ -459,17 +443,17 @@ #### Breaking API Changes -- [#1439](https://github.com/dasch-swiss/knora-api/issues/1439) JSON-LD Serialization of an xsd:dateTimeStamp +* [#1439](https://github.com/dasch-swiss/knora-api/issues/1439) JSON-LD Serialization of an xsd:dateTimeStamp #### New Features and Enhancements -- [#1509](https://github.com/dasch-swiss/knora-api/pull/1509) Support lists admin endpoint -- [#1466](https://github.com/dasch-swiss/knora-api/pull/1466) Optimise generated SPARQL +* [#1509](https://github.com/dasch-swiss/knora-api/pull/1509) Support lists admin endpoint +* [#1466](https://github.com/dasch-swiss/knora-api/pull/1466) Optimise generated SPARQL #### Bug Fixes -- [#1569](https://github.com/dasch-swiss/knora-api/issues/1569) broken ark -- [#1559](https://github.com/dasch-swiss/knora-api/issues/1559) Admin lists: createChildNode should send a httpPost request, not httpPut +* [#1569](https://github.com/dasch-swiss/knora-api/issues/1569) broken ark +* [#1559](https://github.com/dasch-swiss/knora-api/issues/1559) Admin lists: createChildNode should send a httpPost request, not httpPut --- @@ -477,14 +461,14 @@ #### Breaking Changes -- [#1344](https://github.com/dasch-swiss/knora-api/issues/1344) Gravsearch ForbiddenResource result and permissions of linked resources -- [#1202](https://github.com/dasch-swiss/knora-api/issues/1202) Implement upload of PDF and text files in API v2. Users with files in Sipi under `/server` must move them to `/images` when upgrading. +* [#1344](https://github.com/dasch-swiss/knora-api/issues/1344) Gravsearch ForbiddenResource result and permissions of linked resources +* [#1202](https://github.com/dasch-swiss/knora-api/issues/1202) Implement upload of PDF and text files in API v2. Users with files in Sipi under `/server` must move them to `/images` when upgrading. -#### Bug Fixes: +#### Bug Fixes -- [#1531](https://github.com/dasch-swiss/knora-api/issues/1531) Sipi's mimetype_consistency fails with .bin file -- [#1430](https://github.com/dasch-swiss/knora-api/issues/1430) Creating the first resource with an image inside a project fails with Sipi not finding the project folder -- [#924](https://github.com/dasch-swiss/knora-api/issues/924) Get dependent resources Iris +* [#1531](https://github.com/dasch-swiss/knora-api/issues/1531) Sipi's mimetype_consistency fails with .bin file +* [#1430](https://github.com/dasch-swiss/knora-api/issues/1430) Creating the first resource with an image inside a project fails with Sipi not finding the project folder +* [#924](https://github.com/dasch-swiss/knora-api/issues/924) Get dependent resources Iris --- @@ -500,36 +484,36 @@ #### Breaking Changes -- [#1346](https://github.com/dasch-swiss/knora-api/issues/1346) Richtext/HTML in page anchor link +* [#1346](https://github.com/dasch-swiss/knora-api/issues/1346) Richtext/HTML in page anchor link -#### Enhancements: +#### Enhancements -- [#1457](https://github.com/dasch-swiss/knora-api/issues/1457) Upgrade sipi to 2.0.1 +* [#1457](https://github.com/dasch-swiss/knora-api/issues/1457) Upgrade sipi to 2.0.1 -#### Bug Fixes: +#### Bug Fixes -- [#1460](https://github.com/dasch-swiss/knora-api/issues/1460) Build banner in README is broken +* [#1460](https://github.com/dasch-swiss/knora-api/issues/1460) Build banner in README is broken -#### Documentation: +#### Documentation -- [#1481](https://github.com/dasch-swiss/knora-api/issues/1481) build badge in README has broken link +* [#1481](https://github.com/dasch-swiss/knora-api/issues/1481) build badge in README has broken link #### Other -- [#1449](https://github.com/dasch-swiss/knora-api/issues/1449) Add Makefile-based task execution -- [#1401](https://github.com/dasch-swiss/knora-api/issues/1401) Enable testing docs generation in Travis +* [#1449](https://github.com/dasch-swiss/knora-api/issues/1449) Add Makefile-based task execution +* [#1401](https://github.com/dasch-swiss/knora-api/issues/1401) Enable testing docs generation in Travis --- ## v9.1.0 (26/09/2019) -#### Enhancements: +#### Enhancements -- [#1421](https://github.com/dhlab-basel/Knora/issues/1421) Physically deleting a resource +* [#1421](https://github.com/dhlab-basel/Knora/issues/1421) Physically deleting a resource -#### Documentation: +#### Documentation -- [#1407](https://github.com/dhlab-basel/Knora/issues/1407) Document ARK URLs for projects +* [#1407](https://github.com/dhlab-basel/Knora/issues/1407) Document ARK URLs for projects --- @@ -537,163 +521,171 @@ #### Breaking Changes -- [#1411](https://github.com/dhlab-basel/Knora/issues/1411) Moved `/admin/groups/members/GROUP_IRI` to `/admin/groups/GROUP_IRI/members` -- [#1231](https://github.com/dhlab-basel/Knora/issues/1231) Change value permissions -- [#763](https://github.com/dhlab-basel/Knora/issues/763) refactor splitMainResourcesAndValueRdfData so it uses SparqlExtendedConstructResponse +* [#1411](https://github.com/dhlab-basel/Knora/issues/1411) Moved `/admin/groups/members/GROUP_IRI` to `/admin/groups/GROUP_IRI/members` +* [#1231](https://github.com/dhlab-basel/Knora/issues/1231) Change value permissions +* [#763](https://github.com/dhlab-basel/Knora/issues/763) refactor splitMainResourcesAndValueRdfData so it uses SparqlExtendedConstructResponse -#### Enhancements: +#### Enhancements -- [#1373](https://github.com/dhlab-basel/Knora/issues/1373) The startup ends in a thrown exception if the triplestore is not up-to-date -- [#1364](https://github.com/dhlab-basel/Knora/issues/1364) Add support for Redis cache -- [#1360](https://github.com/dhlab-basel/Knora/issues/1360) Build and publish Knora version specific docker images for GraphDB Free and SE -- [#1358](https://github.com/dhlab-basel/Knora/issues/1358) Add admin route to dump project data +* [#1373](https://github.com/dhlab-basel/Knora/issues/1373) The startup ends in a thrown exception if the triplestore is not up-to-date +* [#1364](https://github.com/dhlab-basel/Knora/issues/1364) Add support for Redis cache +* [#1360](https://github.com/dhlab-basel/Knora/issues/1360) Build and publish Knora version specific docker images for GraphDB Free and SE +* [#1358](https://github.com/dhlab-basel/Knora/issues/1358) Add admin route to dump project data -#### Bug Fixes: +#### Bug Fixes -- [#1394](https://github.com/dhlab-basel/Knora/issues/1394) Using dockerComposeUp to start the stack, fails to find Redis at startup +* [#1394](https://github.com/dhlab-basel/Knora/issues/1394) Using dockerComposeUp to start the stack, fails to find Redis at startup -#### Documentation: +#### Documentation -- [#1386](https://github.com/dhlab-basel/Knora/issues/1386) Add lists admin API documentation +* [#1386](https://github.com/dhlab-basel/Knora/issues/1386) Add lists admin API documentation #### Other -- [#1412](https://github.com/dhlab-basel/Knora/issues/1412) Change release notes to be based on issues +* [#1412](https://github.com/dhlab-basel/Knora/issues/1412) Change release notes to be based on issues --- ## v8.0.0 (14/06/2019) -- [feature(webapi): Add GraphDB-Free startup support (#1351)](https://github.com/dhlab-basel/Knora/commit/5ecb54c563dc2ec38dbbcdf544c5f86f0ce90d0d) - @subotic -- [feature(webapi): Add returning of fixed public user information (#1348)](https://github.com/dhlab-basel/Knora/commit/ff6b140bf7e6b8b481bb1773a5accc3ba5d5d9fe) - @subotic -- [feat(api-v2): No custom permissions higher than defaults (#1337)](https://github.com/dhlab-basel/Knora/commit/7b61b49d7686a13a79f5f25c5f0e20cab0b6c12f) - @benjamingeer -- [feat(upgrade): Improve upgrade framework (#1345)](https://github.com/dhlab-basel/Knora/commit/06487b1e6b227cc7794e53f19e30551774015686) - @benjamingeer -- [test(webapi): Add new user authentication (#1201)](https://github.com/dhlab-basel/Knora/commit/1845eb1a0caa0441483d28176b84a2a59cfebe3a) - @subotic -- [chore(webapi): Add request duration logging (#1347)](https://github.com/dhlab-basel/Knora/commit/9b701f9adcb3e710e8e39bc35c3cb7964bde531a) - @subotic -- [feat(api-v2): Make values citable (#1322)](https://github.com/dhlab-basel/Knora/commit/9f99af11ca466da8943f2d6b44342fed2beca9ba) - @benjamingeer -- [Leibniz ontology (#1326)](https://github.com/dhlab-basel/Knora/commit/56e311d03dfed2b42f490abab01a0d612be11d15) - @SepidehAlassi -- [feature(webapi): add CORS allow header (#1340)](https://github.com/dhlab-basel/Knora/commit/64177807a070a36c6c852b8f7d79645f45d0ce7b) - @subotic -- [fix(sipi): Return permissions for a previous version of a file value. (#1339)](https://github.com/dhlab-basel/Knora/commit/9a3cee3b665fa1fdd82615932f43b1bd8551f402) - @benjamingeer -- [fix(scripts): add admin ontology data to correct graph (#1333)](https://github.com/dhlab-basel/Knora/commit/002eca45187e4c7ec30129c57ccaa095547a420e) - @subotic -- [fix(sipi): Don't try to read a file value in a deleted resource. (#1329)](https://github.com/dhlab-basel/Knora/commit/3adb22e88615e7edcdf2c2d2c8ab905dbe7f40db) - @benjamingeer -- [docs(api-v2): Fix sample responses. (#1327)](https://github.com/dhlab-basel/Knora/commit/904c638b537350e2cfe881ccf3e9b51d955150c1) - @benjamingeer -- [fix(api-v2): Fix typo. (#1325)](https://github.com/dhlab-basel/Knora/commit/72d89dc4a870fa8bd6f1ac60b0743a022adbb99c) - @benjamingeer -- [Handle List Nodes in Response (#1321)](https://github.com/dhlab-basel/Knora/commit/611f42880902065d28fcb84742f90757840d9ed5) - @tobiasschweizer -- [feat(api-v2): Return standoff markup separately from text values (#1307)](https://github.com/dhlab-basel/Knora/commit/ffbb5965223dfaea6cec77201fea5c9fd11bbc67) - @benjamingeer -- [BEOL: Import comments for Meditationes (#1281)](https://github.com/dhlab-basel/Knora/commit/9480f42faa64873a82fb2528a0bc8011669c7c49) - @tobiasschweizer -- [feat(triplestore): Log SPARQL query if triplestore doesn't respond. (#1292)](https://github.com/dhlab-basel/Knora/commit/522b3a9f6effad2d9fa1332c85e4a406a846d223) - @benjamingeer -- [Support list nodes in Gravsearch (#1314)](https://github.com/dhlab-basel/Knora/commit/0a1845c54a26d4fe00d2084daa7bff73ae571280) - @tobiasschweizer +* [feature(webapi): Add GraphDB-Free startup support (#1351)](https://github.com/dhlab-basel/Knora/commit/5ecb54c563dc2ec38dbbcdf544c5f86f0ce90d0d) - @subotic +* [feature(webapi): Add returning of fixed public user information (#1348)](https://github.com/dhlab-basel/Knora/commit/ff6b140bf7e6b8b481bb1773a5accc3ba5d5d9fe) - @subotic +* [feat(api-v2): No custom permissions higher than defaults (#1337)](https://github.com/dhlab-basel/Knora/commit/7b61b49d7686a13a79f5f25c5f0e20cab0b6c12f) - @benjamingeer +* [feat(upgrade): Improve upgrade framework (#1345)](https://github.com/dhlab-basel/Knora/commit/06487b1e6b227cc7794e53f19e30551774015686) - @benjamingeer +* [test(webapi): Add new user authentication (#1201)](https://github.com/dhlab-basel/Knora/commit/1845eb1a0caa0441483d28176b84a2a59cfebe3a) - @subotic +* [chore(webapi): Add request duration logging (#1347)](https://github.com/dhlab-basel/Knora/commit/9b701f9adcb3e710e8e39bc35c3cb7964bde531a) - @subotic +* [feat(api-v2): Make values citable (#1322)](https://github.com/dhlab-basel/Knora/commit/9f99af11ca466da8943f2d6b44342fed2beca9ba) - @benjamingeer +* [Leibniz ontology (#1326)](https://github.com/dhlab-basel/Knora/commit/56e311d03dfed2b42f490abab01a0d612be11d15) - @SepidehAlassi +* [feature(webapi): add CORS allow header (#1340)](https://github.com/dhlab-basel/Knora/commit/64177807a070a36c6c852b8f7d79645f45d0ce7b) - @subotic +* [fix(sipi): Return permissions for a previous version of a file value. (#1339)](https://github.com/dhlab-basel/Knora/commit/9a3cee3b665fa1fdd82615932f43b1bd8551f402) - @benjamingeer +* [fix(scripts): add admin ontology data to correct graph (#1333)](https://github.com/dhlab-basel/Knora/commit/002eca45187e4c7ec30129c57ccaa095547a420e) - @subotic +* [fix(sipi): Don't try to read a file value in a deleted resource. (#1329)](https://github.com/dhlab-basel/Knora/commit/3adb22e88615e7edcdf2c2d2c8ab905dbe7f40db) - @benjamingeer +* [docs(api-v2): Fix sample responses. (#1327)](https://github.com/dhlab-basel/Knora/commit/904c638b537350e2cfe881ccf3e9b51d955150c1) - @benjamingeer +* [fix(api-v2): Fix typo. (#1325)](https://github.com/dhlab-basel/Knora/commit/72d89dc4a870fa8bd6f1ac60b0743a022adbb99c) - @benjamingeer +* [Handle List Nodes in Response (#1321)](https://github.com/dhlab-basel/Knora/commit/611f42880902065d28fcb84742f90757840d9ed5) - @tobiasschweizer +* [feat(api-v2): Return standoff markup separately from text values (#1307)](https://github.com/dhlab-basel/Knora/commit/ffbb5965223dfaea6cec77201fea5c9fd11bbc67) - @benjamingeer +* [BEOL: Import comments for Meditationes (#1281)](https://github.com/dhlab-basel/Knora/commit/9480f42faa64873a82fb2528a0bc8011669c7c49) - @tobiasschweizer +* [feat(triplestore): Log SPARQL query if triplestore doesn't respond. (#1292)](https://github.com/dhlab-basel/Knora/commit/522b3a9f6effad2d9fa1332c85e4a406a846d223) - @benjamingeer +* [Support list nodes in Gravsearch (#1314)](https://github.com/dhlab-basel/Knora/commit/0a1845c54a26d4fe00d2084daa7bff73ae571280) - @tobiasschweizer --- ## v7.0.0 (03/05/2019) -- [fix(api-v2): Cache base class IRIs correctly when creating/updating class (#1311)](https://github.com/dhlab-basel/Knora/commit/db8b938f605aad966de4f77d269be404f56f2a14) - @benjamingeer -- [chore(standoff): Use Base64-encoded UUIDs in standoff tags. (#1301)](https://github.com/dhlab-basel/Knora/commit/20736f737e84ba540fe022e3929cda645ef3137d) - @benjamingeer -- [feat(api-v2): Allow a resource to be created as a specified user (#1306)](https://github.com/dhlab-basel/Knora/commit/2b2961e6279dcf811cfdfed3c27e3b0923001d98) - @benjamingeer -- [feat(admin): Give the admin ontology an external schema (#1291)](https://github.com/dhlab-basel/Knora/commit/31ab1ca9196c365628108380cbedb69cd3249df5) - @benjamingeer -- [fix(api-v2): Remove INFORMATION SEPARATOR TWO from text in the simple schema. (#1299)](https://github.com/dhlab-basel/Knora/commit/f888cc68649cde6314bf186454f7682e25597d5d) - @benjamingeer -- [test: Compare Knora response with its class definition (#1297)](https://github.com/dhlab-basel/Knora/commit/df8af5ddfe1c173f23446b38adf3fb13b13d83be) - @benjamingeer -- [docs(api-admin): fix description of the change password payload (#1285)](https://github.com/dhlab-basel/Knora/commit/5c0db97e0e26bf8e5b23d393a1bf6ae896e16b15) - @loicjaouen -- [fix(api-v1): Fix double escaping of newline. (#1296)](https://github.com/dhlab-basel/Knora/commit/855a51d838617a3733d6c67d8f657c47c8781032) - @benjamingeer -- [fix (tei beol): fix problems in XSLT (#1260)](https://github.com/dhlab-basel/Knora/commit/a568257c6897ffb75285a36c86f8176bfd7d1958) - @tobiasschweizer -- [refactor(ontology): Make knora-admin a separate ontology (#1263)](https://github.com/dhlab-basel/Knora/commit/11c20080e433bb20e39f90ac036c6387c161ff99) - @benjamingeer -- [a handfull of changes in documentation and error messages (#1278)](https://github.com/dhlab-basel/Knora/commit/9bf02d41fd7429bf10b9a64c8a52ae6137b55b2a) - @loicjaouen -- [docs: fix missing username (#1269)](https://github.com/dhlab-basel/Knora/commit/897a6ec95ddfb6d60abb7941b1f92a63485a2aab) - @loicjaouen -- [feat(api-v2): Get resources in a particular class from a project (#1251)](https://github.com/dhlab-basel/Knora/commit/480ef721548b3552875a614cc408ab7b72527b9d) - @benjamingeer -- [fix(sipi): Improve error checking of Sipi's knora.json response. (#1279)](https://github.com/dhlab-basel/Knora/commit/d3e8bb94bbd5db460c55f508f7d5cfe5d80d1c05) - @benjamingeer -- [feat(api-v2): Return user's permission on resources and values (#1257)](https://github.com/dhlab-basel/Knora/commit/30321b806e24cdafcb91210f26881f5dab46ed91) - @benjamingeer -- [fix(api-v1): Escape rdfs:label in bulk import. (#1276)](https://github.com/dhlab-basel/Knora/commit/4781384a8bc1f0e8698659929d7a0b6693179d7e) - @benjamingeer -- [chore(webapi): Remove persistent map code (#1254)](https://github.com/dhlab-basel/Knora/commit/26496703eff89a52d591f81f9e021731d452df7a) - @benjamingeer -- [docs (api-v2): Update outdated ARK documentation. (#1252)](https://github.com/dhlab-basel/Knora/commit/b3ecebec2bf6fb3c49ea34a4b103bcbcdc7fd51a) - @benjamingeer -- [Update build.properties (#1265)](https://github.com/dhlab-basel/Knora/commit/5401943b7c81e0efb21c2b231c98a7afed60ede6) - @subotic +* [fix(api-v2): Cache base class IRIs correctly when creating/updating class (#1311)](https://github.com/dhlab-basel/Knora/commit/db8b938f605aad966de4f77d269be404f56f2a14) - @benjamingeer +* [chore(standoff): Use Base64-encoded UUIDs in standoff tags. (#1301)](https://github.com/dhlab-basel/Knora/commit/20736f737e84ba540fe022e3929cda645ef3137d) - @benjamingeer +* [feat(api-v2): Allow a resource to be created as a specified user (#1306)](https://github.com/dhlab-basel/Knora/commit/2b2961e6279dcf811cfdfed3c27e3b0923001d98) - @benjamingeer +* [feat(admin): Give the admin ontology an external schema (#1291)](https://github.com/dhlab-basel/Knora/commit/31ab1ca9196c365628108380cbedb69cd3249df5) - @benjamingeer +* [fix(api-v2): Remove INFORMATION SEPARATOR TWO from text in the simple schema. (#1299)](https://github.com/dhlab-basel/Knora/commit/f888cc68649cde6314bf186454f7682e25597d5d) - @benjamingeer +* [test: Compare Knora response with its class definition (#1297)](https://github.com/dhlab-basel/Knora/commit/df8af5ddfe1c173f23446b38adf3fb13b13d83be) - @benjamingeer +* [docs(api-admin): fix description of the change password payload (#1285)](https://github.com/dhlab-basel/Knora/commit/5c0db97e0e26bf8e5b23d393a1bf6ae896e16b15) - @loicjaouen +* [fix(api-v1): Fix double escaping of newline. (#1296)](https://github.com/dhlab-basel/Knora/commit/855a51d838617a3733d6c67d8f657c47c8781032) - @benjamingeer +* [fix (tei beol): fix problems in XSLT (#1260)](https://github.com/dhlab-basel/Knora/commit/a568257c6897ffb75285a36c86f8176bfd7d1958) - @tobiasschweizer +* [refactor(ontology): Make knora-admin a separate ontology (#1263)](https://github.com/dhlab-basel/Knora/commit/11c20080e433bb20e39f90ac036c6387c161ff99) - @benjamingeer +* [a handfull of changes in documentation and error messages (#1278)](https://github.com/dhlab-basel/Knora/commit/9bf02d41fd7429bf10b9a64c8a52ae6137b55b2a) - @loicjaouen +* [docs: fix missing username (#1269)](https://github.com/dhlab-basel/Knora/commit/897a6ec95ddfb6d60abb7941b1f92a63485a2aab) - @loicjaouen +* [feat(api-v2): Get resources in a particular class from a project (#1251)](https://github.com/dhlab-basel/Knora/commit/480ef721548b3552875a614cc408ab7b72527b9d) - @benjamingeer +* [fix(sipi): Improve error checking of Sipi's knora.json response. (#1279)](https://github.com/dhlab-basel/Knora/commit/d3e8bb94bbd5db460c55f508f7d5cfe5d80d1c05) - @benjamingeer +* [feat(api-v2): Return user's permission on resources and values (#1257)](https://github.com/dhlab-basel/Knora/commit/30321b806e24cdafcb91210f26881f5dab46ed91) - @benjamingeer +* [fix(api-v1): Escape rdfs:label in bulk import. (#1276)](https://github.com/dhlab-basel/Knora/commit/4781384a8bc1f0e8698659929d7a0b6693179d7e) - @benjamingeer +* [chore(webapi): Remove persistent map code (#1254)](https://github.com/dhlab-basel/Knora/commit/26496703eff89a52d591f81f9e021731d452df7a) - @benjamingeer +* [docs (api-v2): Update outdated ARK documentation. (#1252)](https://github.com/dhlab-basel/Knora/commit/b3ecebec2bf6fb3c49ea34a4b103bcbcdc7fd51a) - @benjamingeer +* [Update build.properties (#1265)](https://github.com/dhlab-basel/Knora/commit/5401943b7c81e0efb21c2b231c98a7afed60ede6) - @subotic --- ## v6.0.1 (22/03/2019) -- [chore: releasing-v6.0.1 (#1270)](https://github.com/dhlab-basel/Knora/commit/f65a02a82050ebde72cbdbe89faba217646d1ce5) - @subotic -- [chore(webapi): Add script for loading of a minimal set of data (#1267)](https://github.com/dhlab-basel/Knora/commit/7ed1425d84a42a7115af4885a44e4adc467e6eae) - @subotic -- [fix (beolPersonLabel) typo in label of hasBirthPlace (#1248)](https://github.com/dhlab-basel/Knora/commit/a08117737e2d6b159a2a569801938b67d76a95ce) - @SepidehAlassi -- [fix (webapi): message typo (#1244)](https://github.com/dhlab-basel/Knora/commit/9cea41a3a5ad6630f1fbc75e2656533ae6bf6da2) - @subotic -- [Unescape standoff string attributes when verifying text value update (#1242)](https://github.com/dhlab-basel/Knora/commit/af35c9520ccf0dceab0eb3bba83aa7c7aba8491b) - @benjamingeer -- [docs: fix user admin api (#1237)](https://github.com/dhlab-basel/Knora/commit/4fcda61f6dc667f5950b15bb7a6536bd503a9565) - @subotic +* [chore: releasing-v6.0.1 (#1270)](https://github.com/dhlab-basel/Knora/commit/f65a02a82050ebde72cbdbe89faba217646d1ce5) - @subotic +* [chore(webapi): Add script for loading of a minimal set of data (#1267)](https://github.com/dhlab-basel/Knora/commit/7ed1425d84a42a7115af4885a44e4adc467e6eae) - @subotic +* [fix (beolPersonLabel) typo in label of hasBirthPlace (#1248)](https://github.com/dhlab-basel/Knora/commit/a08117737e2d6b159a2a569801938b67d76a95ce) - @SepidehAlassi +* [fix (webapi): message typo (#1244)](https://github.com/dhlab-basel/Knora/commit/9cea41a3a5ad6630f1fbc75e2656533ae6bf6da2) - @subotic +* [Unescape standoff string attributes when verifying text value update (#1242)](https://github.com/dhlab-basel/Knora/commit/af35c9520ccf0dceab0eb3bba83aa7c7aba8491b) - @benjamingeer +* [docs: fix user admin api (#1237)](https://github.com/dhlab-basel/Knora/commit/4fcda61f6dc667f5950b15bb7a6536bd503a9565) - @subotic --- ## v6.0.0 (28/02/2019) + # Release Notes -- MAJOR: Use HTTP POST to mark resources and values as deleted (#1203) +* MAJOR: Use HTTP POST to mark resources and values as deleted (#1203) -- MAJOR: Reorganize user and project routes (#1209) +* MAJOR: Reorganize user and project routes (#1209) -- FEATURE: Secure routes returning user information (#961) +* FEATURE: Secure routes returning user information (#961) -- MAJOR: Change all `xsd:dateTimeStamp` to `xsd:dateTime` in the triplestore (#1211). +* MAJOR: Change all `xsd:dateTimeStamp` to `xsd:dateTime` in the triplestore (#1211). Existing data must be updated; see `upgrade/1211-datetime` for instructions. -- FIX: Ignore order of attributes when comparing standoff (#1224). +* FIX: Ignore order of attributes when comparing standoff (#1224). -- FEATURE: Query version history (#1214) +* FEATURE: Query version history (#1214) -- FIX: Don't allow conflicting cardinalities (#1229) +* FIX: Don't allow conflicting cardinalities (#1229) -- MAJOR: Remove preview file values (#1230). Existing data must be updated; +* MAJOR: Remove preview file values (#1230). Existing data must be updated; see `upgrade/1230-delete-previews` for instructions. --- ## v5.0.0 (05/02/2019) + # Release Notes -- MAJOR: Fix property names for incoming links (#1144)) -- MAJOR: Generate and resolve ARK URLs for resources (#1161). Projects +* MAJOR: Fix property names for incoming links (#1144)) +* MAJOR: Generate and resolve ARK URLs for resources (#1161). Projects that have resource IRIs that do not conform to the format specified in - https://docs.knora.org/paradox/03-apis/api-v2/knora-iris.html#iris-for-data + must update them. -- MAJOR: Use project shortcode in IIIF URLs (#1191). If you have file value IRIs containing the substring `/reps/`, you must replace `/reps/` with `/values/`. +* MAJOR: Use project shortcode in IIIF URLs (#1191). If you have file value IRIs containing the substring `/reps/`, you must replace `/reps/` with `/values/`. -- FEATURE: Update resource metadata in API v2 (#1131) -- FEATURE: Allow setting resource creation date in bulk import #1151) -- FEATURE: The `v2/authentication` route now also initiates cookie creation (the same as `v1/authentication`) (#1159) -- FEATURE: Allow to specify restricted view settings for a project which Sipi will adhere to (#690). +* FEATURE: Update resource metadata in API v2 (#1131) +* FEATURE: Allow setting resource creation date in bulk import #1151) +* FEATURE: The `v2/authentication` route now also initiates cookie creation (the same as `v1/authentication`) (#1159) +* FEATURE: Allow to specify restricted view settings for a project which Sipi will adhere to (#690). -- FIX: Triplestore connection error when using dockerComposeUp (#1122) -- FIX: Reject link value properties in Gravsearch queries in the simple schema (#1145) -- FIX: Fix error-checking when updating cardinalities in ontology API (#1142) -- FIX: Allow hasRepresentation in an ontology used in a bulk import (#1171) -- FIX: Set cookie domain to the value specified in `application.conf` with the setting `cookie-domain` (#1169) -- FIX: Fix processing of shared property in bulk import (#1182) +* FIX: Triplestore connection error when using dockerComposeUp (#1122) +* FIX: Reject link value properties in Gravsearch queries in the simple schema (#1145) +* FIX: Fix error-checking when updating cardinalities in ontology API (#1142) +* FIX: Allow hasRepresentation in an ontology used in a bulk import (#1171) +* FIX: Set cookie domain to the value specified in `application.conf` with the setting `cookie-domain` (#1169) +* FIX: Fix processing of shared property in bulk import (#1182) --- ## v4.0.0 (12/12/2018) + # v4.0.0 Release Notes -- MAJOR CHANGE: mapping creation request and response formats have changed (#1094) -- MINOR CHANGE: Update technical user docs (#1085) -- BUGFIX CHANGE: Fix permission checking in API v2 resource creation (#1104) +* MAJOR CHANGE: mapping creation request and response formats have changed (#1094) +* MINOR CHANGE: Update technical user docs (#1085) +* BUGFIX CHANGE: Fix permission checking in API v2 resource creation (#1104) + --- ## v3.0.0 (30/11/2018) + # v3.0.0 Release Notes -- [BREAKING ONTOLOGY CHANGE] The property `knora-base:username` was added and is required for `knora-base:User`. (#1047) -- [BREAKING API CHANGE] The `/admin/user` API has changed due to adding the `username` property. (#1047) -- [FIX] Incorrect standoff to XML conversion if empty tag has empty child tag (#1054) -- [FEATURE] Add default permission caching (#1062) -- [FIX] Fix unescaping in update check and reading standoff URL (#1074) -- [FIX] Incorrect standoff to XML conversion if empty tag has empty child tag (#1054) -- [FEATURE] Create image file values in API v2 (#1011). Requires Sipi with tagged commit `v1.4.1-SNAPSHOT` or later. +* [BREAKING ONTOLOGY CHANGE] The property `knora-base:username` was added and is required for `knora-base:User`. (#1047) +* [BREAKING API CHANGE] The `/admin/user` API has changed due to adding the `username` property. (#1047) +* [FIX] Incorrect standoff to XML conversion if empty tag has empty child tag (#1054) +* [FEATURE] Add default permission caching (#1062) +* [FIX] Fix unescaping in update check and reading standoff URL (#1074) +* [FIX] Incorrect standoff to XML conversion if empty tag has empty child tag (#1054) +* [FEATURE] Create image file values in API v2 (#1011). Requires Sipi with tagged commit `v1.4.1-SNAPSHOT` or later. + --- ## v2.1.0 (02/11/2018) -### New features: -- Implement graph query in API v2 (#1009) -- Expose additional `webapi` settings as environment variables. Please see the [Configuration](https://docs.knora.org/paradox/04-deployment/configuration.html) section in the documentation for more information (#1025) +### New features + +* Implement graph query in API v2 (#1009) +* Expose additional `webapi` settings as environment variables. Please see the [Configuration](https://docs.knora.org/paradox/04-deployment/configuration.html) section in the documentation for more information (#1025) + +### Bugfixes -### Bugfixes: +* sipi container config / sipi not able to talk to knora (#994) -- sipi container config / sipi not able to talk to knora (#994) --- ## v2.1.0-snapshot (22/10/2018) @@ -701,80 +693,86 @@ --- ## v2.0.0 (13/09/2018) + This is the first release with the new version numbering convention. From now on, if any changes to the existing data are necessary for a release, then this release will have its major number increased. Please see the [Release Versioning Convention](https://github.com/dhlab-basel/Knora#release-versioning-convention) description. -### Required changes to existing data: +### Required changes to existing data + +* a `knora-base:ListNode` must have at least one `rdfs:label`. (@github[#991](#990)) -- a `knora-base:ListNode` must have at least one `rdfs:label`. (@github[#991](#990)) +### New features -### New features: +* add developer-centric docker-compose.yml for starting the Knora / GraphDB / Sipi / Salsah1 (@github[#979](#979)) +* configure `webapi` and `salsah1` thorough environment variables (@github[#979](#979)) +* update for Java 10 (@github[#979](#979)) +* comment out the generation of fat jars from `KnoraBuild.sbt` (for now) (@github[#979](#979)) +* update ehcache (@github[#979](#979)) +* update sbt to 1.2.1 (@github[#979](#979)) +* remove Kamon monitoring (for now) since we don't see anything meaningful there. We probably will have to instrument Knora by hand and then use Kamon for access. (@github[#979](#979)) +* update Dockerfiles for `webapi` and `salsah1` (@github[#979](#979)) +* follow subClassOf when including ontologies in XML import schemas (@github[#991](#991)) +* add support for adding list child nodes (@github[#991](#990)) +* add support for shared ontologies (@github[#987](#987)) -- add developer-centric docker-compose.yml for starting the Knora / GraphDB / Sipi / Salsah1 (@github[#979](#979)) -- configure `webapi` and `salsah1` thorough environment variables (@github[#979](#979)) -- update for Java 10 (@github[#979](#979)) -- comment out the generation of fat jars from `KnoraBuild.sbt` (for now) (@github[#979](#979)) -- update ehcache (@github[#979](#979)) -- update sbt to 1.2.1 (@github[#979](#979)) -- remove Kamon monitoring (for now) since we don't see anything meaningful there. We probably will have to instrument Knora by hand and then use Kamon for access. (@github[#979](#979)) -- update Dockerfiles for `webapi` and `salsah1` (@github[#979](#979)) -- follow subClassOf when including ontologies in XML import schemas (@github[#991](#991)) -- add support for adding list child nodes (@github[#991](#990)) -- add support for shared ontologies (@github[#987](#987)) +### Bugfixes -### Bugfixes: +* trouble with xml-checker and/or consistency-checker during bulk import (@github[#978](#978)) +* ontology API error with link values (@github[#988](#988)) -- trouble with xml-checker and/or consistency-checker during bulk import (@github[#978](#978)) -- ontology API error with link values (@github[#988](#988)) --- ## v1.7.1 (29/08/2018) -Knora-Stack compatible versions: + +Knora-Stack compatible versions --- + Knora v1.7.1 - Salsah v2.1.2 - Sipi v1.4.0 - GraphDB v8.5.0 -- doc (webapi): add yourkit acknowledgment (#983) -- Don't allow class with cardinalities on P and on a subproperty of P (#982) -- doc (webapi): add LHTT project shortcode (#981) -- feature (webapi): not return or allow changing of built-in users (#975) -- fix (webapi): startup check does not detect running triplestore (#969) -- Fix bulk import parsing bug and limit concurrent client connections (#973) +* doc (webapi): add yourkit acknowledgment (#983) +* Don't allow class with cardinalities on P and on a subproperty of P (#982) +* doc (webapi): add LHTT project shortcode (#981) +* feature (webapi): not return or allow changing of built-in users (#975) +* fix (webapi): startup check does not detect running triplestore (#969) +* Fix bulk import parsing bug and limit concurrent client connections (#973) + --- ## v1.7.0 (16/08/2018) + See the closed tickets on the [v1.7.0 milestone](https://github.com/dhlab-basel/Knora/milestone/11). -Knora-Stack compatible versions: +Knora-Stack compatible versions --- Knora v1.7.0 - Salsah v2.1.0 - Sipi v1.4.0 - GraphDB v8.5.0 -Required changes to existing data: +Required changes to existing data ---------------------------------- -- To use the inferred Gravsearch predicate `knora-api:standoffTagHasStartAncestor`, +* To use the inferred Gravsearch predicate `knora-api:standoffTagHasStartAncestor`, you must recreate your repository with the updated `KnoraRules.pie`. -New features: +New features ------------- -- Gravsearch queries can now match standoff markup (#910). -- Add Graphdb-Free initialization scripts for local and docker installation (#955). -- Create temp dirs at startup (#951) -- Update versions of monitoring tools (#951) +* Gravsearch queries can now match standoff markup (#910). +* Add Graphdb-Free initialization scripts for local and docker installation (#955). +* Create temp dirs at startup (#951) +* Update versions of monitoring tools (#951) - -Bugfixes: +Bugfixes --------- -- timeout or java.lang.OutOfMemoryError when using /v1/resources/xmlimportschemas/ for some ontologies (#944) -- Timeout cleanup (#951) -- Add separate dispatchers (#945) +* timeout or java.lang.OutOfMemoryError when using /v1/resources/xmlimportschemas/ for some ontologies (#944) +* Timeout cleanup (#951) +* Add separate dispatchers (#945) --- ## v1.6.0 (29/06/2018) + v1.6.0 Release Notes ==================== @@ -782,98 +780,101 @@ See the [release](https://github.com/dhlab-basel/Knora/releases/tag/v1.6.0) and closed tickets on the [v1.6.0 milestone](https://github.com/dhlab-basel/Knora/milestone/10) on Github. -Required changes to existing data: +Required changes to existing data ---------------------------------- -- A project is now required to have at least one description, so potentially a description will need +* A project is now required to have at least one description, so potentially a description will need to be added to those projects that don't have one. -New features: +New features ------------- General: -- Added a `/health` endpoint -- KnoraService waits on startup for a triplestore before trying to load the ontologies +* Added a `/health` endpoint +* KnoraService waits on startup for a triplestore before trying to load the ontologies Gravsearch enhancements: -- Accept queries in POST requests (@github[#650](#650)). -- Allow a Gravsearch query to specify the IRI of the main resource (@github[#871](#871)) (by allowing `BIND`). -- Allow `lang` to be used with `!=`. -- A `UNION` or `OPTIONAL` can now be nested in an `OPTIONAL` (@github[#882](#882)). -- Gravsearch now does type inference (@github[#884](#884)). -- The Knora API v2 complex schema can now be used in Gravsearch, making it possible to search +* Accept queries in POST requests (@github[#650](#650)). +* Allow a Gravsearch query to specify the IRI of the main resource (@github[#871](#871)) (by allowing `BIND`). +* Allow `lang` to be used with `!=`. +* A `UNION` or `OPTIONAL` can now be nested in an `OPTIONAL` (@github[#882](#882)). +* Gravsearch now does type inference (@github[#884](#884)). +* The Knora API v2 complex schema can now be used in Gravsearch, making it possible to search for list nodes (@github[#899](#899)). Admin API: -- Make project description required (@github[#875](#875)). +* Make project description required (@github[#875](#875)). Conversion to TEI: -- Conversion of standard standoff entities to TEI -- Custom conversion of project specific standoff entities and metadata to TEI +* Conversion of standard standoff entities to TEI +* Custom conversion of project specific standoff entities and metadata to TEI Sipi integration: -- The Knora specific Sipi configuration and scripts can now be found under the `sipi/` directory (@github[#404](#404)). -- Documentation on how Sipi can be started changed (@github[#404](#404)). +* The Knora specific Sipi configuration and scripts can now be found under the `sipi/` directory (@github[#404](#404)). +* Documentation on how Sipi can be started changed (@github[#404](#404)). -Bugfixes: +Bugfixes --------- -- Allow a class or property definition to have more than one object for `rdf:type` (@github[#885](#885)). -- Exclude list values from v2 fulltext search (@github[#906](#906)). +* Allow a class or property definition to have more than one object for `rdf:type` (@github[#885](#885)). +* Exclude list values from v2 fulltext search (@github[#906](#906)). Gravsearch fixes: -- Allow the `lang` function to be used in a comparison inside AND/OR (@github[#846](#846)). -- Fix the processing of resources with multiple incoming links that use the same property (@github[#878](#878)). -- Fix the parsing of a FILTER inside an OPTIONAL (@github[#879](#879)). -- Require the `match` function to be the top-level expression in a `FILTER`. +* Allow the `lang` function to be used in a comparison inside AND/OR (@github[#846](#846)). +* Fix the processing of resources with multiple incoming links that use the same property (@github[#878](#878)). +* Fix the parsing of a FILTER inside an OPTIONAL (@github[#879](#879)). +* Require the `match` function to be the top-level expression in a `FILTER`. --- ## v1.5.0 (31/05/2018) + See [v1.5.0 milestone](https://github.com/dhlab-basel/Knora/milestone/9) for a full list of closed tickets. -New features: +New features ------------- -- Resources can be returned in the simple ontology schema (#833). -- Text values can specify the language of the text (#819). -- Responses can be returned in Turtle and RDF/XML (#851). +* Resources can be returned in the simple ontology schema (#833). +* Text values can specify the language of the text (#819). +* Responses can be returned in Turtle and RDF/XML (#851). -Bugfixes: +Bugfixes --------- -- Incorrect representation of IRI object values in JSON-LD (#835) -- GenerateContributorsFile broken (#797) +* Incorrect representation of IRI object values in JSON-LD (#835) +* GenerateContributorsFile broken (#797) + --- ## v1.4.0 (30/04/2018) -Required changes to existing data: + +Required changes to existing data ---------------------------------- -- Every ontology must now have the property `knora-base:attachedToProject`, which points to the IRI of the project that is responsible for the ontology. This must be added to each project-specific ontology in existing repositories. All built-in ontologies have been updated to have this property, and must, therefore, be reloaded into existing repositories. +* Every ontology must now have the property `knora-base:attachedToProject`, which points to the IRI of the project that is responsible for the ontology. This must be added to each project-specific ontology in existing repositories. All built-in ontologies have been updated to have this property, and must, therefore, be reloaded into existing repositories. The property `knora-base:projectOntology` has been removed, and must be removed from project definitions in existing repositories. -- Every project now needs to have the property `knora-base:projectShortcode` set. +* Every project now needs to have the property `knora-base:projectShortcode` set. -New features: +New features ------------- -- Added OpenAPI / Swagger API documentation route -- The Knora API server now checks the validity of ontologies on startup. -- The property ``knora-base:projectShortcode`` is now a required property (was optional). +* Added OpenAPI / Swagger API documentation route +* The Knora API server now checks the validity of ontologies on startup. +* The property ``knora-base:projectShortcode`` is now a required property (was optional). -Bugfixes: +Bugfixes --------- -- API v1 extended search was not properly handling multiple conditions +* API v1 extended search was not properly handling multiple conditions on list values (issue \#800) -- Fix image orientation in SALSAH 1 (issue \#726) +* Fix image orientation in SALSAH 1 (issue \#726) --- @@ -882,21 +883,22 @@ Bugfixes: --- ## v1.3.0 (28/03/2018) -### Required changes to existing data: + +### Required changes to existing data #### 1. Replace salsah-gui ontology You must replace the ``salsah-gui`` ontology that you have in the triplestore with the one in ``salsah-gui.ttl``. -### New features: +### New features -- More support for salsah-gui elements and attributes in ontologies - - Serve the ``salsah-gui`` ontology in API v2 in the default schema. - - Show ``salsah-gui:guiElement`` and ``salsah-gui:guiAttribute`` when serving ontologies in API v2 in the default schema. - - Allow ``salsah-gui:guiElement`` and ``salsah-gui:guiAttribute`` to be included in new property definitions created via API v2. - - Change ``salsah-gui`` so that GraphDB's consistency checker can check the use of ``guiElement`` and ``guiAttribute``. -- Changes to ``application.conf``. The ``sipi`` and ``web-api`` sections have received a big update, adding separate settings for internal and external host settings: +* More support for salsah-gui elements and attributes in ontologies + * Serve the ``salsah-gui`` ontology in API v2 in the default schema. + * Show ``salsah-gui:guiElement`` and ``salsah-gui:guiAttribute`` when serving ontologies in API v2 in the default schema. + * Allow ``salsah-gui:guiElement`` and ``salsah-gui:guiAttribute`` to be included in new property definitions created via API v2. + * Change ``salsah-gui`` so that GraphDB's consistency checker can check the use of ``guiElement`` and ``guiAttribute``. +* Changes to ``application.conf``. The ``sipi`` and ``web-api`` sections have received a big update, adding separate settings for internal and external host settings: ``` @@ -939,7 +941,7 @@ in ``salsah-gui.ttl``. } ``` -### Bugfixes: +### Bugfixes -- When API v2 served ``knora-api`` (default schema), ``salsah-gui:guiElement`` and ``salsah-gui:guiAttribute`` were not shown in properties in that ontology. -- The predicate ``salsah-gui:guiOrder`` was not accepted when creating a property via API v2. +* When API v2 served ``knora-api`` (default schema), ``salsah-gui:guiElement`` and ``salsah-gui:guiAttribute`` were not shown in properties in that ontology. +* The predicate ``salsah-gui:guiOrder`` was not accepted when creating a property via API v2. diff --git a/docs/00-release-notes/index.md b/docs/00-release-notes/index.md index 812991e58c..c214565a75 100644 --- a/docs/00-release-notes/index.md +++ b/docs/00-release-notes/index.md @@ -1,3 +1,3 @@ -# Release Notes - -These are the release notes for each version of Knora. +{% + include-markdown "../../CHANGELOG.md" +%} diff --git a/docs/00-release-notes/migration.md b/docs/00-release-notes/migration.md deleted file mode 100644 index baf5c5e33a..0000000000 --- a/docs/00-release-notes/migration.md +++ /dev/null @@ -1,12 +0,0 @@ -# Migration Notes - -## v2.1.0 -> v3.0.0 - -### Data - -- The property `knora-base:username` was added to `knora-base:User`. Each instance of `knora-base:User` needs to be -updated by adding this property and giving it a unique value. - -### API -- The `POST /admin/user` API has changed due to adding the `username` property. The `username` property needs to be supplied -for user creation requests. \ No newline at end of file diff --git a/docs/00-release-notes/next.md b/docs/00-release-notes/next.md deleted file mode 100644 index 9bc0b65d9a..0000000000 --- a/docs/00-release-notes/next.md +++ /dev/null @@ -1,30 +0,0 @@ -# Release Notes for Next Release - -Write any new release notes between releases into this file. They will be moved to the correct place, -at the time of the release, because only then we will know the next release number. - -Also, please change the **HINT** to the appropriate level: - -- MAJOR: the changes introduced warrant a major number increase - -- FEATURE: the changes introduced warrant a minor number increase - -- FIX: the changes introduced warrant a bug fix number increase - - -## HINT => MAJOR CHANGE - -- FIX: Unescape standoff string attributes when verifying text value update (@github[#1242](#1242)) - -- FEATURE: Remove persistent map code (@github[#1254](#1254)) - -- FEATURE: Return user's permission on resources and values (@github[#1257](#1257)) - -- FEATURE: Get resources in a particular class from a project (@github[#1251](#1251)) - -- MAJOR: Separate the `knora-admin` ontology from `knora-api` (@github[#1263](#1263)). - Existing repositories must be updated; see `upgrade/1263-knora-admin` for instructions. - -- FEATURE: Add support for searching for specific list values in Gravsearch for both the simple and complex schema (@github[#1314](#1314)). - -- REFACTOR: List value responses contain the list node's label in the simple schema only (@github[#1321](#1321)) diff --git a/docs/00-release-notes/v1.1.0.md b/docs/00-release-notes/v1.1.0.md deleted file mode 100644 index 5c51289569..0000000000 --- a/docs/00-release-notes/v1.1.0.md +++ /dev/null @@ -1,37 +0,0 @@ -v1.1.0 Release Notes -==================== - -See the -[release](https://github.com/dhlab-basel/Knora/releases/tag/v1.1.0) on -Github. - -Required changes to existing data: ----------------------------------- - -### 1. Project ontologies property changed: - -The `knora-base:projectOntologyGraph` needs to be renamed to -`knora-base:projectOntology`. Also before it was a `xsd:string`, where -now it needs to be an IRI. The graph where the ontology is stored will -need to have the same name. - -### 2. Project data graph property removed: - -The property `knora-base:projectDataGraph` needs to be removed. - -### 2. Project shortcode property added: - -The `knora-base:projectShortcode` property was added. When adding a -project shortcode, we also need to update: - -1. the IRI of the project to: `http://rdfh.ch/projects/[shortcode]` -2. the IRIs all project ontologies to: - `http://www.knora.org/ontology/[shortcode]/[ontoname]` -3. the IRIs of lists to: `http://rdfh.ch/lists/[shortcode]/[UUID]` -4. the IRIs of groups to: `http://rdfh.ch/groups/[shortcode]/[UUID]` - -New features: -------------- - -Bugfixes: ---------- diff --git a/docs/00-release-notes/v1.2.0.md b/docs/00-release-notes/v1.2.0.md deleted file mode 100644 index 719a9a40fd..0000000000 --- a/docs/00-release-notes/v1.2.0.md +++ /dev/null @@ -1,129 +0,0 @@ -v1.2.0 Release Notes -==================== - -See the -[release](https://github.com/dhlab-basel/Knora/releases/tag/v1.2.0) and -closed tickets on the [v1.2.0 -milestone](https://github.com/dhlab-basel/Knora/milestone/6) on Github. - -Required changes to existing data: ----------------------------------- - -### 1. Project keywords (admin data) - -Project keywords need to be transformed into sequences and property -changed to projectKeyword (singular). - -before: - - - knora-base:projectKeywords "images, collection"^^xsd:string . - -after: - - - knora-base:projectKeyword "images"^^xsd:string, "collection"^^xsd:string ; - -### 2. Project descriptions (admin data) - -Project descriptions need to be transformed into sequences with language -tag. - -before: - - - knora-base:projectDescription "A demo project of a collection of images"^^xsd:string . - -after: - - - knora-base:projectDescription "A demo project of a collection of images"@en . - -### 3. salsah-gui:guiOrder - -The predicate `salsah-gui:guiOrder` is now attached to cardinalities in -class definitions, instead of attaching it to property definitions. This -allows the same property to be first in one class and last in another -class. - -Before: - - :title rdf:type owl:ObjectProperty ; - salsah-gui:guiOrder "1"^^xsd:integer . - -After: - - :book rdf:type owl:Class ; - rdfs:subClassOf knora-base:Resource , - [ - rdf:type owl:Restriction ; - owl:onProperty :title ; - owl:minCardinality "1"^^xsd:nonNegativeInteger ; - salsah-gui:guiOrder "1"^^xsd:nonNegativeInteger - ] - -Existing project-specific ontologies must be updated. You can use the -command-line tool `org/knora/webapi/util/TransformOntology.scala` to do -this automatically. First dump your ontology to a Turtle file. Then at -the `sbt` console, type: - - runMain org.knora.webapi.util.TransformOntology -t guiorder INPUT OUTPUT - -For INPUT, use the absolute path of the Turtle file representing your -existing ontology. For OUTPUT, use the absolute path of the output file -to be created. - -Note that, because of a limitation of the current version of the RDF4J -Turtle generation library, the generated Turtle represents cardinalities -as labelled blank nodes, rather than as anonymous blank nodes, which -would be more readable (see [this pull -request](https://github.com/eclipse/rdf4j/pull/890)). - -Then replace the contents of your ontology's named graph in the -triplestore with the contents of the transformed Turtle file, and -restart Knora. Be sure to test this on a test -installation using a copy of your data and ontologies, before updating -the ontology used by a live server. - -Also, you have to replace the `salsah-gui` ontology that you have in the -triplestore with the one in `salsah-gui.ttl`. - -New features: -------------- - -- - - General - - : - Change: Return differently formatted JSON responses for - exception messages, depending on which route (`v1`, `v2`\` - or `admin`) was accessed. - -- - - Admin API - - : - Change: Project shortcode is required for the creation of - new projects - - Change: Project keywords are now a sequence. Needs change to - existing data. Please see example above. - - Change: Project description has language tag and is returned - as array. Needs change to existing data. Please see - example above. - - Change: Remove institution from project (will be added later - with the FAIR metadata) - - Change: Sorting of collections with admin objects (user, - group, project) - - New: Keywords endpoint at `/admin/projects/keywords` returns - all unique keywords (as strings) for all projects in an - array - - New: Keywords endpoint at - `/admin/projects/keywords/[projectIri]` returns all keywords - of a single project. - - New: Lists endpoint at `/admin/lists/` allows new lists to - be created. - - New: Lists endpoint at `/admin/lists/infos/` allows - to change basic list information. - -Bugfixes: ---------- diff --git a/docs/00-release-notes/v1.3.0.md b/docs/00-release-notes/v1.3.0.md deleted file mode 100644 index b3f3da7709..0000000000 --- a/docs/00-release-notes/v1.3.0.md +++ /dev/null @@ -1,80 +0,0 @@ -v1.3.0 Release Notes -==================== - -See the -[release](https://github.com/dhlab-basel/Knora/releases/tag/v1.3.0) and -closed tickets on the [v1.3.0 -milestone](https://github.com/dhlab-basel/Knora/milestone/7) on Github. - -Required changes to existing data: ----------------------------------- - -### 1. Replace salsah-gui ontology - -You must replace the `salsah-gui` ontology that you have in the -triplestore with the one in `salsah-gui.ttl`. - -New features: -------------- - -- More support for salsah-gui elements and attributes in ontologies - - Serve the `salsah-gui` ontology in API v2 in the complex schema. - - Show `salsah-gui:guiElement` and `salsah-gui:guiAttribute` when - serving ontologies in API v2 in the complex schema. - - Allow `salsah-gui:guiElement` and `salsah-gui:guiAttribute` to - be included in new property definitions created via API v2. - - Change `salsah-gui` so that GraphDB's consistency checker can - check the use of `guiElement` and `guiAttribute`. -- Changes to `application.conf`. The `sipi` and `web-api` sections - have received a big update, adding separate settings for internal - and external host settings: - - - - app { - knora-api { - // relevant for direct communication inside the knora stack - internal-host = "0.0.0.0" - internal-port = 3333 - - // relevant for the client, i.e. browser - external-protocol = "http" // optional ssl termination needs to be done by the proxy - external-host = "0.0.0.0" - external-port = 3333 - } - - sipi { - // relevant for direct communication inside the knora stack - internal-protocol = "http" - internal-host = "localhost" - internal-port = 1024 - - // relevant for the client, i.e. browser - external-protocol = "http" - external-host = "localhost" - external-port = 1024 - - prefix = "knora" - file-server-path = "server" - path-conversion-route = "convert_from_binaries" - file-conversion-route = "convert_from_file" - image-mime-types = ["image/tiff", "image/jpeg", "image/png", "image/jp2"] - movie-mime-types = [] - sound-mime-types = [] - } - - salsah1 { - base-url = "http://localhost:3335/" - project-icons-basepath = "project-icons/" - } - } - -Bugfixes: ---------- - -- When API v2 served `knora-api` (complex schema), - `salsah-gui:guiElement` and `salsah-gui:guiAttribute` were not shown - in properties in that ontology. -- The predicate `salsah-gui:guiOrder` was not accepted when creating a - property via API v2. - diff --git a/docs/00-release-notes/v1.4.0.md b/docs/00-release-notes/v1.4.0.md deleted file mode 100644 index bda436b81a..0000000000 --- a/docs/00-release-notes/v1.4.0.md +++ /dev/null @@ -1,33 +0,0 @@ -v1.4.0 Release Notes -==================== - -See the -[release](https://github.com/dhlab-basel/Knora/releases/tag/v1.4.0) and closed tickets on the -[v1.4.0 milestone](https://github.com/dhlab-basel/Knora/milestone/8) on Github. - -Required changes to existing data: ----------------------------------- - -- Every ontology must now have the property `knora-base:attachedToProject`, which points to the IRI of the project - that is responsible for the ontology. This must be added to each project-specific ontology in existing repositories. - All built-in ontologies have been updated to have this property, and must therefore be reloaded into existing - repositories. - The property `knora-base:projectOntology` has been removed, and must be removed from project definitions in - existing repositories. - -- Every project now needs to have the property `knora-base:projectShortcode` set. - -New features: -------------- - -- Added OpenAPI / Swagger API documentation route -- Knora now checks the validity of ontologies on startup. -- The property ``knora-base:projectShortcode`` is now a required property (was optional). - -Bugfixes: ---------- - -- API v1 extended search was not properly handling multiple conditions - on list values (issue \#800) -- Fix image orientation in SALSAH 1 (issue \#726) - diff --git a/docs/00-release-notes/v1.5.0.md b/docs/00-release-notes/v1.5.0.md deleted file mode 100644 index 4b20eac9fb..0000000000 --- a/docs/00-release-notes/v1.5.0.md +++ /dev/null @@ -1,22 +0,0 @@ -v1.5.0 Release Notes -==================== - -See the -[release](https://github.com/dhlab-basel/Knora/releases/tag/v1.5.0) and closed tickets on the -[v1.5.0 milestone](https://github.com/dhlab-basel/Knora/milestone/9) on Github. - -Required changes to existing data: ----------------------------------- - -New features: -------------- - -- Resources can be returned in the simple ontology schema (#833). -- Text values can specify the language of the text (#819). -- Responses can be returned in Turtle and RDF/XML (#851). - -Bugfixes: ---------- - -- Incorrect representation of IRI object values in JSON-LD (#835) -- GenerateContributorsFile broken (#797) diff --git a/docs/00-release-notes/v1.6.0.md b/docs/00-release-notes/v1.6.0.md deleted file mode 100644 index 9721be97d3..0000000000 --- a/docs/00-release-notes/v1.6.0.md +++ /dev/null @@ -1,57 +0,0 @@ -v1.6.0 Release Notes -==================== - -See the -[release](https://github.com/dhlab-basel/Knora/releases/tag/v1.6.0) and closed tickets on the -[v1.6.0 milestone](https://github.com/dhlab-basel/Knora/milestone/10) on Github. - -Required changes to existing data: ----------------------------------- - -- A project is now required to have at least one description, so potentially a description will need - to be added to those projects that don't have one. - -New features: -------------- - -General: - -- Added a `/health` endpoint -- KnoraService waits on startup for a triplestore before trying to load the ontologies - -Gravsearch enhancements: - -- Accept queries in POST requests (@github[#650](#650)). -- Allow a Gravsearch query to specify the IRI of the main resource (@github[#871](#871)) (by allowing `BIND`). -- Allow `lang` to be used with `!=`. -- A `UNION` or `OPTIONAL` can now be nested in an `OPTIONAL` (@github[#882](#882)). -- Gravsearch now does type inference (@github[#884](#884)). -- The Knora API v2 complex schema can now be used in Gravsearch, making it possible to search - for list nodes (@github[#899](#899)). - -Admin API: - -- Make project description required (@github[#875](#875)). - -Conversion to TEI: - -- Conversion of standard standoff entities to TEI -- Custom conversion of project specific standoff entities and metadata to TEI - -Sipi integration: - -- The Knora specific Sipi configuration and scripts can now be found under the `sipi/` directory (@github[#404](#404)). -- Documentation on how Sipi can be started changed (@github[#404](#404)). - -Bugfixes: ---------- - -- Allow a class or property definition to have more than one object for `rdf:type` (@github[#885](#885)). -- Exclude list values from v2 fulltext search (@github[#906](#906)). - -Gravsearch fixes: - -- Allow the `lang` function to be used in a comparison inside AND/OR (@github[#846](#846)). -- Fix the processing of resources with multiple incoming links that use the same property (@github[#878](#878)). -- Fix the parsing of a FILTER inside an OPTIONAL (@github[#879](#879)). -- Require the `match` function to be the top-level expression in a `FILTER`. diff --git a/docs/00-release-notes/v1.7.0.md b/docs/00-release-notes/v1.7.0.md deleted file mode 100644 index de20c510f3..0000000000 --- a/docs/00-release-notes/v1.7.0.md +++ /dev/null @@ -1,45 +0,0 @@ -# v1.7.x Release Notes - -See the -[release](https://github.com/dhlab-basel/Knora/releases/tag/v1.7.0) and closed tickets on the -[v1.7.0 milestone](https://github.com/dhlab-basel/Knora/milestone/11) on Github. - -## v1.7.0 - - - -- To use the inferred Gravsearch predicate `knora-api:standoffTagHasStartAncestor`, - you must recreate your repository with the updated `KnoraRules.pie`. - -### New features: - -- Gravsearch queries can now match standoff markup (@github[#910](#910)). -- Add Graphdb-Free initialization scripts for local and docker installation (@github[#955](#955)). -- Create temp dirs at startup (@github[#951](#951)) -- Update versions of monitoring tools (@github[#951](#951)) - - -### Bugfixes: - -- timeout or java.lang.OutOfMemoryError when using /v1/resources/xmlimportschemas/ for some ontologies (@github[#944](#944)) -- Timeout cleanup (@github[#951](#951)) -- Add separate dispatchers (@github[#945](#945)) -- "Property not found"-problem when using seqnum during bulk-import (@github[#971](#971)) -- Exceeded configured max-open-requests value (@github[#972](#972)) - -## v1.7.1 - -### Required changes to existing data: - -- In `application.conf`: - - app.triplestore.dbtype = "graphdb-se" - - app.triplestore.use-https = false -- The Knora's Sipi scripts are now stored in the `knora/sipi` folder and need to be provided to the Sipi server at - runtime. - - -### Bugfixes: - -- "Property not found"-problem when using seqnum during bulk-import (@github[#971](#971)) -- Exceeded configured max-open-requests value (@github[#972](#972)) -- Startup check does not detect running triplestore in production environment with SSL enabled (@github[#968](#968)) \ No newline at end of file diff --git a/docs/00-release-notes/v2.x.x.md b/docs/00-release-notes/v2.x.x.md deleted file mode 100644 index c7a6ee05c1..0000000000 --- a/docs/00-release-notes/v2.x.x.md +++ /dev/null @@ -1,44 +0,0 @@ -# v2.x.x Release Notes - - -## v2.0.0 - -This is the first release with the new version numbering convention. From now on, if any changes -to the existing data is necessary for a release, then this release will have its major number increased. -Please see the [Release Versioning Convention](https://github.com/dhlab-basel/Knora#release-versioning-convention) -description. - -### Required changes to existing data: - -- a `knora-base:ListNode` must have at least one `rdfs:label`. ([#991](https://github.com/dasch-swiss/knora-api/issues/990)) - -### New features: - -- add developer-centric docker-compose.yml for starting the Knora / GraphDB / Sipi / Salsah1 ([#979](https://github.com/dasch-swiss/knora-api/issues/979)) -- configure `webapi` and `salsah1` thorough environment variables ([#979](https://github.com/dasch-swiss/knora-api/issues/979)) -- update for Java 10 ([#979](https://github.com/dasch-swiss/knora-api/issues/979)) -- comment out the generation of fat jars from `KnoraBuild.sbt` (for now) ([#979](https://github.com/dasch-swiss/knora-api/issues/979)) -- update ehcache ([#979](https://github.com/dasch-swiss/knora-api/issues/979)) -- update sbt to 1.2.1 ([#979](https://github.com/dasch-swiss/knora-api/issues/979)) -- remove Kamon monitoring (for now) since we don't see anything meaningful there. We probably will have to instrument Knora by hand and then use Kamon for access. ([#979](https://github.com/dasch-swiss/knora-api/issues/979)) -- update Dockerfiles for `webapi` and `salsah1` ([#979](https://github.com/dasch-swiss/knora-api/issues/979)) -- follow subClassOf when including ontologies in XML import schemas ([#991](https://github.com/dasch-swiss/knora-api/issues/991)) -- add support for adding list child nodes ([#991](https://github.com/dasch-swiss/knora-api/issues/990)) -- add support for shared ontologies ([#987](https://github.com/dasch-swiss/knora-api/issues/987)) - -### Bugfixes: - -- trouble with xml-checker and/or consistency-checker during bulk import ([#978](https://github.com/dasch-swiss/knora-api/issues/978)) -- ontology API error with link values ([#988](https://github.com/dasch-swiss/knora-api/issues/988)) - -## v2.1.0 - -### New features: - -- Implement graph query in API v2 ([#1009](#1009)) -- Expose additional `webapi` settings as environment variables. Please see the [Configuration](../04-publishing-deployment/configuration.md) -section in the documentation for more information ([#1025](https://github.com/dasch-swiss/knora-api/issues/1025)) - -### Bugfixes: - -- sipi container config / sipi not able to talk to knora ([#988](https://github.com/dasch-swiss/knora-api/issues/994)) diff --git a/docs/00-release-notes/v3.x.x.md b/docs/00-release-notes/v3.x.x.md deleted file mode 100644 index 7bf50162ef..0000000000 --- a/docs/00-release-notes/v3.x.x.md +++ /dev/null @@ -1,12 +0,0 @@ -# v3.x.x Release Notes - - -## v3.0.0 - -- [BREAKING ONTOLOGY CHANGE] The property `knora-base:username` was added and is required for `knora-base:User`. (@github[#1047](#1047)) -- [BREAKING API CHANGE] The `/admin/user` API has changed due to adding the `username` property. (@github[#1047](#1047)) -- [FIX] Incorrect standoff to XML conversion if empty tag has empty child tag (@github[#1054](#1054)) -- [FEATURE] Add default permission caching (@github[#1062](#1062)) -- [FIX] Fix unescaping in update check and reading standoff URL (@github[#1074](#1074)) -- [FIX] Incorrect standoff to XML conversion if empty tag has empty child tag (@github[#1054](#1054)) -- [FEATURE] Create image file values in API v2 (@github[#1011](#1011)). Requires Sipi with tagged commit `v1.4.1-SNAPSHOT` or later. diff --git a/docs/00-release-notes/v4.x.x.md b/docs/00-release-notes/v4.x.x.md deleted file mode 100644 index c4e29c9e02..0000000000 --- a/docs/00-release-notes/v4.x.x.md +++ /dev/null @@ -1,8 +0,0 @@ -# v4.x.x Release Notes - - -## v4.0.0 - -- MAJOR CHANGE: mapping creation request and response formats have changed (@github[#1094](#1094)). -- MINOR CHANGE: Update technical user docs (@github[#1085](#1085)) -- BUGFIX CHANGE: Fix permission checking in API v2 resource creation (@github[#1104](#1104)) diff --git a/docs/00-release-notes/v5.x.x.md b/docs/00-release-notes/v5.x.x.md deleted file mode 100644 index a73ef0c86d..0000000000 --- a/docs/00-release-notes/v5.x.x.md +++ /dev/null @@ -1,24 +0,0 @@ -# v5.x.x Release Notes - - -## v5.0.0 - -- MAJOR: Fix property names for incoming links (@github[#1144](#1144)) -- MAJOR: Generate and resolve ARK URLs for resources (@github[#1161](#1161)). Projects - that have resource IRIs that do not conform to the format specified in - https://docs.knora.org/03-apis/api-v2/knora-iris/#iris-for-data - must update them. -- MAJOR: Use project shortcode in IIIF URLs (@github[#1191](#1191)). If you have file value IRIs containing the substring `/reps/`, you must replace `/reps/` with `/values/`. - -- FEATURE: Update resource metadata in API v2 (@github[#1131](#1131)) -- FEATURE: Allow setting resource creation date in bulk import (@github[#1151](#1151)) -- FEATURE: The `v2/authentication` route now also initiates cookie creation (the same as `v1/authentication`) (@github[#1159](#1159)) -- FEATURE: Allow to specify restricted view settings for a project which Sipi will adhere to (@github[#690](#690)). - -- FIX: Triplestore connection error when using dockerComposeUp (@github[#1122](#1122)) -- FIX: Reject link value properties in Gravsearch queries in the simple schema (@github[#1145](#1145)) -- FIX: Fix error-checking when updating cardinalities in ontology API (@github[#1142](#1142)) -- FIX: Allow hasRepresentation in an ontology used in a bulk import (@github[#1171](#1171)) -- FIX: Set cookie domain to the value specified in `application.conf` with the setting `cookie-domain` (@github[#1169](#1169)) -- FIX: Fix processing of shared property in bulk import (@github[#1182](#1182)) - diff --git a/docs/00-release-notes/v6.x.x.md b/docs/00-release-notes/v6.x.x.md deleted file mode 100644 index ecdbc8e2d1..0000000000 --- a/docs/00-release-notes/v6.x.x.md +++ /dev/null @@ -1,27 +0,0 @@ -# v6.x.x Release Notes - - -## v6.0.0 - -- MAJOR: Use HTTP POST to mark resources and values as deleted (@github[#1203](#1203)) - -- MAJOR: Reorganize user and project routes (@github[#1209](#1209)) - -- FEATURE: Secure routes returning user informations (@github[#961](#961)) - -- MAJOR: Change all `xsd:dateTimeStamp` to `xsd:dateTime` in the triplestore (@github[#1211](#1211)). - Existing data must be updated; see `upgrade/1211-datetime` for instructions. - -- FIX: Ignore order of attributes when comparing standoff (@github[#1224](#1224)). - -- FEATURE: Query version history (@github[#1214](#1214)) - -- FIX: Don't allow conflicting cardinalities (@github[#1229](#1229)) - -- MAJOR: Remove preview file values (@github[#1230](#1230)). Existing data must be updated; - see `upgrade/1230-delete-previews` for instructions. - - -## v6.0.1 - -- FIX: Unescape standoff string attributes when verifying text value update (@github[#1242](#1242)) diff --git a/docs/01-introduction/data-formats.md b/docs/01-introduction/data-formats.md index 3a83c4cb99..d42cec4cae 100644 --- a/docs/01-introduction/data-formats.md +++ b/docs/01-introduction/data-formats.md @@ -1,32 +1,32 @@ -# Data Formats in Knora +# Data Formats in DSP-API -As explained in [What Is Knora?](what-is-knora.md), Knora stores data +As explained in [What Is DSP and DSP-API (previous Knora)?](what-is-knora.md), the DSP stores data in a small number of formats that are suitable for long-term preservation while facilitating data reuse. The following is a non-exhaustive list of data formats and how their content -can be stored and managed by Knora: +can be stored and managed by DSP-API: -| Original Format | Format in Knora | +| Original Format | Format in DSP | |----------------------------------------------|------------------------------------------------------------------------------------------------------------------------------| | Text (XML, LaTeX, Microsoft Word, etc.) | [Knora resources](../03-apis/api-v2/editing-resources.md) (RDF) containing [Standoff/RDF](standoff-rdf.md) | | Tabular data, including relational databases | [Knora resources](../03-apis/api-v2/editing-resources.md) | diff --git a/docs/01-introduction/example-project.md b/docs/01-introduction/example-project.md index 8c3215dab6..af84c54d7b 100644 --- a/docs/01-introduction/example-project.md +++ b/docs/01-introduction/example-project.md @@ -1,30 +1,30 @@ # An Example Project This section introduces some of the basic concepts involved in creating -ontologies for Knora projects, by means of a relatively simple example +ontologies for DSP projects, by means of a relatively simple example project. Before reading this document, it will be helpful to have some familiarity with the basic concepts explained in knora-base. -Knora comes with two example projects, called `incunabula` and +DSP-API comes with two example projects, called `incunabula` and `images-demo`. Here we will consider the `incunabula` example, which is a reduced version of a real research project on early printed books. It is designed to store an image of each page of each book, as well as RDF @@ -35,12 +35,12 @@ the images. The `incunabula` ontology is in the file `incunabula-onto.ttl`, and its data is in the file `incunabula-demo-data.ttl`. Both these files are in a standard RDF file format called -[Turtle](https://www.w3.org/TR/turtle/). The Knora distribution includes +[Turtle](https://www.w3.org/TR/turtle/). The DSP-API distribution includes sample scripts (in the `webapi/scripts` directory) for importing these files directly into different triplestores. If you are starting a new project from scratch, you can adapt these scripts to import your ontology (and any existing RDF data) into your triplestore for use with -Knora. +DSP-API. The syntax of Turtle is fairly simple: it is basically a sequence of triples. We will consider some details of Turtle syntax as we go along. @@ -69,16 +69,16 @@ knora-base.) The `foaf` ontology contains classes and properties for representing people. The `dcterms` ontology represents [Dublin Core](http://dublincore.org/) metadata. -Then we define prefixes for Knora ontologies: +Then we define prefixes for DSP ontologies: ``` @prefix knora-base: . @prefix salsah-gui: . ``` -The `knora-base` ontology contains Knora's core abstractions, and is +The `knora-base` ontology contains DSP-API's core abstractions, and is described in knora-base. The `salsah-gui` ontology includes properties -that Knora projects must use to enable SALSAH, Knora's generic virtual +that DSP projects must use to enable SALSAH, DSP-API's generic virtual research environment. For convenience, we can use the empty prefix to refer to the @@ -93,11 +93,11 @@ an `incunabula` prefix to refer to the `incunabula` ontology. ### Properties -All the content produced by a Knora project must be stored in Knora -resources (see incunabula-resource-classes). Resources have properties +All the content produced by a DSP project must be stored in Knora +resources (see [incunabula-resource-classes](#resource-classes)). Resources have properties that point to different parts of their contents; for example, the `incunabula` project contains books, which have properties like `title`. -Every property that poitns to a Knora value must be a subproperty of +Every property that poitns to a DSP value must be a subproperty of `knora-base:hasValue`, and every property that points to another Knora resource must be a subproperty of `knora-base:hasLinkTo`. @@ -139,7 +139,7 @@ predicate. The definition of `:title` says: objects of this property will be Knora values, it must be a subproperty of `knora-base:hasValue`. To facilitate searches, we have also chosen to make it a subproperty of `dcterms:title`. In the - Knora API v2, if you do a search for resources that have a certain + DSP-API v2, if you do a search for resources that have a certain `dcterms:title`, and there is a resource with a matching `incunabula:title`, the search results could include that resource. * `rdfs:label "Titel"@de`, etc.: It has the specified labels in @@ -215,7 +215,7 @@ owner, the permissions it grants, and whether it has been deleted. Storing this metadata allows Knora to authorise users to see or modify the link, as well as to query a previous state of a repository in which a deleted link had not yet been deleted. (The ability to query previous -states of a repository is planned for Knora API version 2.) +states of a repository is planned for DSP-API version 2.) The name of a link property and its link value property must be related by the following naming convention: to determine the name of the link @@ -332,7 +332,7 @@ type `incunabula:book`. A cardinality is indeed a kind of restriction: it means that a resource of this type may have, or must have, a certain number of instances of the specified property. For example, `incunabula:book` has cardinalities saying that a book must have at -least one title and at most one publication date. In the Knora API +least one title and at most one publication date. In the DSP-API version 1, the word 'occurrence' is used instead of 'cardinality'. The OWL cardinalities supported by Knora are described in @@ -346,7 +346,7 @@ be wondering whether this cardinality could simply be omitted from the definition of `incunabula:book`. However, Knora requires every property of a resource to have some cardinality in the resource's class. This is because Knora uses the cardinalities to determine which properties are -*possible* for instances of the class, and the Knora API relies on this +*possible* for instances of the class, and the DSP-API relies on this information. If there was no cardinality for `incunabula:hasAuthor`, Knora would not allow a book to have an author. diff --git a/docs/01-introduction/index.md b/docs/01-introduction/index.md index 6af3333c25..bf697433ff 100644 --- a/docs/01-introduction/index.md +++ b/docs/01-introduction/index.md @@ -1,25 +1,25 @@ # Introduction -* [What Is Knora?](what-is-knora.md) -* [Data Formats in Knora](data-formats.md) +* [What Is DSP and DSP-API (previous Knora)?](what-is-knora.md) +* [Data Formats in DSP-API](data-formats.md) * [Standoff/RDF Text Markup](standoff-rdf.md) * [An Example Project](example-project.md) diff --git a/docs/01-introduction/standoff-rdf.md b/docs/01-introduction/standoff-rdf.md index 869c3daffc..3e0fc814ae 100644 --- a/docs/01-introduction/standoff-rdf.md +++ b/docs/01-introduction/standoff-rdf.md @@ -1,20 +1,20 @@ # Standoff/RDF Text Markup @@ -72,7 +72,7 @@ To represent overlapping or non-hierarchical markup in exported and imported XML Future plans for Standoff/RDF include: -- Creation and retrieval of standoff markup as such via the Knora API, +- Creation and retrieval of standoff markup as such via the DSP-API, without using XML as an input/output format. - A user interface for editing standoff markup. - The ability to create resources that cite particular standoff tags in other resources. diff --git a/docs/01-introduction/what-is-knora.md b/docs/01-introduction/what-is-knora.md index e76f428d39..e1b74b1c39 100644 --- a/docs/01-introduction/what-is-knora.md +++ b/docs/01-introduction/what-is-knora.md @@ -1,30 +1,30 @@ -# What Is Knora? +# What Is DSP and DSP-API (previous Knora)? -Knora (Knowledge Organization, Representation, and Annotation) is a +The DaSCH Service Platform (DSP) is a a content management system for the long-term preservation and reuse of humanities data. It is designed to accommodate data with a complex internal structure, including data that could be stored in relational databases. -Knora aims to solve key problems in the long-term preservation and reuse +DSP aims to solve key problems in the long-term preservation and reuse of humanities data: First, traditional archives preserve data, but do not facilitate reuse. Typically, @@ -33,16 +33,16 @@ an information package that might be of interest, then download it, and only then can you find out what's really in it. This is time-consuming, and makes it impractical to reuse data from many different sources. -Knora solves this problem by keeping the data alive. You can query all the data -in a Knora repository, not just the metadata. You can import thousands of databases into -Knora, and run queries that search through all of them at once. +DSP solves this problem by keeping the data alive. You can query all the data +in a DSP repository, not just the metadata. You can import thousands of databases into +DSP, and run queries that search through all of them at once. Another problem is that researchers use a multitude of different data formats, many of which are proprietary and quickly become obsolete. It is not practical to maintain all the programs that were used to create and read old data files, or even all the operating systems that these programs ran on. -Instead of preserving all these data formats, Knora supports +Instead of preserving all these data formats, DSP supports the conversion of all sorts of data to a [small number of formats](data-formats.md) that are suitable for long-term preservation, and that maintain the data's meaning and structure: @@ -55,8 +55,8 @@ structure: archival file formats and stored by [Sipi](https://github.com/dhlab-basel/Sipi), with metadata stored in the triplestore. -Knora then makes this data available for reuse via its generic, standards-based -application programming interfaces (APIs). A virtual research environment +DSP then makes this data available for reuse via its generic, standards-based +application programming interfaces (APIs = DSP-API). A virtual research environment (VRE) can then use these APIs to search, link together, and add to data from different research projects in a unified way. @@ -66,15 +66,15 @@ Each project creates its own data model (or *ontology*), describing the types of items it wishes to store, using basic data types defined in Knora's [base ontology](../02-knora-ontologies/knora-base.md). This gives projects the freedom to describe their data in a way that makes -sense to them, while allowing Knora to support searching and linking across projects. +sense to them, while allowing DSP to support searching and linking across projects. -Knora has built-in support for data structures that are commonly needed in +DSP has built-in support for data structures that are commonly needed in humanities data, and that present unique challenges for any type of database storage. ### Calendar-Independent Dates In the humanities, a date could be based on any sort of calendar (e.g. -Gregorian, Julian, Islamic, or Hebrew). Knora stores dates using a calendar-independent, +Gregorian, Julian, Islamic, or Hebrew). The DSP stores dates using a calendar-independent, astronomical representation, and converts between calendars as needed. This makes it possible to search for a date in one calendar, and get search results in other calendars. @@ -82,16 +82,16 @@ it possible to search for a date in one calendar, and get search results in othe Commonly used text markup systems, such as [TEI/XML](http://www.tei-c.org/), have to represent a text as a hierarchy, and therefore have trouble supporting -overlapping markup. Knora supports [Standoff/RDF markup](standoff-rdf.md): the markup is stored -as RDF data, separately from the text, allowing for overlapping markup. Knora's RDF-based standoff -is designed to support the needs of complex digital critical editions. Knora +overlapping markup. DSP supports [Standoff/RDF markup](standoff-rdf.md): the markup is stored +as RDF data, separately from the text, allowing for overlapping markup. DSP's RDF-based standoff +is designed to support the needs of complex digital critical editions. The DSP can import any XML document (including TEI/XML) for storage as standoff/RDF, and can regenerate the original XML document at any time. ## Powerful Searches -Knora's API provides a search language, [Gravsearch](../03-apis/api-v2/query-language.md), -that is designed to meet the needs of humanities researchers. Gravsearch supports Knora's +DSP-API provides a search language, [Gravsearch](../03-apis/api-v2/query-language.md), +that is designed to meet the needs of humanities researchers. Gravsearch supports DSP-API's humanites-focused data structures, including calendar-independent dates and standoff markup, as well as fast full-text searches. This allows searches to combine text-related criteria with any other criteria. For example, you could search for a text that contains a certain word @@ -100,14 +100,14 @@ author of a text that mentions an event that occurred during a certain time peri ## Access Control -The RDF standards do not include any concept of permissions. Knora's permission +The RDF standards do not include any concept of permissions. DSP-API's permission system allows project administrators and users to determine who can see or -modify each item of data. Knora filters search results according to each +modify each item of data. DSP-API filters search results according to each user's permissions. ## Data History -RDF does not have a concept of data history. Knora maintains all previous +RDF does not have a concept of data history. DSP-API maintains all previous versions of each item of data. Ordinary searches return only the latest version, but you can [obtain](../03-apis/api-v2/reading-and-searching-resources.md#get-a-full-representation-of-a-version-of-a-resource-by-iri) @@ -118,20 +118,20 @@ an item as it was at any point in the past. ## Data Consistency RDF triplestores do not implement a standardised way of ensuring the consistency -of data in a repository. Knora ensures that all data is consistent, conforms -the project-specific data models, and meets Knora's minimum requirements +of data in a repository. DSP-API ensures that all data is consistent, conforms +the project-specific data models, and meets DSP-API's minimum requirements for interoperability and reusability of data. ## Linked Open Data -Knora supports publishing data online as as [Linked Open Data](http://linkeddata.org/), +DSP-API supports publishing data online as as [Linked Open Data](http://linkeddata.org/), using open standards to allow interoperability between different repositories on the web. ## Build Your Own Application -Knora can be used with a general-purpose, browser-based VRE called +DSP-API can be used with a general-purpose, browser-based VRE called [DSP-APP](https://dasch-swiss.github.io/dsp-app) or [SALSAH](https://dhlab-basel.github.io/Salsah/). -Using the Knora API and [Knora-ui](https://github.com/dhlab-basel/Knora-ui), a set of +Using the DSP-API and [DSP-JS](https://github.com/dasch-swiss/dsp-js-lib) and/or [DSP-UI](https://github.com/dasch-swiss/dsp-ui-lib), a set of reusable user-interface components, you can also create your own VRE or project-specific web site. diff --git a/docs/02-knora-ontologies/index.md b/docs/02-knora-ontologies/index.md index c110642218..d30fd0e3b1 100644 --- a/docs/02-knora-ontologies/index.md +++ b/docs/02-knora-ontologies/index.md @@ -1,20 +1,20 @@ # Knora Ontologies @@ -23,6 +23,6 @@ License along with Knora. If not, see . * [The Knora Base Ontology](knora-base.md) * [The SALSAH GUI Ontology](salsah-gui.md) -The Knora ontologies provide a generic framework for describing humanities +The DSP ontologies provide a generic framework for describing humanities research data, allowing data from different projects to be combined, augmented, and reused. diff --git a/docs/02-knora-ontologies/introduction.md b/docs/02-knora-ontologies/introduction.md index d7dc21af26..70281681b1 100644 --- a/docs/02-knora-ontologies/introduction.md +++ b/docs/02-knora-ontologies/introduction.md @@ -1,27 +1,27 @@ # Introduction ## Resource Description Framework (RDF) -Knora uses a hierarchy of ontologies based on the Resource Description +DSP-API uses a hierarchy of ontologies based on the Resource Description Framework ([RDF](http://www.w3.org/TR/2014/NOTE-rdf11-primer-20140624/)), RDF Schema ([RDFS](http://www.w3.org/TR/2014/REC-rdf-schema-20140225/)), and diff --git a/docs/02-knora-ontologies/knora-base.md b/docs/02-knora-ontologies/knora-base.md index 3c65132218..57dc7b6153 100644 --- a/docs/02-knora-ontologies/knora-base.md +++ b/docs/02-knora-ontologies/knora-base.md @@ -1,20 +1,20 @@ # The Knora Base Ontology @@ -22,11 +22,11 @@ License along with Knora. If not, see . ## Overview The Knora base ontology is the main built-in Knora ontology. Each -project that uses Knora must describe its data model by creating +project that uses DSP-API must describe its data model by creating ontologies that extend this ontology. The Knora base ontology is identified by the IRI -`http://www.knora.org/ontology/knora-base`. In the Knora documentation +`http://www.knora.org/ontology/knora-base`. In the DSP-API documentation in general, it is identified by the prefix `knora-base`, but for brevity, in this document, we use `kb` or omit the prefix entirely. @@ -227,9 +227,9 @@ the world (such as `ex:Painting`) and also belongs to a subclass of of file attached to it. For example, if paintings are represented only by still images, `ex:Painting` could be a subclass of `StillImageRepresentation`. This is the only approach supported in -[Knora API v1](../03-apis/api-v1/index.md). +[DSP-API v1](../03-apis/api-v1/index.md). -The more flexible approach, which is supported by [Knora API +The more flexible approach, which is supported by [DSP-API v2](../03-apis/api-v2/index.md), is for each `ex:Painting` to link (using `kb:hasRepresentation` or a subproperty) to other resources containing files that represent the painting. Each of these other resources can extend a @@ -563,7 +563,7 @@ properties: `originalFilename` (0-1) -: The original name of the file when it was uploaded to the Knora API +: The original name of the file when it was uploaded to the DSP-API server. `originalMimeType` (0-1) @@ -611,7 +611,7 @@ of file it describes. For example, still image files have dimensions, video files have frame rates, and so on. `FileValue` objects are versioned like other values, and the actual -files stored by Knora are also versioned. Version 1 of the Knora API +files stored by Knora are also versioned. Version 1 of the DSP-API does not provide a way to retrieve a previous version of a file, but this feature will be added in a subsequent version of the API. @@ -1009,7 +1009,7 @@ The result can be visualized like this: Link values created automatically for resource references in standoff are visible to all users, and the creator of these link values is always `kb:SystemUser` (see [Users and Groups](#users-and-groups)). The -Knora API server allows a user to see a standoff link if the user has +DSP-API server allows a user to see a standoff link if the user has permission to see the source and target resources. #### Internal Links in a TextValue diff --git a/docs/02-knora-ontologies/salsah-gui.md b/docs/02-knora-ontologies/salsah-gui.md index a4e30649b5..cb7f15a933 100644 --- a/docs/02-knora-ontologies/salsah-gui.md +++ b/docs/02-knora-ontologies/salsah-gui.md @@ -1,20 +1,20 @@ # The SALSAH GUI Ontology @@ -168,13 +168,13 @@ identifier = letter , { letter } ; `Searchbox` : A GUI element for searching for a resource by matching text in its - `rdfs:label`. For Knora API v1, a property definition that uses this + `rdfs:label`. For DSP-API v1, a property definition that uses this element may also contain this `guiAttribute` predicate: - `"numprops=N"`, where `N` is an integer specifying the number of describing properties to be returned for each found resource. - For Knora API v2, the `guiAttribute` has no effect. + For DSP-API v2, the `guiAttribute` has no effect. `SimpleText` diff --git a/docs/03-apis/api-admin/groups.md b/docs/03-apis/api-admin/groups.md index 2ff2e53831..04f6e67bfd 100644 --- a/docs/03-apis/api-admin/groups.md +++ b/docs/03-apis/api-admin/groups.md @@ -1,20 +1,20 @@ # Groups Endpoint @@ -129,4 +129,4 @@ Example Group Information stored in admin named graph: : - Returns all group members - Required permission: SystemAdmin / ProjectAdmin -- GET: `/admin/groups//members` \ No newline at end of file +- GET: `/admin/groups//members` diff --git a/docs/03-apis/api-admin/index.md b/docs/03-apis/api-admin/index.md index 4985f8495f..3e8408c848 100644 --- a/docs/03-apis/api-admin/index.md +++ b/docs/03-apis/api-admin/index.md @@ -1,20 +1,20 @@ # Knora Admin API @@ -30,6 +30,3 @@ The Knora admin API makes it possible to administer Knora projects, users, user - [New Lists Endpoint](lists_new-list-admin-routes_v1.md) - [Permissions Endpoint](permissions.md) - [Stores Endpoint](stores.md) - - -@@@ diff --git a/docs/03-apis/api-admin/introduction.md b/docs/03-apis/api-admin/introduction.md index d812cf4546..b55be72cc9 100644 --- a/docs/03-apis/api-admin/introduction.md +++ b/docs/03-apis/api-admin/introduction.md @@ -1,20 +1,20 @@ # Introduction: Using the Admin API @@ -36,7 +36,7 @@ Every resource that is created or hosted by Knora is identified by a unique ID called an Internationalized Resource Identifier ([IRI](https://tools.ietf.org/html/rfc3987)). The IRI is required for every API operation to identify the resource in question. A Knora IRI has itself the format of a URL. For some API operations, the IRI has to be URL-encoded (HTTP GET requests). -Unlike the Knora API v2, the admin API uses internal IRIs, i.e. the actual IRIs +Unlike the DSP-API v2, the admin API uses internal IRIs, i.e. the actual IRIs that are stored in the triplestore (see [Knora IRIs](../api-v2/knora-iris.md)). ## Admin Path Segment diff --git a/docs/03-apis/api-admin/lists.md b/docs/03-apis/api-admin/lists.md index 21a82b823b..4d53071507 100644 --- a/docs/03-apis/api-admin/lists.md +++ b/docs/03-apis/api-admin/lists.md @@ -1,20 +1,20 @@ # Lists Endpoint diff --git a/docs/03-apis/api-admin/lists_new-list-admin-routes_v1.md b/docs/03-apis/api-admin/lists_new-list-admin-routes_v1.md index 1c0c78ca5d..b311bb735e 100644 --- a/docs/03-apis/api-admin/lists_new-list-admin-routes_v1.md +++ b/docs/03-apis/api-admin/lists_new-list-admin-routes_v1.md @@ -1,20 +1,20 @@ # Lists Endpoint diff --git a/docs/03-apis/api-admin/overview.md b/docs/03-apis/api-admin/overview.md index d9c50b77c2..f3192d0226 100644 --- a/docs/03-apis/api-admin/overview.md +++ b/docs/03-apis/api-admin/overview.md @@ -19,7 +19,7 @@ License along with Knora. If not, see . +License along with DSP. If not, see . --> # Permissions Endpoint diff --git a/docs/03-apis/api-admin/projects.md b/docs/03-apis/api-admin/projects.md index ce1f24052f..7f925f5f82 100644 --- a/docs/03-apis/api-admin/projects.md +++ b/docs/03-apis/api-admin/projects.md @@ -1,20 +1,20 @@ # Projects Endpoint diff --git a/docs/03-apis/api-admin/stores.md b/docs/03-apis/api-admin/stores.md index f4e3c95e12..d3a4fabda9 100644 --- a/docs/03-apis/api-admin/stores.md +++ b/docs/03-apis/api-admin/stores.md @@ -1,20 +1,20 @@ # Stores Endpoint diff --git a/docs/03-apis/api-admin/users.md b/docs/03-apis/api-admin/users.md index 5e0cd03c27..de93b09bf1 100644 --- a/docs/03-apis/api-admin/users.md +++ b/docs/03-apis/api-admin/users.md @@ -1,20 +1,20 @@ # Users Endpoint diff --git a/docs/03-apis/api-util/health.md b/docs/03-apis/api-util/health.md index 85d3daab93..1013af62e9 100644 --- a/docs/03-apis/api-util/health.md +++ b/docs/03-apis/api-util/health.md @@ -1,20 +1,20 @@ -# Health \ No newline at end of file +# Health diff --git a/docs/03-apis/api-util/index.md b/docs/03-apis/api-util/index.md index afe5f3485f..703f578226 100644 --- a/docs/03-apis/api-util/index.md +++ b/docs/03-apis/api-util/index.md @@ -1,20 +1,20 @@ # Knora Util API diff --git a/docs/03-apis/api-util/version.md b/docs/03-apis/api-util/version.md index ba3e72d423..dc0e2361a6 100644 --- a/docs/03-apis/api-util/version.md +++ b/docs/03-apis/api-util/version.md @@ -1,20 +1,20 @@ # Version @@ -50,4 +50,4 @@ The response has the type `application/json` and contains the following informat "sipi": "v2.0.1", "webapi": "10.0.0-7-gc5a72b3-SNAPSHOT" } -``` \ No newline at end of file +``` diff --git a/docs/03-apis/api-v1/adding-resources.md b/docs/03-apis/api-v1/adding-resources.md index 6f8fc15faf..b0cc2b2854 100644 --- a/docs/03-apis/api-v1/adding-resources.md +++ b/docs/03-apis/api-v1/adding-resources.md @@ -1,20 +1,20 @@ # Adding Resources @@ -100,7 +100,7 @@ set to `application/json`. When a resource has been successfully created, Knora sends back a JSON containing the new resource's IRI (`res_id`) and its properties. The resource IRI identifies the resource and can be used to perform future -Knora API V1 operations. +DSP-API V1 operations. The JSON format of the response is described in the TypeScript interface `createResourceResponse` in module `createResourceFormats`. @@ -201,7 +201,7 @@ containing three files: #### 2. Upload Files to Sipi See [Upload Files to Sipi](../api-v2/editing-values.md#upload-files-to-sipi) in -the Knora API v2 documentation. +the DSP-API v2 documentation. #### 3. Generate XML Import Document diff --git a/docs/03-apis/api-v1/adding-values.md b/docs/03-apis/api-v1/adding-values.md index fe84f84200..61aaf5dc54 100644 --- a/docs/03-apis/api-v1/adding-values.md +++ b/docs/03-apis/api-v1/adding-values.md @@ -1,20 +1,20 @@ # Adding a Value @@ -56,7 +56,7 @@ HTTP POST to http://host/v1/values When a value has been successfully created, Knora sends back a JSON with the new value's IRI. The value IRI identifies the value and can be used -to perform future Knora API V1 operations. +to perform future DSP-API V1 operations. The JSON format of the response is described in the TypeScript interface `addValueResponse` in module `addValueFormats`. diff --git a/docs/03-apis/api-v1/authentication.md b/docs/03-apis/api-v1/authentication.md index 4f91b027cb..bd4a2723da 100644 --- a/docs/03-apis/api-v1/authentication.md +++ b/docs/03-apis/api-v1/authentication.md @@ -1,20 +1,20 @@ # Authentication diff --git a/docs/03-apis/api-v1/changing-values.md b/docs/03-apis/api-v1/changing-values.md index 699476b24c..c36e8545a0 100644 --- a/docs/03-apis/api-v1/changing-values.md +++ b/docs/03-apis/api-v1/changing-values.md @@ -1,20 +1,20 @@ # Changing a Value @@ -76,7 +76,7 @@ content type must be set to `application/json`. When a value has been successfully changed, Knora sends back a JSON with the new value's IRI. The value IRI identifies the value and can be used -to perform future Knora API V1 operations. +to perform future DSP-API V1 operations. The JSON format of the response is described in the TypeScript interface `changeValueResponse` in module `changeValueFormats`. diff --git a/docs/03-apis/api-v1/delete-resources-and-values.md b/docs/03-apis/api-v1/delete-resources-and-values.md index b113cb600c..ce4f45a238 100644 --- a/docs/03-apis/api-v1/delete-resources-and-values.md +++ b/docs/03-apis/api-v1/delete-resources-and-values.md @@ -1,20 +1,20 @@ # Deleting Resources and Values diff --git a/docs/03-apis/api-v1/index.md b/docs/03-apis/api-v1/index.md index 742607162c..39450bf430 100644 --- a/docs/03-apis/api-v1/index.md +++ b/docs/03-apis/api-v1/index.md @@ -1,23 +1,23 @@ -# Knora API v1 +# DSP-API v1 - [Introduction](introduction.md) - [Authentication](authentication.md) diff --git a/docs/03-apis/api-v1/introduction.md b/docs/03-apis/api-v1/introduction.md index fcbe7630f7..4a1d408748 100644 --- a/docs/03-apis/api-v1/introduction.md +++ b/docs/03-apis/api-v1/introduction.md @@ -1,27 +1,27 @@ # Introduction: Using API V1 ## RESTful API -Knora API V1 is a RESTful API that allows for reading and adding of +DSP-API V1 is a RESTful API that allows for reading and adding of resources from and to Knora and changing their values using HTTP requests. The actual data is submitted as JSON (request and response format). The diverse HTTP methods are applied according to the @@ -38,7 +38,7 @@ IRI is required for every API operation to identify the resource in question. A Knora IRI has itself the format of a URL. For some API operations, the IRI has to be URL-encoded (HTTP GET requests). -Unlike Knora API v2, Knora API v1 uses internal IRIs, i.e. the actual IRIs +Unlike DSP-API v2, DSP-API v1 uses internal IRIs, i.e. the actual IRIs that are stored in the triplestore (see [Knora IRIs](../api-v2/knora-iris.md)). ## V1 Path Segment @@ -48,7 +48,7 @@ Every request to API V1 includes `v1` as a path segment, e.g. Accordingly, requests to another version of the API will require another path segment. -## Knora API Response Format +## DSP-API Response Format In case an API request could be handled successfully, Knora responds with a 200 HTTP status code. The actual answer from Knora (the diff --git a/docs/03-apis/api-v1/reading-and-searching-resources.md b/docs/03-apis/api-v1/reading-and-searching-resources.md index 320c0b8e4b..2ddfff5542 100644 --- a/docs/03-apis/api-v1/reading-and-searching-resources.md +++ b/docs/03-apis/api-v1/reading-and-searching-resources.md @@ -1,20 +1,20 @@ # Reading and Searching Resources diff --git a/docs/03-apis/api-v1/reading-values.md b/docs/03-apis/api-v1/reading-values.md index 4a3c93d048..31ea38be84 100644 --- a/docs/03-apis/api-v1/reading-values.md +++ b/docs/03-apis/api-v1/reading-values.md @@ -1,20 +1,20 @@ # Reading Values diff --git a/docs/03-apis/api-v1/xml-to-standoff-mapping.md b/docs/03-apis/api-v1/xml-to-standoff-mapping.md index 8c11c647d5..f1142b71f4 100644 --- a/docs/03-apis/api-v1/xml-to-standoff-mapping.md +++ b/docs/03-apis/api-v1/xml-to-standoff-mapping.md @@ -1,20 +1,20 @@ # XML to Standoff Mapping in API v1 diff --git a/docs/03-apis/api-v2/authentication.md b/docs/03-apis/api-v2/authentication.md index 028551fdf8..0db27295b6 100644 --- a/docs/03-apis/api-v2/authentication.md +++ b/docs/03-apis/api-v2/authentication.md @@ -1,25 +1,25 @@ # Authentication -Access to the Knora API can for certain operations require a user to authenticate. +Access to the DSP-API can for certain operations require a user to authenticate. Authentication can be performed in two ways: 1. By providing *password credentials*, which are a combination of a *identifier* and diff --git a/docs/03-apis/api-v2/editing-resources.md b/docs/03-apis/api-v2/editing-resources.md index 01c9a38f6f..c5f0a8f574 100644 --- a/docs/03-apis/api-v2/editing-resources.md +++ b/docs/03-apis/api-v2/editing-resources.md @@ -1,20 +1,20 @@ # Editing Resources @@ -350,7 +350,7 @@ with a confirmation message. ### Links to Deleted Resources If resource `A` has a link to resource `B`, and resource -`B` is later marked as deleted, `A`'s link will still exist. Knora API +`B` is later marked as deleted, `A`'s link will still exist. DSP-API v2 will still return the link when `A` is queried, but without any information about `B` (except for `B`'s IRI). If `A`'s link is necessary to meet the requirements of a cardinality, marking `B` as deleted will diff --git a/docs/03-apis/api-v2/editing-values.md b/docs/03-apis/api-v2/editing-values.md index b51895bccb..53ee369e70 100644 --- a/docs/03-apis/api-v2/editing-values.md +++ b/docs/03-apis/api-v2/editing-values.md @@ -1,20 +1,20 @@ # Editing Values @@ -226,7 +226,7 @@ provided. Knora supports the storage of certain types of data as files, using [Sipi](https://github.com/dhlab-basel/Sipi) (see [FileValue](../../02-knora-ontologies/knora-base.md#filevalue)). -Knora API v2 currently supports using Sipi to store the following types of files: +DSP-API v2 currently supports using Sipi to store the following types of files: * Images: JPEG, JPEG2000, TIFF, or PNG which are stored internally as JPEG2000 * Documents: PDF diff --git a/docs/03-apis/api-v2/getting-lists.md b/docs/03-apis/api-v2/getting-lists.md index ad15ec3fdf..7cba532f82 100644 --- a/docs/03-apis/api-v2/getting-lists.md +++ b/docs/03-apis/api-v2/getting-lists.md @@ -1,20 +1,20 @@ # Getting Lists @@ -38,4 +38,4 @@ In order to request a single node of a list, make a HTTP GET request to the `nod HTTP GET to http://host/v2/node/nodeIri ``` -Nodes are only returned in the complex schema. The response to a node request is a `ListNode` (see interface `List` in module `ListResponse`). \ No newline at end of file +Nodes are only returned in the complex schema. The response to a node request is a `ListNode` (see interface `List` in module `ListResponse`). diff --git a/docs/03-apis/api-v2/index.md b/docs/03-apis/api-v2/index.md index 954a7a32dd..183f7505b2 100644 --- a/docs/03-apis/api-v2/index.md +++ b/docs/03-apis/api-v2/index.md @@ -1,23 +1,23 @@ -# Knora API v2 +# DSP-API v2 - [Introduction](introduction.md) - [Authentication](authentication.md) @@ -32,5 +32,3 @@ License along with Knora. If not, see . - [Querying, Creating, and Updating Ontologies](ontology-information.md) - [TEI/XML](tei-xml.md) - [Permalinks](permalinks.md) - -@@@ diff --git a/docs/03-apis/api-v2/introduction.md b/docs/03-apis/api-v2/introduction.md index 10a995342a..d410555d02 100644 --- a/docs/03-apis/api-v2/introduction.md +++ b/docs/03-apis/api-v2/introduction.md @@ -1,25 +1,25 @@ # Introduction: Using API v2 -Version 2 of the Knora API aims to make both the response and request +Version 2 of the DSP-API aims to make both the response and request formats more generic and consistent. Version 1 was basically the result of the reimplementation of the existing API of the SALSAH prototype. Since the development of this prototype has a long history and the @@ -56,7 +56,7 @@ can request these formats using the following MIME types: Our preferred format for data exchange is [JSON-LD](https://json-ld.org/spec/latest/json-ld/). JSON-LD allows the -Knora API server to provide responses that are relatively easy for +DSP-API server to provide responses that are relatively easy for automated processes to interpret, since their structure and semantics is explicitly defined. For example, each user-created Knora resource property is identified by an IRI, which can be dereferenced to get more @@ -82,7 +82,7 @@ same entity is used in more than one place, it is inlined only once, and other uses just refer to its IRI. In Knora's flat JSON-LD, all entities with IRIs are located at the top level of the document (in a `@graph` if there is more than one of them). This setting does not affect blank nodes, which are always inlined (unlike in standard -flat JSON-LD). Knora ontologies are always returned in the `flat` rendering; other kinds +flat JSON-LD). DSP ontologies are always returned in the `flat` rendering; other kinds of responses default to `hierarchical`. To use this setting, submit the HTTP header `X-Knora-JSON-LD-Rendering` with the value `hierarchical` or `flat`. @@ -93,13 +93,13 @@ is explained in [Knora IRIs](knora-iris.md). ## API Schema -Knora API v2 uses RDF data structures that are simpler than the ones +DSP-API v2 uses RDF data structures that are simpler than the ones actually stored in the triplestore, and more suitable for the development of client software. Thus we refer to the *internal* schema of data as it is stored in the triplestore, and to *external* schemas which are used to represent that data in API v2. -Knora API v2 offers a complex schema and a simple one. The main difference +DSP-API v2 offers a complex schema and a simple one. The main difference is that the complex schema exposes the complexity of value objects, while the simple version does not. A client that needs to edit values must use the complex schema in order to obtain the IRI of each value. A client that reads @@ -109,7 +109,7 @@ context of Linked Open Data. It is therefore designed to use the simplest possible datatypes and to require minimal knowledge of Knora. In either case, the client deals only with data whose structure and -semantics are defined by external Knora API ontologies, which are distinct from +semantics are defined by external DSP-API ontologies, which are distinct from the internal ontologies that are used to store date in the triplestore. The Knora API server automatically converts back and forth between these internal and external representations. This approach encapsulates the internals diff --git a/docs/03-apis/api-v2/knora-iris.md b/docs/03-apis/api-v2/knora-iris.md index 9c2ee99d56..11d95e723d 100644 --- a/docs/03-apis/api-v2/knora-iris.md +++ b/docs/03-apis/api-v2/knora-iris.md @@ -1,25 +1,25 @@ # Knora IRIs -The IRIs used in Knora repositories and in the Knora API v2 follow +The IRIs used in Knora repositories and in the DSP-API v2 follow certain conventions. ## Project Short-Codes @@ -69,7 +69,7 @@ http://www.knora.org/ontology/0001/example An ontology name must be a valid XML [NCName](https://www.w3.org/TR/xml-names/#NT-NCName). -The following names are reserved for built-in internal Knora ontologies: +The following names are reserved for built-in internal DSP ontologies: - `knora-base` - `standoff` @@ -104,7 +104,7 @@ the hostname and port configured in `application.conf` under (the port is omitted if it is 80). This means that when a built-in or shared external ontology IRI is dereferenced, -the ontology can be served by a Knora API server running at +the ontology can be served by a DSP-API server running at `api.knora.org`. When the external IRI of a non-shared, project-specific ontology is dereferenced, the ontology can be served by Knora that hosts the project. During development and testing, this could be @@ -115,23 +115,23 @@ corresponding internal ontology, with one exception: the external form of `knora-base` is called `knora-api`. The API version identifier indicates not only the version of the API, -but also an API 'schema'. The Knora API v2 is available in two schemas: +but also an API 'schema'. The DSP-API v2 is available in two schemas: - A complex schema, which is suitable both for reading and for editing data. The complex schema represents values primarily as complex objects. Its version identifier is `v2`. - A simple schema, which is suitable for reading data but not for editing it. The simple schema facilitates interoperability between - Knora ontologies and non-Knora ontologies, since it represents + DSP ontologies and non-DSP ontologies, since it represents values primarily as literals. Its version identifier is `simple/v2`. Other schemas could be added in the future for more specific use cases. When requesting an ontology, the client requests a particular schema. -(This will also be true of most Knora API v2 requests: the client will +(This will also be true of most DSP-API v2 requests: the client will be able to specify which schema the response should be provided in.) -For example, suppose a Knora API server is running at +For example, suppose a DSP-API server is running at `knora.example.org` and hosts an ontology whose internal IRI is `http://www.knora.org/ontology/0001/example`. That ontology can then be requested using either of these IRIs: @@ -153,7 +153,7 @@ schema being used: ### Ontology Entity IRIs -Knora ontologies use 'hash namespaces' (see [URI +DSP ontologies use 'hash namespaces' (see [URI Namespaces](https://www.w3.org/2001/sw/BestPractices/VM/http-examples/2006-01-18/#naming)). This means that the IRI of an ontology entity (a class or property definition) is constructed by adding a hash character (`#`) to the diff --git a/docs/03-apis/api-v2/metadata.md b/docs/03-apis/api-v2/metadata.md index 878206e6b2..9ba8ff476f 100644 --- a/docs/03-apis/api-v2/metadata.md +++ b/docs/03-apis/api-v2/metadata.md @@ -1,20 +1,20 @@ # Metadata Endpoint diff --git a/docs/03-apis/api-v2/ontology-information.md b/docs/03-apis/api-v2/ontology-information.md index da52fde211..3a89340767 100644 --- a/docs/03-apis/api-v2/ontology-information.md +++ b/docs/03-apis/api-v2/ontology-information.md @@ -1,20 +1,20 @@ # Querying, Creating, and Updating Ontologies @@ -22,7 +22,7 @@ License along with Knora. If not, see . ## Querying Ontology Information Before reading this document, you should have a basic understanding of -Knora API v2 external ontology schemas (see [API Schema](introduction.md#api-schema)). +DSP-API v2 external ontology schemas (see [API Schema](introduction.md#api-schema)). Each request returns a single RDF graph, which can be represented in [JSON-LD](https://json-ld.org/spec/latest/json-ld/), @@ -158,7 +158,7 @@ or RDF/XML, add an HTTP `Accept` header (see [Response Formats](introduction.md#response-formats)). If the client dereferences a project-specific ontology IRI as a URL, the -Knora API server running on the hostname in the IRI will serve the +DSP-API server running on the hostname in the IRI will serve the ontology. For example, if the server is running on `0.0.0.0:3333`, the IRI `http://0.0.0.0:3333/ontology/00FF/images/simple/v2` can be dereferenced to request the `images` sample ontology in the simple @@ -166,14 +166,14 @@ schema. If the client dereferences a built-in Knora ontology, such as `http://api.knora.org/ontology/knora-api/simple/v2`, there must be a -Knora API server running at `api.knora.org` that can serve the ontology. +DSP-API server running at `api.knora.org` that can serve the ontology. The [DaSCH](http://dasch.swiss/) intends to run such as server. For testing, you can configure your local `/etc/hosts` file to resolve `api.knora.org` as `localhost`. #### Differences Between Internal and External Ontologies -The external ontologies used by Knora API v2 are different to the internal +The external ontologies used by DSP-API v2 are different to the internal ontologies that are actually stored in the triplestore (see [API Schema](introduction.md#api-schema)). In general, the external ontologies use simpler data structures, but they also provide additional diff --git a/docs/03-apis/api-v2/permalinks.md b/docs/03-apis/api-v2/permalinks.md index 7d1b32d400..fff35a9c39 100644 --- a/docs/03-apis/api-v2/permalinks.md +++ b/docs/03-apis/api-v2/permalinks.md @@ -1,20 +1,20 @@ # Permalinks diff --git a/docs/03-apis/api-v2/query-language.md b/docs/03-apis/api-v2/query-language.md index 5ed2b651f0..4b90928cb8 100644 --- a/docs/03-apis/api-v2/query-language.md +++ b/docs/03-apis/api-v2/query-language.md @@ -1,20 +1,20 @@ # Gravsearch: Virtual Graph Search @@ -90,7 +90,7 @@ The response to a count query request is an object with one predicate, ## Gravsearch and API Schemas A Gravsearch query can be written in either of the two -[Knora API v2 schemas](introduction.md#api-schema). The simple schema +[DSP-API v2 schemas](introduction.md#api-schema). The simple schema is easier to work with, and is sufficient if you don't need to query anything below the level of a Knora value. If your query needs to refer to standoff markup, you must use the complex schema. Each query must use a single @@ -99,12 +99,12 @@ schema, with one exception (see [Date Comparisons](#date-comparisons)). Gravsearch query results can be requested in the simple or complex schema; see [API Schema](introduction.md#api-schema). -All examples hereafter run with Knora started locally as documented in the section [Getting Started with Knora](../../04-publishing-deployment/getting-started.md). If you access another Knora-Stack, you can check the IRI of the ontology you are targeting by requesting the [ontologies metadata](ontology-information.md#querying-ontology-metadata). +All examples hereafter run with Knora started locally as documented in the section [Getting Started with DSP-API](../../04-publishing-deployment/getting-started.md). If you access another Knora-Stack, you can check the IRI of the ontology you are targeting by requesting the [ontologies metadata](ontology-information.md#querying-ontology-metadata). ### Using the Simple Schema To write a query in the simple schema, use the `knora-api` ontology in -the simple schema, and use the simple schema for any other Knora ontologies +the simple schema, and use the simple schema for any other DSP ontologies the query refers to, e.g.: ``` @@ -119,7 +119,7 @@ can be used `FILTER` expressions ### Using the Complex Schema To write a query in the complex schema, use the `knora-api` ontology in -the complex schema, and use the complex schema for any other Knora ontologies +the complex schema, and use the complex schema for any other DSP ontologies the query refers to, e.g.: ``` diff --git a/docs/03-apis/api-v2/reading-and-searching-resources.md b/docs/03-apis/api-v2/reading-and-searching-resources.md index 61b3d2697f..2f76ca6cd7 100644 --- a/docs/03-apis/api-v2/reading-and-searching-resources.md +++ b/docs/03-apis/api-v2/reading-and-searching-resources.md @@ -1,20 +1,20 @@ # Reading and Searching Resources @@ -37,7 +37,7 @@ simple or the complex ontology schema. The complex schema is used by default. To receive a response in the simple schema, use the HTTP request header or URL parameter described in [API Schema](introduction.md#api-schema). -Each Knora API v2 response describing one or more resources returns a +Each DSP-API v2 response describing one or more resources returns a single RDF graph. For example, a request for a single resource returns that resource and all its values. In a full-text search, the resource is returned with the values that matched the search criteria. A response to an extended search diff --git a/docs/03-apis/api-v2/reading-user-permissions.md b/docs/03-apis/api-v2/reading-user-permissions.md index e75416eb53..4b716c4f46 100644 --- a/docs/03-apis/api-v2/reading-user-permissions.md +++ b/docs/03-apis/api-v2/reading-user-permissions.md @@ -1,20 +1,20 @@ # Reading the User's Permissions on Resources and Values diff --git a/docs/03-apis/api-v2/tei-xml.md b/docs/03-apis/api-v2/tei-xml.md index b3d6cf7aa5..0cf6421a6e 100644 --- a/docs/03-apis/api-v2/tei-xml.md +++ b/docs/03-apis/api-v2/tei-xml.md @@ -1,20 +1,20 @@ # TEI/XML: Converting Standoff to TEI/XML @@ -430,4 +430,4 @@ HTTP GET request to http://host/v2/tei/resourceIri&textProperty=textPropertyIri& See `webapi/src/it/scala/org/knora/webapi/e2e/v1/KnoraSipiIntegrationV1ITSpec.scala` for a complete test case involving the sample data ("create a mapping for standoff conversion to TEI referring to an XSLT and also create a Gravsearch template and an XSLT for transforming TEI header data"). When you provide a custom conversion, it is up to you to ensure the validity of the TEI document. You can use this service to validate: [TEI by example validator](http://teibyexample.org/xquery/TBEvalidator.xq). -Problems and bugs caused by XSL transformations are out of scope of the responsibility of the Knora software. \ No newline at end of file +Problems and bugs caused by XSL transformations are out of scope of the responsibility of the Knora software. diff --git a/docs/03-apis/api-v2/xml-to-standoff-mapping.md b/docs/03-apis/api-v2/xml-to-standoff-mapping.md index f65d073135..4e3509ef8a 100644 --- a/docs/03-apis/api-v2/xml-to-standoff-mapping.md +++ b/docs/03-apis/api-v2/xml-to-standoff-mapping.md @@ -1,20 +1,20 @@ # XML to Standoff Mapping in API v2 diff --git a/docs/03-apis/feature-toggles.md b/docs/03-apis/feature-toggles.md index 7ab78b3fea..7f54186423 100644 --- a/docs/03-apis/feature-toggles.md +++ b/docs/03-apis/feature-toggles.md @@ -1,20 +1,20 @@ # Feature Toggles @@ -73,6 +73,6 @@ be given when disabling a toggle. ## Response Header -Knora API v2 and admin API responses contain the header +DSP-API v2 and admin API responses contain the header `X-Knora-Feature-Toggles`. It lists all configured toggles, in the same format as the corresponding request header. diff --git a/docs/03-apis/index.md b/docs/03-apis/index.md index 9b6318b09f..784fdc36da 100644 --- a/docs/03-apis/index.md +++ b/docs/03-apis/index.md @@ -1,33 +1,33 @@ -# The Knora APIs +# The DSP APIs -The Knora APIs include: +The DSP APIs include: -* The Knora API versions [1](api-v1/index.md) and [2](api-v2/index.md), which is intended to be used by +* The DSP API versions [1](api-v1/index.md) and [2](api-v2/index.md), which is intended to be used by virtual research environments and other clients for querying and updating data. -* The Knora [Admin API](api-admin/index.md), which is intended to be used only by the +* The DSP [Admin API](api-admin/index.md), which is intended to be used only by the [DSP-APP](https://github.com/dasch-swiss/dsp-app) user interface, for administering projects that use Knora as well as Knora itself. -* The Knora [Util API](api-util/index.md), which is intended to be used for information retrieval - about the Knora-stack itself. +* The DSP [Util API](api-util/index.md), which is intended to be used for information retrieval + about the DSP-stack itself. -Knora API v2 and the admin API support [Feature Toggles](feature-toggles.md). +DSP API v2 and the admin API support [Feature Toggles](feature-toggles.md). diff --git a/docs/04-publishing-deployment/configuration.md b/docs/04-publishing-deployment/configuration.md index 26ccc8ebbc..f5ca4d33f0 100644 --- a/docs/04-publishing-deployment/configuration.md +++ b/docs/04-publishing-deployment/configuration.md @@ -1,20 +1,20 @@ # Configuration diff --git a/docs/04-publishing-deployment/getting-started.md b/docs/04-publishing-deployment/getting-started.md index eb234ad069..e839c48d22 100644 --- a/docs/04-publishing-deployment/getting-started.md +++ b/docs/04-publishing-deployment/getting-started.md @@ -1,25 +1,25 @@ -# Getting Started with Knora +# Getting Started with DSP-API -Running Knora locally or on a server requires [Docker](https://www.docker.com), which +Running DSP-API locally or on a server requires [Docker](https://www.docker.com), which can be freely downloaded. Please follow the instructions for installing [Docker Desktop](https://www.docker.com/products/docker-desktop). @@ -54,13 +54,13 @@ export JAVA_HOME=`/usr/libexec/java_home -v 11` ## Choosing a Triplestore -Knora requires a standards-compliant +DSP-API requires a standards-compliant [RDF](https://www.w3.org/TR/rdf11-primer/) triplestore. A number of triplestore implementations are available, including [free software](http://www.gnu.org/philosophy/free-sw.en.html) as well as proprietary options. -Knora is designed to work with any standards-compliant +DSP-API is designed to work with any standards-compliant triplestore. It is primarily tested with [Apache Jena Fuseki](https://jena.apache.org), an open source triplestore. @@ -69,9 +69,9 @@ triplestore [Ontotext GraphDB](http://ontotext.com/products/graphdb/) is provided but unmaintained (GraphDB must be licensed separately by the user). Other triplestores are planned. -## Running the Knora-Stack +## Running the DSP-Stack -Use `git` to clone the Knora repository from [Github](https://github.com/dasch-swiss/knora-api). +Use `git` to clone the DSP-API repository from [Github](https://github.com/dasch-swiss/dsp-api). The following environment variables are **optional**: @@ -85,7 +85,7 @@ $ export KNORA_DB_IMPORT=/path/to/some/folder $ export KNORA_DB_HOME=/path/to/some/other_folder ``` -Then from inside the cloned `Knora-API` repository folder, run: +Then from inside the cloned `DSP-API` repository folder, run: ```bash $ make stack-up @@ -101,7 +101,7 @@ $ make init-db-test The scripts called by `make` can be found under `webapi/scripts`. You can create your own scripts based on these scripts, to create new -repositories and optionally to load existing Knora-compliant RDF data +repositories and optionally to load existing DSP-compliant RDF data into them. If you need to reload the test data, you need to stop and **delete** the diff --git a/docs/04-publishing-deployment/index.md b/docs/04-publishing-deployment/index.md index c7ab0ff776..bc98ffd0c5 100644 --- a/docs/04-publishing-deployment/index.md +++ b/docs/04-publishing-deployment/index.md @@ -1,27 +1,25 @@ -# Deploying Knora +# Deploying DSP-API - [Publishing](publishing.md) -- [Getting Started with Knora](getting-started.md) +- [Getting Started with DSP-API](getting-started.md) - [Configuration](configuration.md) -- [Updating Repositories When Upgrading Knora](updates.md) - -@@@ +- [Updating Repositories When Upgrading DSP-API](updates.md) diff --git a/docs/04-publishing-deployment/publishing.md b/docs/04-publishing-deployment/publishing.md index cbb5ae2183..9e18a2c24b 100644 --- a/docs/04-publishing-deployment/publishing.md +++ b/docs/04-publishing-deployment/publishing.md @@ -1,20 +1,20 @@ # Publishing diff --git a/docs/04-publishing-deployment/updates.md b/docs/04-publishing-deployment/updates.md index 59cf4f79b5..e229407122 100644 --- a/docs/04-publishing-deployment/updates.md +++ b/docs/04-publishing-deployment/updates.md @@ -1,20 +1,20 @@ # Updating Repositories When Upgrading Knora diff --git a/docs/05-internals/design/api-admin/index.md b/docs/05-internals/design/api-admin/index.md index 267e559fa7..dfde742e17 100644 --- a/docs/05-internals/design/api-admin/index.md +++ b/docs/05-internals/design/api-admin/index.md @@ -1,20 +1,20 @@ # Admin API Design diff --git a/docs/05-internals/design/api-v1/how-to-add-a-route.md b/docs/05-internals/design/api-v1/how-to-add-a-route.md index a5242ec0c1..87c252968b 100644 --- a/docs/05-internals/design/api-v1/how-to-add-a-route.md +++ b/docs/05-internals/design/api-v1/how-to-add-a-route.md @@ -1,20 +1,20 @@ # How to Add an API v1 Route diff --git a/docs/05-internals/design/api-v1/index.md b/docs/05-internals/design/api-v1/index.md index 30344b61e1..81c896f4e9 100644 --- a/docs/05-internals/design/api-v1/index.md +++ b/docs/05-internals/design/api-v1/index.md @@ -1,23 +1,23 @@ -# Knora API v1 Design +# DSP-API v1 Design - [JSON in API v1](json.md) - [How to Add an API v1 Route](how-to-add-a-route.md) diff --git a/docs/05-internals/design/api-v1/json.md b/docs/05-internals/design/api-v1/json.md index b1a71a88bf..05c09def25 100644 --- a/docs/05-internals/design/api-v1/json.md +++ b/docs/05-internals/design/api-v1/json.md @@ -1,25 +1,25 @@ ### JSON in API v1 -Knora API v1 parses and generates JSON using the +DSP-API v1 parses and generates JSON using the [spray-json](https://github.com/spray/spray-json) library. The triplestore returns results in JSON, and these are parsed into diff --git a/docs/05-internals/design/api-v2/ark.md b/docs/05-internals/design/api-v2/ark.md index 21c300433e..9472a7e93a 100644 --- a/docs/05-internals/design/api-v2/ark.md +++ b/docs/05-internals/design/api-v2/ark.md @@ -1,20 +1,20 @@ # Archival Resource Key (ARK) Identifiers diff --git a/docs/05-internals/design/api-v2/content-wrappers.md b/docs/05-internals/design/api-v2/content-wrappers.md index d930e7503e..ac58cd6715 100644 --- a/docs/05-internals/design/api-v2/content-wrappers.md +++ b/docs/05-internals/design/api-v2/content-wrappers.md @@ -1,20 +1,20 @@ # Content Wrappers @@ -42,7 +42,7 @@ has the resource IRI and the property IRI, but not the value IRI. A read wrapper can be wrapped in another read wrapper; for example, a `ReadResourceV2` contains `ReadValueV2` objects. -In general, Knora API v2 responders deal only with the internal schema. +In general, DSP-API v2 responders deal only with the internal schema. (The exception is `OntologyResponderV2`, which can return ontology information that exists only in an external schema.) Therefore, a content class needs to be able to convert itself from the internal schema to an external schema @@ -77,4 +77,4 @@ trait KnoraReadV2[C <: KnoraReadV2[C]] { this: C => def toOntologySchema(targetSchema: ApiV2Schema): C } -``` \ No newline at end of file +``` diff --git a/docs/05-internals/design/api-v2/gravsearch.md b/docs/05-internals/design/api-v2/gravsearch.md index dc6728302d..f0dade566f 100644 --- a/docs/05-internals/design/api-v2/gravsearch.md +++ b/docs/05-internals/design/api-v2/gravsearch.md @@ -1,20 +1,20 @@ # Gravsearch Design diff --git a/docs/05-internals/design/api-v2/how-to-add-a-route.md b/docs/05-internals/design/api-v2/how-to-add-a-route.md index 6fcf0ef038..c428ca04a3 100644 --- a/docs/05-internals/design/api-v2/how-to-add-a-route.md +++ b/docs/05-internals/design/api-v2/how-to-add-a-route.md @@ -1,20 +1,20 @@ # How to Add an API v2 Route diff --git a/docs/05-internals/design/api-v2/index.md b/docs/05-internals/design/api-v2/index.md index 21e977b999..04c5376ed1 100644 --- a/docs/05-internals/design/api-v2/index.md +++ b/docs/05-internals/design/api-v2/index.md @@ -1,23 +1,23 @@ -# Knora API v2 Design +# DSP-API v2 Design - [API v2 Design Overview](overview.md) - [Ontology Schemas](ontology-schemas.md) diff --git a/docs/05-internals/design/api-v2/json-ld.md b/docs/05-internals/design/api-v2/json-ld.md index 6be24cd407..a7f11842ae 100644 --- a/docs/05-internals/design/api-v2/json-ld.md +++ b/docs/05-internals/design/api-v2/json-ld.md @@ -1,20 +1,20 @@ # JSON-LD Parsing and Formatting diff --git a/docs/05-internals/design/api-v2/ontology-management.md b/docs/05-internals/design/api-v2/ontology-management.md index 68c0e6f0c7..992330bd82 100644 --- a/docs/05-internals/design/api-v2/ontology-management.md +++ b/docs/05-internals/design/api-v2/ontology-management.md @@ -1,20 +1,20 @@ # Ontology Management diff --git a/docs/05-internals/design/api-v2/ontology-schemas.md b/docs/05-internals/design/api-v2/ontology-schemas.md index b2a355d0a9..abd82067d6 100644 --- a/docs/05-internals/design/api-v2/ontology-schemas.md +++ b/docs/05-internals/design/api-v2/ontology-schemas.md @@ -1,20 +1,20 @@ # Ontology Schemas @@ -42,23 +42,23 @@ package org.knora.webapi sealed trait OntologySchema /** - * The schema of Knora ontologies and entities that are used in the triplestore. + * The schema of DSP ontologies and entities that are used in the triplestore. */ case object InternalSchema extends OntologySchema /** - * The schema of Knora ontologies and entities that are used in API v2. + * The schema of DSP ontologies and entities that are used in API v2. */ sealed trait ApiV2Schema extends OntologySchema /** - * The simple schema for representing Knora ontologies and entities. This schema represents values as literals + * The simple schema for representing DSP ontologies and entities. This schema represents values as literals * when possible. */ case object ApiV2Simple extends ApiV2Schema /** - * The default (or complex) schema for representing Knora ontologies and entities. This + * The default (or complex) schema for representing DSP ontologies and entities. This * schema always represents values as objects. */ case object ApiV2Complex extends ApiV2Schema diff --git a/docs/05-internals/design/api-v2/overview.md b/docs/05-internals/design/api-v2/overview.md index 0d2fafd727..e2e470b919 100644 --- a/docs/05-internals/design/api-v2/overview.md +++ b/docs/05-internals/design/api-v2/overview.md @@ -1,27 +1,27 @@ # API v2 Design Overview ## General Principles - - Knora API v2 requests and responses are RDF documents. Any API v2 + - DSP-API v2 requests and responses are RDF documents. Any API v2 response can be returned as [JSON-LD](https://json-ld.org/spec/latest/json-ld/), [Turtle](https://www.w3.org/TR/turtle/), or [RDF/XML](https://www.w3.org/TR/rdf-syntax-grammar/). @@ -50,7 +50,7 @@ provided. objects. - A simple schema, which is suitable for reading data but not for editing it. The simple schema facilitates interoperability between - Knora ontologies and non-Knora ontologies, since it represents + DSP ontologies and non-DSP ontologies, since it represents values primarily as literals. Each schema has its own type IRIs, which are derived from the ones used @@ -187,7 +187,7 @@ There are in fact two instances of `StringFormatter`: available after Akka has started and has the API server's hostname (and can therefore provide `SmartIri` instances capable of parsing IRIs containing that hostname). This instance is used throughout the - Knora API server. + DSP-API server. - one returned by `StringFormatter.getInstanceForConstantOntologies`, which is available before Akka has started, and is used only by the hard-coded constant `knora-api` ontologies. diff --git a/docs/05-internals/design/api-v2/query-design.md b/docs/05-internals/design/api-v2/query-design.md index 8b5b4e2a4b..4aa85675f8 100644 --- a/docs/05-internals/design/api-v2/query-design.md +++ b/docs/05-internals/design/api-v2/query-design.md @@ -1,20 +1,20 @@ # SPARQL Query Design diff --git a/docs/05-internals/design/api-v2/sipi.md b/docs/05-internals/design/api-v2/sipi.md index 1adb3fd432..5bb135ce3d 100644 --- a/docs/05-internals/design/api-v2/sipi.md +++ b/docs/05-internals/design/api-v2/sipi.md @@ -1,20 +1,20 @@ # Knora and Sipi @@ -27,7 +27,7 @@ instructions on how to start Sipi with Knora. ## Lua Scripts -Knora API v2 uses custom Lua scripts to control Sipi. These scripts can be +DSP-API v2 uses custom Lua scripts to control Sipi. These scripts can be found in `sipi/scripts` in the Knora source tree. Each of these scripts expects a [JSON Web Token](https://jwt.io/) in the diff --git a/docs/05-internals/design/api-v2/smart-iris.md b/docs/05-internals/design/api-v2/smart-iris.md index 72b2cc2388..0e96deffe8 100644 --- a/docs/05-internals/design/api-v2/smart-iris.md +++ b/docs/05-internals/design/api-v2/smart-iris.md @@ -1,20 +1,20 @@ # Smart IRIs @@ -89,7 +89,7 @@ There are in fact two instances of `StringFormatter`: available after Akka has started and has the API server's hostname (and can therefore provide `SmartIri` instances capable of parsing IRIs containing that hostname). This instance is used throughout the - Knora API server. + DSP-API server. - one returned by `StringFormatter.getInstanceForConstantOntologies`, which is available before Akka has started, and is used only by the hard-coded constant `knora-api` ontologies (see diff --git a/docs/05-internals/design/api-v2/standoff.md b/docs/05-internals/design/api-v2/standoff.md index 48689d280c..a263495b4f 100644 --- a/docs/05-internals/design/api-v2/standoff.md +++ b/docs/05-internals/design/api-v2/standoff.md @@ -1,20 +1,20 @@ # Standoff Markup diff --git a/docs/05-internals/design/principles/authentication.md b/docs/05-internals/design/principles/authentication.md index 50ffcee09e..0a7c9fcd4f 100644 --- a/docs/05-internals/design/principles/authentication.md +++ b/docs/05-internals/design/principles/authentication.md @@ -1,20 +1,20 @@ # Authentication in Knora diff --git a/docs/05-internals/design/principles/consistency-checking.md b/docs/05-internals/design/principles/consistency-checking.md index f61447b3b5..97d2510dbd 100644 --- a/docs/05-internals/design/principles/consistency-checking.md +++ b/docs/05-internals/design/principles/consistency-checking.md @@ -1,20 +1,20 @@ # Consistency Checking @@ -27,7 +27,7 @@ as far as is practical, in a triplestore-independent way (see useful to enforce consistency constraints in the triplestore itself, for two reasons: -1. To prevent inconsistencies resulting from bugs in the Knora API +1. To prevent inconsistencies resulting from bugs in the DSP-API server. 2. To prevent users from inserting inconsistent data directly into the triplestore, bypassing Knora. @@ -43,7 +43,7 @@ for details): `knora-base:hasValue` or a `knora-base:hasLinkTo` (i.e. every property of a resource that points to a `knora-base:Value` or to another resource) is required have this constraint, because the - Knora API server relies on it to know what type of object to expect + DSP-API server relies on it to know what type of object to expect for the property. Use of `knora-base:subjectClassConstraint` is recommended but not required. 2. A class definition should use OWL cardinalities (see [OWL 2 Quick Reference Guide](https://www.w3.org/TR/owl2-quick-reference/)) diff --git a/docs/05-internals/design/principles/design-overview.md b/docs/05-internals/design/principles/design-overview.md index a4f092a2b4..78efa19215 100644 --- a/docs/05-internals/design/principles/design-overview.md +++ b/docs/05-internals/design/principles/design-overview.md @@ -1,23 +1,23 @@ -# Knora API Server Design Overview +# DSP-API Server Design Overview ## Introduction @@ -28,7 +28,7 @@ Knora's responsibilities include: data in a Knora repository. - Querying and updating the repository on behalf of clients. - Filtering query results according to the user's permissions. -- Transforming query results into Knora API responses. +- Transforming query results into DSP-API responses. - Ensuring that ontologies and data in the triplestore are consistent and conform to the requirements of the [knora-base](../../../02-knora-ontologies/knora-base.md) ontology. @@ -47,9 +47,9 @@ for other triplestores coming soon). Knora supports different versions of its API for working with humanities data: -- [Knora API v2](../../../03-apis/api-v2/index.md), a standards-based +- [DSP-API v2](../../../03-apis/api-v2/index.md), a standards-based API currently under development. -- [Knora API v1](../../../03-apis/api-v1/index.md), a stable, legacy API +- [DSP-API v1](../../../03-apis/api-v1/index.md), a stable, legacy API that focuses on maintaining compatibility with applications that used Knora's prototype software. @@ -58,7 +58,7 @@ administering Knora repositories. The Knora code base includes some functionality that is shared by these different APIs, as well as separate packages for each API. Internally, Knora APIs v1 and v2 both -use functionality in the admin API. Knora API v1 uses some functionality from +use functionality in the admin API. DSP-API v1 uses some functionality from API v2, but API v2 does not depend on API v1. ## Design Diagram @@ -253,7 +253,7 @@ because this simplifies the code considerably (using `tell` would require actors to maintain complex mutable state), with no apparent reduction in performance. -To manage asynchronous communication between actors, the Knora API +To manage asynchronous communication between actors, the DSP-API server uses Scala's `Future` monad extensively. See [Futures with Akka](futures-with-akka.md) for details. diff --git a/docs/05-internals/design/principles/feature-toggles.md b/docs/05-internals/design/principles/feature-toggles.md index e0b113c2f1..721c5a9f65 100644 --- a/docs/05-internals/design/principles/feature-toggles.md +++ b/docs/05-internals/design/principles/feature-toggles.md @@ -1,20 +1,20 @@ # Feature Toggles @@ -170,7 +170,7 @@ or only the specified version). ## Response Header -Knora API v2 and admin API responses contain the header +DSP-API v2 and admin API responses contain the header `X-Knora-Feature-Toggles`. It lists all configured toggles, in the same format as the corresponding request header. diff --git a/docs/05-internals/design/principles/futures-with-akka.md b/docs/05-internals/design/principles/futures-with-akka.md index 2cb4ea1ff5..d9782a15eb 100644 --- a/docs/05-internals/design/principles/futures-with-akka.md +++ b/docs/05-internals/design/principles/futures-with-akka.md @@ -1,20 +1,20 @@ # Futures with Akka diff --git a/docs/05-internals/design/principles/http-module.md b/docs/05-internals/design/principles/http-module.md index b9d1ea35a8..5ab299e8f7 100644 --- a/docs/05-internals/design/principles/http-module.md +++ b/docs/05-internals/design/principles/http-module.md @@ -1,20 +1,20 @@ # HTTP Module diff --git a/docs/05-internals/design/principles/index.md b/docs/05-internals/design/principles/index.md index 13186be959..c4c84e1ace 100644 --- a/docs/05-internals/design/principles/index.md +++ b/docs/05-internals/design/principles/index.md @@ -1,23 +1,23 @@ -# Knora Design Principles +# DSP-API Design Principles - [Design Overview](design-overview.md) - [Futures with Akka](futures-with-akka.md) diff --git a/docs/05-internals/design/principles/rdf-api.md b/docs/05-internals/design/principles/rdf-api.md index 7611ce990e..9da5b7a619 100644 --- a/docs/05-internals/design/principles/rdf-api.md +++ b/docs/05-internals/design/principles/rdf-api.md @@ -1,20 +1,20 @@ # RDF Processing API diff --git a/docs/05-internals/design/principles/store-module.md b/docs/05-internals/design/principles/store-module.md index 2a263c163c..27d8a09396 100644 --- a/docs/05-internals/design/principles/store-module.md +++ b/docs/05-internals/design/principles/store-module.md @@ -1,20 +1,20 @@ # Store Module @@ -204,4 +204,4 @@ As an example, to use it inside a test you could write something like: ## IIIF Servers Currently, only support for SIPI is implemented in -`org.knora.webapi.store.iiifSipiConnector`. \ No newline at end of file +`org.knora.webapi.store.iiifSipiConnector`. diff --git a/docs/05-internals/design/principles/triplestore-updates.md b/docs/05-internals/design/principles/triplestore-updates.md index 016821682f..4ceaeb9ec9 100644 --- a/docs/05-internals/design/principles/triplestore-updates.md +++ b/docs/05-internals/design/principles/triplestore-updates.md @@ -1,20 +1,20 @@ # Triplestore Updates diff --git a/docs/05-internals/development/building-and-running.md b/docs/05-internals/development/building-and-running.md index b2f1b69fe0..f839ba0d3e 100644 --- a/docs/05-internals/development/building-and-running.md +++ b/docs/05-internals/development/building-and-running.md @@ -1,20 +1,20 @@ diff --git a/docs/05-internals/development/docker-cheat-sheet.md b/docs/05-internals/development/docker-cheat-sheet.md index 587293dff9..da5c352781 100644 --- a/docs/05-internals/development/docker-cheat-sheet.md +++ b/docs/05-internals/development/docker-cheat-sheet.md @@ -1,20 +1,20 @@ # Docker Cheat Sheet diff --git a/docs/05-internals/development/docker-compose.md b/docs/05-internals/development/docker-compose.md index 061a1d0e34..1e8ff14ebd 100644 --- a/docs/05-internals/development/docker-compose.md +++ b/docs/05-internals/development/docker-compose.md @@ -1,20 +1,20 @@ # Starting the Knora Stack inside Docker Container @@ -42,4 +42,4 @@ To run the whole stack: $ docker-compose up ``` -For additional information please see the [Docker Compose documentation](https://docs.docker.com/compose/) \ No newline at end of file +For additional information please see the [Docker Compose documentation](https://docs.docker.com/compose/) diff --git a/docs/05-internals/development/generating-client-test-data.md b/docs/05-internals/development/generating-client-test-data.md index 2f014c1d68..44eb0456c2 100644 --- a/docs/05-internals/development/generating-client-test-data.md +++ b/docs/05-internals/development/generating-client-test-data.md @@ -1,20 +1,20 @@ # Generating Client Test Data diff --git a/docs/05-internals/development/graphdb.md b/docs/05-internals/development/graphdb.md index e967de1fbb..5b95377805 100644 --- a/docs/05-internals/development/graphdb.md +++ b/docs/05-internals/development/graphdb.md @@ -1,20 +1,20 @@ # Starting GraphDB diff --git a/docs/05-internals/development/index.md b/docs/05-internals/development/index.md index f94fd5d714..a1421bf2e6 100644 --- a/docs/05-internals/development/index.md +++ b/docs/05-internals/development/index.md @@ -1,20 +1,20 @@ # Development diff --git a/docs/05-internals/development/intellij-config.md b/docs/05-internals/development/intellij-config.md index defe046e32..fd60c4005b 100644 --- a/docs/05-internals/development/intellij-config.md +++ b/docs/05-internals/development/intellij-config.md @@ -1,20 +1,20 @@ # Setup IntelliJ for development of Knora @@ -126,7 +126,7 @@ button: ![screenshot 'VisualVM sampler'](figures/visualvm-sampler.png) -Now run some Knora API operations that you're interested in profiling, +Now run some DSP-API operations that you're interested in profiling, preferably several times to allow the sampler to collect enough data. Then click on the "Snapshot" button: diff --git a/docs/05-internals/development/monitoring.md b/docs/05-internals/development/monitoring.md index 402c0f72f9..d917410606 100644 --- a/docs/05-internals/development/monitoring.md +++ b/docs/05-internals/development/monitoring.md @@ -1,20 +1,20 @@ # Monitoring Knora diff --git a/docs/05-internals/development/overview.md b/docs/05-internals/development/overview.md index 2371f954d1..0cb3ac92f9 100644 --- a/docs/05-internals/development/overview.md +++ b/docs/05-internals/development/overview.md @@ -1,51 +1,51 @@ # Overview -Developing for Knora requires a complete local +Developing for DSP-API requires a complete local installation of Knora. The different parts are: -1. The cloned [Knora](https://github.com/dasch-swiss/knora-api) Github - repository -2. One of the supplied triplestores in the Knora Github repository +1. The cloned [DSP-API](https://github.com/dasch-swiss/dsp-api) Github + repository +1. One of the supplied triplestores in the DSP-API Github repository (GraphDB-SE 8 or Fuseki 3). -3. Sipi by building from +1. Sipi by building from [source](https://github.com/dasch-swiss/sipi) or using the docker [image](https://hub.docker.com/r/daschswiss/sipi/) ## Knora Github Repository - $ git clone https://github.com/dhlab-basel/Knora + $ git clone https://github.com/dasch-swiss/dsp-api ## Triplestore A number of triplestore implementations are available, including [free software](http://www.gnu.org/philosophy/free-sw.en.html) as well as -proprietary options. Knora is designed to work with any +proprietary options. DSP-API is designed to work with any standards-compliant triplestore. It is primarily tested with [Ontotext GraphDB](http://ontotext.com/products/graphdb/), a high-performance, proprietary triplestore. We recommend GraphDB Standard Edition, but GraphDB Free (which is proprietary but available free of charge) also works. -Knora includes support for [Apache Jena](https://jena.apache.org/), +DSP-API includes support for [Apache Jena](https://jena.apache.org/), which is [free software](http://www.gnu.org/philosophy/free-sw.en.html), but use of Jena is deprecated, and support for it will probably be removed in the future. @@ -120,7 +120,7 @@ $ docker run --name sipi \ ## Redis Server -The Knora-API server uses Redis for caching. +The DSP-API server uses Redis for caching. On macOS you can install Redis through [Homebrew](https://brew.sh): @@ -129,4 +129,4 @@ $ brew install redis ``` If you don't want to use Redis, you can disable caching in `application.conf` -via the `app.use-redis-cache` key, by setting it to `false`. \ No newline at end of file +via the `app.use-redis-cache` key, by setting it to `false`. diff --git a/docs/05-internals/development/profiling.md b/docs/05-internals/development/profiling.md index 21a9a226f9..51e80d6c7a 100644 --- a/docs/05-internals/development/profiling.md +++ b/docs/05-internals/development/profiling.md @@ -1,20 +1,20 @@ # Profiling Knora @@ -34,4 +34,4 @@ $ ./bin/webapi -J-agentpath:/Applications/YourKit-Java-Profiler-2018.04.app/Cont ``` -Now start the YourKit Profiler and connect to the `Main` process. \ No newline at end of file +Now start the YourKit Profiler and connect to the `Main` process. diff --git a/docs/05-internals/development/testing.md b/docs/05-internals/development/testing.md index 2a248beb03..b390181681 100644 --- a/docs/05-internals/development/testing.md +++ b/docs/05-internals/development/testing.md @@ -1,20 +1,20 @@ # Testing @@ -51,4 +51,4 @@ The only difference between Integration and Unit tests is the location where they are stored and the way how they are called: 1) Store tests inside the `src/it` folder hierarchy. -2) Call the tests from the terminal: `make test-it` \ No newline at end of file +2) Call the tests from the terminal: `make test-it` diff --git a/docs/05-internals/development/updating-repositories.md b/docs/05-internals/development/updating-repositories.md index d3c40350a2..40cade4087 100644 --- a/docs/05-internals/development/updating-repositories.md +++ b/docs/05-internals/development/updating-repositories.md @@ -1,20 +1,20 @@ # Updating Repositories @@ -54,7 +54,7 @@ it to `org.knora.webapi.store.triplestore.upgrade.RepositoryUpdater`. 4. Read the N-Quads file into an `RdfModel`. 5. Update the `RdfModel` by running the necessary transformations, and replacing the - built-in Knora ontologies with the current ones. + built-in DSP ontologies with the current ones. 6. Save the `RdfModel` to a new N-Quads file. diff --git a/docs/07-sipi/index.md b/docs/07-sipi/index.md index 0b0177fd40..ec8a4b4857 100644 --- a/docs/07-sipi/index.md +++ b/docs/07-sipi/index.md @@ -1,20 +1,20 @@ # The Sipi Media Server diff --git a/docs/07-sipi/setup-sipi-for-knora.md b/docs/07-sipi/setup-sipi-for-knora.md index 4bfef4489e..462c8a8082 100644 --- a/docs/07-sipi/setup-sipi-for-knora.md +++ b/docs/07-sipi/setup-sipi-for-knora.md @@ -1,20 +1,20 @@ # Setting Up Sipi for Knora diff --git a/docs/07-sipi/sipi-and-knora.md b/docs/07-sipi/sipi-and-knora.md index 2e0d435a6b..f808769a40 100644 --- a/docs/07-sipi/sipi-and-knora.md +++ b/docs/07-sipi/sipi-and-knora.md @@ -1,20 +1,20 @@ # Interaction Between Sipi and Knora @@ -42,7 +42,7 @@ Knora. The implementation of this procedure is described in [Knora and Sipi](../05-internals/design/api-v2/sipi.md). Instructions for the client are given in [Creating File Values](../03-apis/api-v2/editing-values.md#creating-file-values) -(for Knora API v2) and in +(for DSP-API v2) and in [Adding Resources with Image Files](../03-apis/api-v1/adding-resources.md#adding-resources-with-image-files) (for API v1). @@ -50,7 +50,7 @@ for the client are given in ### File URLs in API v2 -In Knora API v2, image file URLs are provided in [IIIF](https://iiif.io/) format. In the simple +In DSP-API v2, image file URLs are provided in [IIIF](https://iiif.io/) format. In the simple [ontology schema](../03-apis/api-v2/introduction.md#api-schema), a file value is simply a IIIF URL that can be used to retrieve the file from Sipi. In the complex schema, it is a `StillImageFileValue` with additional properties that the client can use to construct @@ -111,5 +111,5 @@ browser (using either `V1` or `V2` authentication route), a session cookie conta the user is stored in the user's client. This session cookie is then read by Sipi and used to ask Knora for the user's image permissions. -For the session cookie to be sent to Sipi, both the Knora API and Sipi endpoints need to +For the session cookie to be sent to Sipi, both the DSP-API and Sipi endpoints need to be under the same domain, e.g., `api.example.com` and `iiif.example.com`. diff --git a/docs/08-lucene/index.md b/docs/08-lucene/index.md index be0227ac95..f107b17589 100644 --- a/docs/08-lucene/index.md +++ b/docs/08-lucene/index.md @@ -1,20 +1,20 @@ # Lucene diff --git a/docs/CNAME b/docs/CNAME index f96a04d57e..cd626abc86 100644 --- a/docs/CNAME +++ b/docs/CNAME @@ -1 +1 @@ -docs.knora.org \ No newline at end of file +docs-api.dasch.swiss diff --git a/docs/Makefile b/docs/Makefile index 6616c2ecf9..68e27337d5 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -26,14 +26,14 @@ clean: ## to clean .PHONY: jsonformat jsonformat: ## to make a documentation of the json request and response format - $(TYPEDOC) --out $(FORMATDOCDIRV1) --exclude **/sampleRequests/* --readme none --name "Knora API V1 Format Documentation" --module commonjs $(FORMATSRCDIRV1) - $(TYPEDOC) --out $(FORMATDOCDIRV2) --exclude **/$(FORMATSRCDIRV2)/samples/* --readme none --name "Knora API V2 JSON-LD Format Documentation" --module commonjs $(FORMATSRCDIRV2) + $(TYPEDOC) --out $(FORMATDOCDIRV1) --exclude **/sampleRequests/* --readme none --name "DSP API V1 Format Documentation" --module commonjs $(FORMATSRCDIRV1) + $(TYPEDOC) --out $(FORMATDOCDIRV2) --exclude **/$(FORMATSRCDIRV2)/samples/* --readme none --name "DSP API V2 JSON-LD Format Documentation" --module commonjs $(FORMATSRCDIRV2) @echo "Format Docs Build finished. The index page for V1 is $(FORMATDOCDIR)/index.html, for V2 $(FORMATDOCDIRV2)/index.html" .PHONY: jsonformattest jsonformattest: ## to make a documentation of the json request and response format - $(TYPEDOC) --out $(FORMATDOCDIRV1) --readme none --name "Knora API V1 Format Documentation" --module commonjs $(FORMATSRCDIRV1) - $(TYPEDOC) --out $(FORMATDOCDIRV2) --readme none --name "Knora API V2 JSON-LD Format Documentation" --module commonjs $(FORMATSRCDIRV2) + $(TYPEDOC) --out $(FORMATDOCDIRV1) --readme none --name "DSP API V1 Format Documentation" --module commonjs $(FORMATSRCDIRV1) + $(TYPEDOC) --out $(FORMATDOCDIRV2) --readme none --name "DSP API V2 JSON-LD Format Documentation" --module commonjs $(FORMATSRCDIRV2) @echo "Sample requests test finished." .PHONY: graphvizfigures diff --git a/docs/Readme.md b/docs/Readme.md index 49ef737c98..2d9e3df4e8 100644 --- a/docs/Readme.md +++ b/docs/Readme.md @@ -1,15 +1,15 @@ -# Knora Documentation +# DSP-API Documentation ## MkDocs Documentation -This folder contains the sources to the Knora documentation website published -under [http://docs.knora.org](http://docs.knora.org). +This folder contains the sources to the DSP-API documentation website published +under The `src` folder contains the following documentation sources: -- `src/api-v1`: The Knora JSON API V1 Request and Response Format documentation. Source can be found in `salsah1/src/typescript_interfaces` -- `src/api-v2`: The Knora JSON-LD API V2 Request and Response Format documentation. -- `src/api-admin`: The Knora JSON Admin API Request and Response format Swagger-based documentation. +- `src/api-v1`: The DSP-API V1 (JSON) Request and Response Format documentation. Source can be found in `salsah1/src/typescript_interfaces` +- `src/api-v2`: The DSP-API V2 (JSON-LD) Request and Response Format documentation. +- `src/api-admin`: The DSP-API Admin (JSON) Request and Response format Swagger-based documentation. All the different documentations are build by invoking the following make commands from the project root directory: @@ -33,7 +33,7 @@ This command will build all documentation and publish it to the `gh-pages` branc On Linux, use your distribution's package manager. -1. The Knora JSON API V1 / V2 Request and Response Format documentation is +1. The DSP-API V1 / V2 Request and Response Format documentation is formally described using typescript interfaces. To create the documentation from these interfaces, we use `typedoc`. diff --git a/docs/assets/images/dasch-favicon.ico b/docs/assets/icons/dasch-favicon.ico similarity index 100% rename from docs/assets/images/dasch-favicon.ico rename to docs/assets/icons/dasch-favicon.ico diff --git a/docs/assets/images/dasch-icon-white.svg b/docs/assets/icons/dasch-icon-white.svg similarity index 100% rename from docs/assets/images/dasch-icon-white.svg rename to docs/assets/icons/dasch-icon-white.svg diff --git a/docs/assets/images/favicon.png b/docs/assets/icons/favicon.png similarity index 100% rename from docs/assets/images/favicon.png rename to docs/assets/icons/favicon.png diff --git a/docs/assets/images/knora-favicon.ico b/docs/assets/images/knora-favicon.ico deleted file mode 100755 index b71c253ce9..0000000000 Binary files a/docs/assets/images/knora-favicon.ico and /dev/null differ diff --git a/docs/assets/images/knora-logo-kurz.png b/docs/assets/images/knora-logo-kurz.png deleted file mode 100755 index e06f6ca949..0000000000 Binary files a/docs/assets/images/knora-logo-kurz.png and /dev/null differ diff --git a/docs/faq/index.md b/docs/faq/index.md index 086f14179c..e300e09ff6 100644 --- a/docs/faq/index.md +++ b/docs/faq/index.md @@ -1,20 +1,20 @@ # Frequently Asked Questions @@ -62,7 +62,7 @@ affect other ontologies or data that are based on it. See [Shared Ontologies](../02-knora-ontologies/introduction.md#shared-ontologies) for details. There will be a standardisation process for shared ontologies -(issue [#523](https://github.com/dasch-swiss/knora-api/issues/523)). +(issue [#523](https://github.com/dasch-swiss/dsp-api/issues/523)). ### Why doesn't Knora use `rdfs:domain` and `rdfs:range` for consistency checking? diff --git a/docs/index.md b/docs/index.md index 62d88e0f92..f6ba7bd222 100644 --- a/docs/index.md +++ b/docs/index.md @@ -1,27 +1,27 @@ * [Introduction](01-introduction/index.md) -* [Knora Ontologies](02-knora-ontologies/index.md) -* [Knora APIs](03-apis/index.md) +* [DSP Ontologies](02-knora-ontologies/index.md) +* [DSP APIs](03-apis/index.md) * [Publishing and Deployment](04-publishing-deployment/index.md) -* [Knora Internals](05-internals/design/principles/index.md) +* [DSP-API Internals](05-internals/design/principles/index.md) * [Sipi](07-sipi/index.md) * [Lucene](08-lucene/index.md) * [Frequently Asked Questions](faq/index.md) diff --git a/docs/requirements.txt b/docs/requirements.txt index 2bac72f59d..7d42063de6 100644 --- a/docs/requirements.txt +++ b/docs/requirements.txt @@ -1,2 +1,4 @@ mkdocs==1.1.2 mkdocs-material==6.0.1 +mkdocs-include-markdown-plugin==2.7.1 +mkdocs-git-revision-date-plugin==0.3.1 diff --git a/docs/src/api-v1/addValueFormats.ts b/docs/src/api-v1/addValueFormats.ts index ae13b8cf58..25dff6349e 100644 --- a/docs/src/api-v1/addValueFormats.ts +++ b/docs/src/api-v1/addValueFormats.ts @@ -1,20 +1,20 @@ /* * Copyright © 2015-2021 the contributors (see Contributors.md). * - * This file is part of Knora. + * This file is part of DSP — DaSCH Service Platform. * - * Knora is free software: you can redistribute it and/or modify + * DSP is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as published * by the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * - * Knora is distributed in the hope that it will be useful, + * DSP is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public - * License along with Knora. If not, see . + * License along with DSP. If not, see . */ import {basicMessageComponents} from "./basicMessageComponents" @@ -171,4 +171,4 @@ export module addValueFormats { } -} \ No newline at end of file +} diff --git a/docs/src/api-v1/basicMessageComponents.ts b/docs/src/api-v1/basicMessageComponents.ts index f711f3b50e..59236ea5e0 100644 --- a/docs/src/api-v1/basicMessageComponents.ts +++ b/docs/src/api-v1/basicMessageComponents.ts @@ -1,20 +1,20 @@ /* * Copyright © 2015-2021 the contributors (see Contributors.md). * - * This file is part of Knora. + * This file is part of DSP — DaSCH Service Platform. * - * Knora is free software: you can redistribute it and/or modify + * DSP is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as published * by the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * - * Knora is distributed in the hope that it will be useful, + * DSP is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public - * License along with Knora. If not, see . + * License along with DSP. If not, see . */ /** @@ -118,7 +118,7 @@ export module basicMessageComponents { export type KnoraAccess = string; /** - * Basic members of the Knora API V1 response format. + * Basic members of the DSP-API V1 response format. */ export interface basicResponse { /** diff --git a/docs/src/api-v1/changeValueFormats.ts b/docs/src/api-v1/changeValueFormats.ts index 6c41a3e4b5..b6b205875a 100644 --- a/docs/src/api-v1/changeValueFormats.ts +++ b/docs/src/api-v1/changeValueFormats.ts @@ -1,20 +1,20 @@ /* * Copyright © 2015-2021 the contributors (see Contributors.md). * - * This file is part of Knora. + * This file is part of DSP — DaSCH Service Platform. * - * Knora is free software: you can redistribute it and/or modify + * DSP is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as published * by the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * - * Knora is distributed in the hope that it will be useful, + * DSP is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public - * License along with Knora. If not, see . + * License along with DSP. If not, see . */ import {basicMessageComponents} from "./basicMessageComponents" @@ -206,4 +206,4 @@ export module changeValueFormats { } -} \ No newline at end of file +} diff --git a/docs/src/api-v1/createResourceFormats.ts b/docs/src/api-v1/createResourceFormats.ts index 07dfd62b03..584b1b6a3f 100644 --- a/docs/src/api-v1/createResourceFormats.ts +++ b/docs/src/api-v1/createResourceFormats.ts @@ -1,20 +1,20 @@ /* * Copyright © 2015-2021 the contributors (see Contributors.md). * - * This file is part of Knora. + * This file is part of DSP — DaSCH Service Platform. * - * Knora is free software: you can redistribute it and/or modify + * DSP is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as published * by the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * - * Knora is distributed in the hope that it will be useful, + * DSP is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public - * License along with Knora. If not, see . + * License along with DSP. If not, see . */ import {basicMessageComponents} from "./basicMessageComponents" @@ -237,4 +237,4 @@ export module createResourceFormats { label: string; } -} \ No newline at end of file +} diff --git a/docs/src/api-v1/deleteResponseFormats.ts b/docs/src/api-v1/deleteResponseFormats.ts index 08bcea50b9..141847b866 100644 --- a/docs/src/api-v1/deleteResponseFormats.ts +++ b/docs/src/api-v1/deleteResponseFormats.ts @@ -1,20 +1,20 @@ /* * Copyright © 2015-2021 the contributors (see Contributors.md). * - * This file is part of Knora. + * This file is part of DSP — DaSCH Service Platform. * - * Knora is free software: you can redistribute it and/or modify + * DSP is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as published * by the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * - * Knora is distributed in the hope that it will be useful, + * DSP is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public - * License along with Knora. If not, see . + * License along with DSP. If not, see . */ import { basicMessageComponents } from "./basicMessageComponents" @@ -54,4 +54,4 @@ export module deleteResponseFormats { } -} \ No newline at end of file +} diff --git a/docs/src/api-v1/graphDataResponseFormats.ts b/docs/src/api-v1/graphDataResponseFormats.ts index ea3415108d..d500bbd53c 100644 --- a/docs/src/api-v1/graphDataResponseFormats.ts +++ b/docs/src/api-v1/graphDataResponseFormats.ts @@ -1,20 +1,20 @@ /* * Copyright © 2015-2021 the contributors (see Contributors.md). * - * This file is part of Knora. + * This file is part of DSP — DaSCH Service Platform. * - * Knora is free software: you can redistribute it and/or modify + * DSP is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as published * by the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * - * Knora is distributed in the hope that it will be useful, + * DSP is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public - * License along with Knora. If not, see . + * License along with DSP. If not, see . */ import { basicMessageComponents } from "./basicMessageComponents" diff --git a/docs/src/api-v1/groupFormats.ts b/docs/src/api-v1/groupFormats.ts index 33bae138e7..175ee4aaee 100644 --- a/docs/src/api-v1/groupFormats.ts +++ b/docs/src/api-v1/groupFormats.ts @@ -1,20 +1,20 @@ /* * Copyright © 2015-2021 the contributors (see Contributors.md). * - * This file is part of Knora. + * This file is part of DSP — DaSCH Service Platform. * - * Knora is free software: you can redistribute it and/or modify + * DSP is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as published * by the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * - * Knora is distributed in the hope that it will be useful, + * DSP is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public - * License along with Knora. If not, see . + * License along with DSP. If not, see . */ import {basicMessageComponents} from "./basicMessageComponents" @@ -169,4 +169,4 @@ export module groupFormats { */ selfjoin: boolean; } -} \ No newline at end of file +} diff --git a/docs/src/api-v1/hierarchicalListResponseFormats.ts b/docs/src/api-v1/hierarchicalListResponseFormats.ts index 877b6523bf..be2225ef8a 100644 --- a/docs/src/api-v1/hierarchicalListResponseFormats.ts +++ b/docs/src/api-v1/hierarchicalListResponseFormats.ts @@ -1,20 +1,20 @@ /* * Copyright © 2015-2021 the contributors (see Contributors.md). * - * This file is part of Knora. + * This file is part of DSP — DaSCH Service Platform. * - * Knora is free software: you can redistribute it and/or modify + * DSP is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as published * by the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * - * Knora is distributed in the hope that it will be useful, + * DSP is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public - * License along with Knora. If not, see . + * License along with DSP. If not, see . */ import {basicMessageComponents} from "./basicMessageComponents" @@ -111,4 +111,4 @@ export module hierarchicalListResponseFormats { } -} \ No newline at end of file +} diff --git a/docs/src/api-v1/mappingFormats.ts b/docs/src/api-v1/mappingFormats.ts index 6416b825f9..6f36dbf988 100644 --- a/docs/src/api-v1/mappingFormats.ts +++ b/docs/src/api-v1/mappingFormats.ts @@ -1,20 +1,20 @@ /* * Copyright © 2015-2021 the contributors (see Contributors.md). * - * This file is part of Knora. + * This file is part of DSP — DaSCH Service Platform. * - * Knora is free software: you can redistribute it and/or modify + * DSP is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as published * by the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * - * Knora is distributed in the hope that it will be useful, + * DSP is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public - * License along with Knora. If not, see . + * License along with DSP. If not, see . */ import {basicMessageComponents} from "./basicMessageComponents" @@ -67,4 +67,4 @@ export module mappingFormats { } -} \ No newline at end of file +} diff --git a/docs/src/api-v1/permissionFormats.ts b/docs/src/api-v1/permissionFormats.ts index 900645aab4..0cc2a9759f 100644 --- a/docs/src/api-v1/permissionFormats.ts +++ b/docs/src/api-v1/permissionFormats.ts @@ -1,20 +1,20 @@ /* * Copyright © 2015-2021 the contributors (see Contributors.md). * - * This file is part of Knora. + * This file is part of DSP — DaSCH Service Platform. * - * Knora is free software: you can redistribute it and/or modify + * DSP is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as published * by the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * - * Knora is distributed in the hope that it will be useful, + * DSP is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public - * License along with Knora. If not, see . + * License along with DSP. If not, see . */ import {basicMessageComponents} from "./basicMessageComponents"; @@ -172,4 +172,4 @@ export module permissionFormats { -} \ No newline at end of file +} diff --git a/docs/src/api-v1/projectFormats.ts b/docs/src/api-v1/projectFormats.ts index 034b828ca5..c387e21b40 100644 --- a/docs/src/api-v1/projectFormats.ts +++ b/docs/src/api-v1/projectFormats.ts @@ -1,20 +1,20 @@ /* * Copyright © 2015-2021 the contributors (see Contributors.md). * - * This file is part of Knora. + * This file is part of DSP — DaSCH Service Platform. * - * Knora is free software: you can redistribute it and/or modify + * DSP is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as published * by the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * - * Knora is distributed in the hope that it will be useful, + * DSP is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public - * License along with Knora. If not, see . + * License along with DSP. If not, see . */ import {basicMessageComponents} from "./basicMessageComponents"; @@ -263,4 +263,4 @@ export module projectFormats { } -} \ No newline at end of file +} diff --git a/docs/src/api-v1/resourceResponseFormats.ts b/docs/src/api-v1/resourceResponseFormats.ts index 85f9ea5ded..24436414d8 100644 --- a/docs/src/api-v1/resourceResponseFormats.ts +++ b/docs/src/api-v1/resourceResponseFormats.ts @@ -1,20 +1,20 @@ /* * Copyright © 2015-2021 the contributors (see Contributors.md). * - * This file is part of Knora. + * This file is part of DSP — DaSCH Service Platform. * - * Knora is free software: you can redistribute it and/or modify + * DSP is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as published * by the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * - * Knora is distributed in the hope that it will be useful, + * DSP is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public - * License along with Knora. If not, see . + * License along with DSP. If not, see . */ import {basicMessageComponents} from "./basicMessageComponents" @@ -626,7 +626,7 @@ export module resourceResponseFormats { } /** - * Represents the Knora API V1 response to a resource type request for a vocabulary. + * Represents the DSP-API V1 response to a resource type request for a vocabulary. * * HTTP GET to http://host/v1/resourcetypes?vocabulary=vocabularyIRI */ @@ -639,7 +639,7 @@ export module resourceResponseFormats { } /** - * Represents the Knora API V1 response to a resource type request. + * Represents the DSP-API V1 response to a resource type request. * * HTTP GET to http://host/v1/resourcetypes/resourceClassIRI */ @@ -652,7 +652,7 @@ export module resourceResponseFormats { } /** - * Represents the Knora API V1 response to a properties request for a resource. + * Represents the DSP-API V1 response to a properties request for a resource. * This response just returns a resource's properties. * * HTTP GET to http://host/v1/properties/resourceIRI @@ -669,7 +669,7 @@ export module resourceResponseFormats { } /** - * Represents the Knora API V1 response to a full resource request. + * Represents the DSP-API V1 response to a full resource request. * * HTTP GET to http://host/v1/resources/resourceIRI */ @@ -704,7 +704,7 @@ export module resourceResponseFormats { } /** - * Represents the Knora API V1 response to a resource info request (reqtype=info). + * Represents the DSP-API V1 response to a resource info request (reqtype=info). * * HTTP GET to http://host/v1/resources/resourceIRI?reqtype=info */ @@ -722,7 +722,7 @@ export module resourceResponseFormats { } /** - * Represents the Knora API V1 response to a resource rights request (reqtype=rights). + * Represents the DSP-API V1 response to a resource rights request (reqtype=rights). * * HTTP GET to http://host/v1/resources/resourceIRI?reqtype=rights */ @@ -735,7 +735,7 @@ export module resourceResponseFormats { } /** - * Represents the Knora API V1 response to a context request (reqtype=context) with or without resinfo (resinfo=true). + * Represents the DSP-API V1 response to a context request (reqtype=context) with or without resinfo (resinfo=true). * * HTTP GET to http://host/v1/resources/resourceIRI?reqtype=context[&resinfo=true] */ diff --git a/docs/src/api-v1/sampleRequests/sampleAddValues.ts b/docs/src/api-v1/sampleRequests/sampleAddValues.ts index 9fe34239b2..c8537ff131 100644 --- a/docs/src/api-v1/sampleRequests/sampleAddValues.ts +++ b/docs/src/api-v1/sampleRequests/sampleAddValues.ts @@ -1,20 +1,20 @@ /* * Copyright © 2015-2021 the contributors (see Contributors.md). * - * This file is part of Knora. + * This file is part of DSP — DaSCH Service Platform. * - * Knora is free software: you can redistribute it and/or modify + * DSP is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as published * by the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * - * Knora is distributed in the hope that it will be useful, + * DSP is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public - * License along with Knora. If not, see . + * License along with DSP. If not, see . */ import { addValueFormats } from "../addValueFormats" @@ -30,4 +30,4 @@ let addSimpletextValueResponse: addValueFormats.addValueResponse = {"id":"http:/ let addRichtextValueRequest: addValueFormats.addRichtextValueRequest = {"richtext_value":{"xml":"\nTest
text", "mapping_id": "http://rdfh.ch/standoff/mappings/StandardMapping"},"res_id":"http://rdfh.ch/a-thing","prop":"http://www.knora.org/ontology/0001/anything#hasText","project_id":"http://rdfh.ch/projects/anything"}; -let addRichtextValueResponse: addValueFormats.addValueResponse = {"id":"http://rdfh.ch/a-thing/values/lfwoLx9LT7-JnA_wKjeZYg","status":0,"comment":null,"rights":8,"value":{"xml":"\nTest
text", "mapping_id": "http://rdfh.ch/standoff/mappings/StandardMapping"}}; \ No newline at end of file +let addRichtextValueResponse: addValueFormats.addValueResponse = {"id":"http://rdfh.ch/a-thing/values/lfwoLx9LT7-JnA_wKjeZYg","status":0,"comment":null,"rights":8,"value":{"xml":"\nTest
text", "mapping_id": "http://rdfh.ch/standoff/mappings/StandardMapping"}}; diff --git a/docs/src/api-v1/sampleRequests/sampleChangeValues.ts b/docs/src/api-v1/sampleRequests/sampleChangeValues.ts index dc1253cfb1..4289cca05c 100644 --- a/docs/src/api-v1/sampleRequests/sampleChangeValues.ts +++ b/docs/src/api-v1/sampleRequests/sampleChangeValues.ts @@ -1,20 +1,20 @@ /* * Copyright © 2015-2021 the contributors (see Contributors.md). * - * This file is part of Knora. + * This file is part of DSP — DaSCH Service Platform. * - * Knora is free software: you can redistribute it and/or modify + * DSP is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as published * by the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * - * Knora is distributed in the hope that it will be useful, + * DSP is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public - * License along with Knora. If not, see . + * License along with DSP. If not, see . */ import { changeValueFormats } from "../changeValueFormats" @@ -29,4 +29,4 @@ let changeFileValueRequest: changeValueFormats.changeFileValueRequest = { let changeFileValueResponse: changeValueFormats.changeFileValueResponse = {"locations":[{"duration":0,"nx":128,"path":"http://localhost:1024/knora/5XTEI1z10A2-D8ojQHrMiUz.jpg/full/max/0/default.jpg","ny":72,"fps":0,"format_name":"JPEG","origname":"2016-06-26+12.26.45.jpg","protocol":"file"},{"duration":0,"nx":3264,"path":"http://localhost:1024/knora/5XTEI1z10A2-D8ojQHrMiUz.jpx/full/3264,1836/0/default.jpg","ny":1836,"fps":0,"format_name":"JPEG2000","origname":"2016-06-26+12.26.45.jpg","protocol":"file"}],"status":0}; -let changeValueComment: changeValueFormats.changeValueCommentRequest = {"project_id":"http://rdfh.ch/projects/77275339","comment":"dumm"}; \ No newline at end of file +let changeValueComment: changeValueFormats.changeValueCommentRequest = {"project_id":"http://rdfh.ch/projects/77275339","comment":"dumm"}; diff --git a/docs/src/api-v1/sampleRequests/sampleCreateResources.ts b/docs/src/api-v1/sampleRequests/sampleCreateResources.ts index 2c2ef04c1e..f390b44d74 100644 --- a/docs/src/api-v1/sampleRequests/sampleCreateResources.ts +++ b/docs/src/api-v1/sampleRequests/sampleCreateResources.ts @@ -1,20 +1,20 @@ /* * Copyright © 2015-2021 the contributors (see Contributors.md). * - * This file is part of Knora. + * This file is part of DSP — DaSCH Service Platform. * - * Knora is free software: you can redistribute it and/or modify + * DSP is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as published * by the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * - * Knora is distributed in the hope that it will be useful, + * DSP is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public - * License along with Knora. If not, see . + * License along with DSP. If not, see . */ import { createResourceFormats } from "../createResourceFormats" @@ -59,4 +59,4 @@ let createResourceResponse2: createResourceFormats.createResourceResponse = {"re let createResourceWithRepresentationResponse: createResourceFormats.createResourceResponse = {"res_id":"http://rdfh.ch/Ox5oO8cLQiq6uSW7xjf2Ug","results":{"http://www.knora.org/ontology/knora-base#hasStillImageFileValue":[{"value":{"dateval1":null,"ival":null,"dateprecision1":null,"textval":{"string":"schweizer.jpg"},"person_id":{"string":"http://rdfh.ch/users/91e19f1e01"},"property_id":{"string":"http://www.knora.org/ontology/knora-base#hasStillImageFileValue"},"calendar":null,"timeval2":null,"dval":null,"dateval2":null,"order":{"integer":1},"resource_id":{"string":"http://rdfh.ch/Ox5oO8cLQiq6uSW7xjf2Ug"},"timeval1":null,"dateprecision2":null},"id":"http://rdfh.ch/Ox5oO8cLQiq6uSW7xjf2Ug/values/k7YTAUxXS9WIHlWjZxT6mA"},{"value":{"dateval1":null,"ival":null,"dateprecision1":null,"textval":{"string":"schweizer.jpg"},"person_id":{"string":"http://rdfh.ch/users/91e19f1e01"},"property_id":{"string":"http://www.knora.org/ontology/knora-base#hasStillImageFileValue"},"calendar":null,"timeval2":null,"dval":null,"dateval2":null,"order":{"integer":1},"resource_id":{"string":"http://rdfh.ch/Ox5oO8cLQiq6uSW7xjf2Ug"},"timeval1":null,"dateprecision2":null},"id":"http://rdfh.ch/Ox5oO8cLQiq6uSW7xjf2Ug/values/9Y_IIgPLRT-yGDUhbH433w"}]},"status":0}; -let changeResourceLabelResponse: changeResourceLabelResponse = {"res_id":"http://rdfh.ch/c5058f3a","label":"Mein Zeitglöckleinnnn","status":0}; \ No newline at end of file +let changeResourceLabelResponse: changeResourceLabelResponse = {"res_id":"http://rdfh.ch/c5058f3a","label":"Mein Zeitglöckleinnnn","status":0}; diff --git a/docs/src/api-v1/sampleRequests/sampleDeleteResponses.ts b/docs/src/api-v1/sampleRequests/sampleDeleteResponses.ts index e8276ccd85..58102a8eca 100644 --- a/docs/src/api-v1/sampleRequests/sampleDeleteResponses.ts +++ b/docs/src/api-v1/sampleRequests/sampleDeleteResponses.ts @@ -1,20 +1,20 @@ /* * Copyright © 2015-2021 the contributors (see Contributors.md). * - * This file is part of Knora. + * This file is part of DSP — DaSCH Service Platform. * - * Knora is free software: you can redistribute it and/or modify + * DSP is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as published * by the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * - * Knora is distributed in the hope that it will be useful, + * DSP is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public - * License along with Knora. If not, see . + * License along with DSP. If not, see . */ import { deleteResponseFormats } from "../deleteResponseFormats" diff --git a/docs/src/api-v1/sampleRequests/sampleGraphDataResponse.ts b/docs/src/api-v1/sampleRequests/sampleGraphDataResponse.ts index 78aef98044..1001dd59c1 100644 --- a/docs/src/api-v1/sampleRequests/sampleGraphDataResponse.ts +++ b/docs/src/api-v1/sampleRequests/sampleGraphDataResponse.ts @@ -1,20 +1,20 @@ /* * Copyright © 2015-2021 the contributors (see Contributors.md). * - * This file is part of Knora. + * This file is part of DSP — DaSCH Service Platform. * - * Knora is free software: you can redistribute it and/or modify + * DSP is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as published * by the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * - * Knora is distributed in the hope that it will be useful, + * DSP is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public - * License along with Knora. If not, see . + * License along with DSP. If not, see . */ import { graphDataResponseFormats } from "../graphDataResponseFormats" diff --git a/docs/src/api-v1/sampleRequests/sampleHierarchicalList.ts b/docs/src/api-v1/sampleRequests/sampleHierarchicalList.ts index 44241f0180..d3860c3dc3 100644 --- a/docs/src/api-v1/sampleRequests/sampleHierarchicalList.ts +++ b/docs/src/api-v1/sampleRequests/sampleHierarchicalList.ts @@ -2,20 +2,20 @@ /* * Copyright © 2015-2021 the contributors (see Contributors.md). * - * This file is part of Knora. + * This file is part of DSP — DaSCH Service Platform. * - * Knora is free software: you can redistribute it and/or modify + * DSP is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as published * by the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * - * Knora is distributed in the hope that it will be useful, + * DSP is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public - * License along with Knora. If not, see . + * License along with DSP. If not, see . */ import { hierarchicalListResponseFormats } from "../hierarchicalListResponseFormats" @@ -30,4 +30,4 @@ let seasons: hierarchicalListResponseFormats.hierarchicalListResponse = {"hlist" // return information about the path a particular node ("Flugaufnahmen") // http://localhost:3333/v1/hlists/http%3A%2F%2Frdfh.ch%2Flists%2F09c5ba9da8?reqtype=node -let nodePath: hierarchicalListResponseFormats.nodePathResponse = {"nodelist":[{"id":"http://rdfh.ch/lists/738fc745a7","name":"2GEO","label":"GEOGRAPHIE"},{"id":"http://rdfh.ch/lists/70916764a8","name":"3","label":"ENGADIN"},{"id":"http://rdfh.ch/lists/09c5ba9da8","name":"1","label":"Flugaufnahmen"}],"status":0}; \ No newline at end of file +let nodePath: hierarchicalListResponseFormats.nodePathResponse = {"nodelist":[{"id":"http://rdfh.ch/lists/738fc745a7","name":"2GEO","label":"GEOGRAPHIE"},{"id":"http://rdfh.ch/lists/70916764a8","name":"3","label":"ENGADIN"},{"id":"http://rdfh.ch/lists/09c5ba9da8","name":"1","label":"Flugaufnahmen"}],"status":0}; diff --git a/docs/src/api-v1/sampleRequests/sampleLoginResponse.ts b/docs/src/api-v1/sampleRequests/sampleLoginResponse.ts index fa590e2c69..6b3ae6e7a4 100644 --- a/docs/src/api-v1/sampleRequests/sampleLoginResponse.ts +++ b/docs/src/api-v1/sampleRequests/sampleLoginResponse.ts @@ -1,20 +1,20 @@ /* * Copyright © 2015-2021 the contributors (see Contributors.md). * - * This file is part of Knora. + * This file is part of DSP — DaSCH Service Platform. * - * Knora is free software: you can redistribute it and/or modify + * DSP is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as published * by the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * - * Knora is distributed in the hope that it will be useful, + * DSP is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public - * License along with Knora. If not, see . + * License along with DSP. If not, see . */ import { sessionResponseFormats } from "../sessionResponseFormats" diff --git a/docs/src/api-v1/sampleRequests/sampleResourceResponses.ts b/docs/src/api-v1/sampleRequests/sampleResourceResponses.ts index 2cee364e52..0b7007e826 100644 --- a/docs/src/api-v1/sampleRequests/sampleResourceResponses.ts +++ b/docs/src/api-v1/sampleRequests/sampleResourceResponses.ts @@ -1,20 +1,20 @@ /* * Copyright © 2015-2021 the contributors (see Contributors.md). * - * This file is part of Knora. + * This file is part of DSP — DaSCH Service Platform. * - * Knora is free software: you can redistribute it and/or modify + * DSP is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as published * by the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * - * Knora is distributed in the hope that it will be useful, + * DSP is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public - * License along with Knora. If not, see . + * License along with DSP. If not, see . */ import { resourceResponseFormats } from "../resourceResponseFormats" diff --git a/docs/src/api-v1/sampleRequests/sampleValueResponse.ts b/docs/src/api-v1/sampleRequests/sampleValueResponse.ts index 37217e9d61..71bc36f80a 100644 --- a/docs/src/api-v1/sampleRequests/sampleValueResponse.ts +++ b/docs/src/api-v1/sampleRequests/sampleValueResponse.ts @@ -1,20 +1,20 @@ /* * Copyright © 2015-2021 the contributors (see Contributors.md). * - * This file is part of Knora. + * This file is part of DSP — DaSCH Service Platform. * - * Knora is free software: you can redistribute it and/or modify + * DSP is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as published * by the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * - * Knora is distributed in the hope that it will be useful, + * DSP is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public - * License along with Knora. If not, see . + * License along with DSP. If not, see . */ import { valueResponseFormats } from "../valueResponseFormats" @@ -29,4 +29,4 @@ let getIntervalValue: valueResponseFormats.valueResponse = {"valuetype":"http:// let valueVersionResponse: valueResponseFormats.valueVersionsResponse = {"valueVersions":[{"valueObjectIri":"http://rdfh.ch/v_3QOWcDTeu2mgPW8DRzUg/values/ox6hH8abS7u3l50hMzoZlQ","valueCreationDate":"2016-07-15T10:15:08.131+02:00","previousValue":"http://rdfh.ch/v_3QOWcDTeu2mgPW8DRzUg/values/2nEUilUVTROmuEoTkOhfNg"},{"valueObjectIri":"http://rdfh.ch/v_3QOWcDTeu2mgPW8DRzUg/values/2nEUilUVTROmuEoTkOhfNg","valueCreationDate":"2016-07-15T09:19:19.304+02:00","previousValue":null}],"status":0}; -let linkResponse: valueResponseFormats.linkResponse = {"valuetype":"http://www.knora.org/ontology/knora-base#LinkValue","valuecreatorname":"Administrator-alt Admin-alt","valuecreationdate":"2016-03-02T15:05:10Z","valuecreator":"root-alt@example.com","status":0,"comment":null,"rights":2,"value":{"subjectIri":"http://rdfh.ch/8a0b1e75","predicateIri":"http://www.knora.org/ontology/0803/incunabula#partOf","objectIri":"http://rdfh.ch/c5058f3a","referenceCount":1}}; \ No newline at end of file +let linkResponse: valueResponseFormats.linkResponse = {"valuetype":"http://www.knora.org/ontology/knora-base#LinkValue","valuecreatorname":"Administrator-alt Admin-alt","valuecreationdate":"2016-03-02T15:05:10Z","valuecreator":"root-alt@example.com","status":0,"comment":null,"rights":2,"value":{"subjectIri":"http://rdfh.ch/8a0b1e75","predicateIri":"http://www.knora.org/ontology/0803/incunabula#partOf","objectIri":"http://rdfh.ch/c5058f3a","referenceCount":1}}; diff --git a/docs/src/api-v1/searchResponseFormats.ts b/docs/src/api-v1/searchResponseFormats.ts index dbcb4e9e56..badca2e41c 100644 --- a/docs/src/api-v1/searchResponseFormats.ts +++ b/docs/src/api-v1/searchResponseFormats.ts @@ -1,20 +1,20 @@ /* * Copyright © 2015-2021 the contributors (see Contributors.md). * - * This file is part of Knora. + * This file is part of DSP — DaSCH Service Platform. * - * Knora is free software: you can redistribute it and/or modify + * DSP is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as published * by the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * - * Knora is distributed in the hope that it will be useful, + * DSP is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public - * License along with Knora. If not, see . + * License along with DSP. If not, see . */ import { basicMessageComponents } from "./basicMessageComponents" @@ -138,4 +138,4 @@ export module searchResponseFormats { nhits: string; } -} \ No newline at end of file +} diff --git a/docs/src/api-v1/sessionResponseFormats.ts b/docs/src/api-v1/sessionResponseFormats.ts index 907e80e18e..9e994e4089 100644 --- a/docs/src/api-v1/sessionResponseFormats.ts +++ b/docs/src/api-v1/sessionResponseFormats.ts @@ -1,20 +1,20 @@ /* * Copyright © 2015-2021 the contributors (see Contributors.md). * - * This file is part of Knora. + * This file is part of DSP — DaSCH Service Platform. * - * Knora is free software: you can redistribute it and/or modify + * DSP is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as published * by the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * - * Knora is distributed in the hope that it will be useful, + * DSP is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public - * License along with Knora. If not, see . + * License along with DSP. If not, see . */ import {basicMessageComponents} from "./basicMessageComponents" @@ -45,4 +45,4 @@ export module sessionResponseFormats { */ userProfile: UserProfileV1; } -} \ No newline at end of file +} diff --git a/docs/src/api-v1/userFormats.ts b/docs/src/api-v1/userFormats.ts index fbb7559e9d..7459a83062 100644 --- a/docs/src/api-v1/userFormats.ts +++ b/docs/src/api-v1/userFormats.ts @@ -1,20 +1,20 @@ /* * Copyright © 2015-2021 the contributors (see Contributors.md). * - * This file is part of Knora. + * This file is part of DSP — DaSCH Service Platform. * - * Knora is free software: you can redistribute it and/or modify + * DSP is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as published * by the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * - * Knora is distributed in the hope that it will be useful, + * DSP is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public - * License along with Knora. If not, see . + * License along with DSP. If not, see . */ import {basicMessageComponents} from "./basicMessageComponents" @@ -275,4 +275,4 @@ export module userFormats { */ password: string | null; } -} \ No newline at end of file +} diff --git a/docs/src/api-v1/valueResponseFormats.ts b/docs/src/api-v1/valueResponseFormats.ts index ddf764eee7..3020f32d4a 100644 --- a/docs/src/api-v1/valueResponseFormats.ts +++ b/docs/src/api-v1/valueResponseFormats.ts @@ -1,20 +1,20 @@ /* * Copyright © 2015-2021 the contributors (see Contributors.md). * - * This file is part of Knora. + * This file is part of DSP — DaSCH Service Platform. * - * Knora is free software: you can redistribute it and/or modify + * DSP is free software: you can redistribute it and/or modify * it under the terms of the GNU Affero General Public License as published * by the Free Software Foundation, either version 3 of the License, or * (at your option) any later version. * - * Knora is distributed in the hope that it will be useful, + * DSP is distributed in the hope that it will be useful, * but WITHOUT ANY WARRANTY; without even the implied warranty of * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the * GNU Affero General Public License for more details. * * You should have received a copy of the GNU Affero General Public - * License along with Knora. If not, see . + * License along with DSP. If not, see . */ import { basicMessageComponents } from "./basicMessageComponents" @@ -180,4 +180,4 @@ export module valueResponseFormats { } -} \ No newline at end of file +} diff --git a/mkdocs.yml b/mkdocs.yml index 94615e0d43..e58f94ac16 100644 --- a/mkdocs.yml +++ b/mkdocs.yml @@ -1,20 +1,25 @@ -site_name: Knora Documentation +site_name: DSP-API documentation + +repo_url: https://github.com/dasch-swiss/dsp-api +repo_name: dasch-swiss/dsp-api +edit_uri: blob/main/docs/ +copyright: "© 2017 - 2021 Data and Service Center for the Humanities (DaSCH)" nav: - Home: index.md - Introduction: - Index: 01-introduction/index.md - - What is Knora?: 01-introduction/what-is-knora.md - - Data Formats in Knora: 01-introduction/data-formats.md + - What is DSP?: 01-introduction/what-is-knora.md + - Data Formats in DSP-API: 01-introduction/data-formats.md - Standoff/RDF Text Markup: 01-introduction/standoff-rdf.md - An Example Project: 01-introduction/example-project.md - - Knora Ontologies: + - DSP Ontologies: - Index: 02-knora-ontologies/index.md - Introduction: 02-knora-ontologies/introduction.md - The Knora Base Ontology: 02-knora-ontologies/knora-base.md - The SALSAH GUI Ontology: 02-knora-ontologies/salsah-gui.md - APIs: - - The Knora APIs: + - The DSP APIs: - Index: 03-apis/index.md - Feature Toggles: 03-apis/feature-toggles.md - API V1: @@ -63,12 +68,12 @@ nav: - Publishing and Deployment: - Index: 04-publishing-deployment/index.md - Publishing: 04-publishing-deployment/publishing.md - - Getting Started with Knora: 04-publishing-deployment/getting-started.md + - Getting Started with DSP-API: 04-publishing-deployment/getting-started.md - Configuration: 04-publishing-deployment/configuration.md - - Updating Repositories when Upgrading Knora: 04-publishing-deployment/updates.md - - Knora Internals: + - Updating Repositories when Upgrading DSP-API: 04-publishing-deployment/updates.md + - DSP Internals: - Design: - - Knora Design Principles: + - DSP-API Design Principles: - Index: 05-internals/design/principles/index.md - Design Overview: 05-internals/design/principles/design-overview.md - Futures with Akka: 05-internals/design/principles/futures-with-akka.md @@ -92,7 +97,7 @@ nav: - How to Add an API v2 Route: 05-internals/design/api-v2/how-to-add-a-route.md - JSON-LD Parsing and Formatting: 05-internals/design/api-v2/json-ld.md - Ontology Management: 05-internals/design/api-v2/ontology-management.md - - Knora and Sipi: 05-internals/design/api-v2/sipi.md + - DSP-API and Sipi: 05-internals/design/api-v2/sipi.md - Gravsearch Design: 05-internals/design/api-v2/gravsearch.md - Standoff Markup: 05-internals/design/api-v2/standoff.md - Archival Resource Key (ARK) Identifiers: 05-internals/design/api-v2/ark.md @@ -104,52 +109,47 @@ nav: - Index: 05-internals/development/index.md - Overview: 05-internals/development/overview.md - Build and Running: 05-internals/development/building-and-running.md - - Setup IntelliJ for development of Knora: 05-internals/development/intellij-config.md + - Setup IntelliJ for development of DSP-API: 05-internals/development/intellij-config.md - Bazel Notes: 05-internals/development/bazel.md - Testing: 05-internals/development/testing.md - Docker Cheat Sheet: 05-internals/development/docker-cheat-sheet.md - - Monitoring Knora: 05-internals/development/monitoring.md - - Profiling Knora: 05-internals/development/profiling.md - - Starting the Knora-Stack inside Docker Container: 05-internals/development/docker-compose.md + - Monitoring DSP-API: 05-internals/development/monitoring.md + - Profiling DSP-API: 05-internals/development/profiling.md + - Starting the DSP-Stack inside Docker Container: 05-internals/development/docker-compose.md - Updating Repositories: 05-internals/development/updating-repositories.md - Generating Client Test Data: 05-internals/development/generating-client-test-data.md - Starting GraphDB: 05-internals/development/graphdb.md - Third-Party Dependencies: 05-internals/development/third-party.md - - Salsah: - - Index: 06-salsah/index.md + # - Salsah: + # - Index: 06-salsah/index.md - SIPI: - Index: 07-sipi/index.md - - Setting Up Sipi for Knora: 07-sipi/setup-sipi-for-knora.md - - Interaction between Sipi and Knora: 07-sipi/sipi-and-knora.md + - Setting Up Sipi for DSP-API: 07-sipi/setup-sipi-for-knora.md + - Interaction between Sipi and DSP-API: 07-sipi/sipi-and-knora.md - Lucene: - Overview: 08-lucene/index.md - Lucene Query Parser Syntax: 08-lucene/lucene-query-parser-syntax.md - Frequently Asked Questions: faq/index.md - Release Notes: - - Overview: 00-release-notes/index.md - - Migration Notes: 00-release-notes/migration.md - - Next Release: 00-release-notes/next.md - - v1.1.0: 00-release-notes/v1.1.0.md - - v1.2.0: 00-release-notes/v1.2.0.md - - v1.3.0: 00-release-notes/v1.3.0.md - - v1.4.0: 00-release-notes/v1.4.0.md - - v1.5.0: 00-release-notes/v1.5.0.md - - v1.6.0: 00-release-notes/v1.6.0.md - - v1.7.0: 00-release-notes/v1.7.0.md - - v2.x.x: 00-release-notes/v2.x.x.md - - v3.x.x: 00-release-notes/v3.x.x.md - - v4.x.x: 00-release-notes/v4.x.x.md - - v5.x.x: 00-release-notes/v5.x.x.md - - v6.x.x: 00-release-notes/v6.x.x.md + - Changelog: 00-release-notes/index.md + +plugins: + - include-markdown + - search + - git-revision-date theme: name: material - logo: 'assets/images/dasch-icon-white.svg' - favicon: 'assets/images/dasch-favicon.ico' + logo: 'assets/icons/dasch-icon-white.svg' + favicon: 'assets/icons/dasch-favicon.ico' + icon: + repo: fontawesome/brands/github palette: primary: 'deep purple' accent: 'deep purple' features: - navigation.tabs + - navigation.sections + extra_css: - 'assets/style/theme.css'