Skip to content

Commit

Permalink
Adjust README and documentation for MyCoRe provider (#50)
Browse files Browse the repository at this point in the history
  • Loading branch information
stefandesu committed Oct 11, 2022
1 parent e50241a commit a95a274
Show file tree
Hide file tree
Showing 2 changed files with 15 additions and 3 deletions.
2 changes: 2 additions & 0 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -167,6 +167,8 @@ The following providers are also exported, but have to be added via `cdk.addProv
- **This integration is currently experimental and only supports LCSH and LCNAF.**
- `Skohub` - access to concept schemes and concepts via a [SkoHub Vocabs](https://blog.lobid.org/2019/09/27/presenting-skohub-vocabs.html)
- **This integration is currently experimental. Only vocabularies that use a [slash namespace pattern]([hash](https://www.w3.org/2001/sw/BestPractices/VM/http-examples/2006-01-18/#slash)) with dereferenceable URIs are supported.**
- `MyCoRe` - access to vocabularies via [MyCoRe](https://www.mycore.de/)
- **This integration is currently experimental. Only one vocabulary per registry is supported. Not recommended for large vocabularies as all of the vocabulary data is loaded and kept in memory.**
- `ReconciliationApi` - access to mapping suggestions via a [OpenRefine Reconciliation API](https://github.com/OpenRefine/OpenRefine/wiki/Reconciliation-Service-API)
- `OccurrencesApi` - access to concept occurrences via [occurrences-api](https://github.com/gbv/occurrences-api) (will be changed to [occurrences-server](https://github.com/gbv/occurrences-server) in the future)
- `LabelSearchSuggestion` - access to mapping suggestions using other registries' search endpoints (using [jskos-server])
Expand Down
16 changes: 13 additions & 3 deletions src/providers/mycore-provider.js
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,21 @@ import FlexSearch from "flexsearch"
const data = {}

/**
* MyCoRE Classification API
*
* Currently supports only one vocabulary per registry.
* MyCoRe Classification API
*
* See also: https://github.com/gbv/cocoda-sdk/issues/50
*
* To use it in a registry, specify `provider` as "MyCoRe" and provide the API URL as `api`:
* ```json
* {
* "uri": "http://coli-conc.gbv.de/registry/mycore-shbsg",
* "provider": "MyCoRe",
* "api": "https://bibliographie.schleswig-holstein.de/api/v2/classifications/shbib_sachgruppen.json"
* }
* ```
*
* Specifying `schemes` is currently not required and it will not be used. Currently supports only one vocabulary per registry.
*
*/
export default class MyCoReProvider extends BaseProvider {

Expand Down

0 comments on commit a95a274

Please sign in to comment.