Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Adjust config format with JSKOS specification #64

Closed
nichtich opened this issue Jun 21, 2018 · 3 comments
Closed

Adjust config format with JSKOS specification #64

nichtich opened this issue Jun 21, 2018 · 3 comments
Labels
cleanup code cleanup, refactoring, testing... question Further discussion needed
Milestone

Comments

@nichtich
Copy link
Member

The https://gbv.github.io/jskos/jskos.html#registries for the current draft of "Registries" in JSKOS. We can rename in terminologyProviders: data to concepts and voc to schemes. The url field may be renamed to endpoint but this needs further discussion and examples.

The content of mappingProviders and occurrenceProviders may also be modified later, e.g.

{
  "mappingProviders": [
    { "mappings": "//coli-conc.gbv.de/api/mappings/" }
  ],
  "occurrenceProviders": [
    { "occurrences": "//coli-conc.gbv.de/occurrences/api/" }
  ]
}

Field occurrences is not included in JSKOS specification for registries yet.

Open question: name "Registry" or "Provider"?

@nichtich nichtich added question Further discussion needed cleanup code cleanup, refactoring, testing... labels Jun 21, 2018
@stefandesu
Copy link
Member

I would suggest using "Registry" as specified in JSKOS (to make it consistent). I would also propose that there is actually no need to differentiate between terminology registries, mapping registries, and occurrence registries. It would be enough to have one config field "registries" which contains all the different ones in JSKOS format and Cocoda can decide which ones to use in which situation based on the available properties.

@nichtich nichtich added this to the 1.0.0 milestone Aug 28, 2018
@nichtich
Copy link
Member Author

Suggested part of a config file to merge mappingProviders, occurrenceProviders, and part of terminologyProviders:

{
  "registries": [
    {       
      "mappings": "//coli-conc.gbv.de/api/mappings/",
      "prefLabel": { "en": "Mapping Database" } 
    }, {
      "occurrences": "//coli-conc.gbv.de/occurrences/api/",
      "notation": ["O"],
      "prefLabel": { "en": "Occurrences", "de": "Vorkommen" }
    }, {       
      "mappings": "//example.org/mappings",
      "occurrences": "//example.org/occurrences",
      "prefLabel": { "en": "Example" },
      "notation": ["E"]
    },{
      "schemes": [ {
        "uri": "http://bartoc.org/en/node/430",
        "prefLabel": { "de": "Gemeinsame Normdatei" },
        "notation": ["GND"]
      } ],
      "concepts": "//coli-conc.gbv.de/services/gnd.php",
      "suggestConcepts": "//ws.gbv.de/suggest/gnd/?searchterm={searchTerms}"
    }
  ]
}

stefandesu added a commit that referenced this issue Nov 20, 2018
The config loading script was adjusted so that the format is backwards compatible with the current implementation. To actually use the new config format, further adjustments are needed, especially in the API. See also: #209, #168, #84.
@stefandesu
Copy link
Member

I'm closing this issue as the config file format has been changed. Based on this change, #209 will be implemented.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
cleanup code cleanup, refactoring, testing... question Further discussion needed
Projects
None yet
Development

No branches or pull requests

2 participants