Changes between Version 30 and Version 31 of Centre Registry


Ignore:
Timestamp:
09/12/18 15:59:38 (6 years ago)
Author:
André Moreira
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • Centre Registry

    v30 v31  
    11== Centre Registry 2 ==
    2 A current version is available on https://centres.clarin.eu/ . A staging version shall be deployed https://dev-1-www.clarin.eu/ .
     2A current version is available on https://centres.clarin.eu/ . A staging version shall be deployed https://centres-staging.clarin.eu.
    33
    44=== REST API ===
    … …  
    1111`restxml/`: gives a list of centres including the centre ID in XML.
    1212
    13 `restxml/n`, where n is a centre ID:
    14 Gives detailed information about a centre in XML that is validated with this schema: [http://catalog.clarin.eu/ds/ComponentRegistry/rest/registry/profiles/clarin.eu:cr1:p_1320657629667/xsd]
     13`restxml/n`, where n is a centre ID: Gives detailed information about a centre in XML that is validated with this schema: [http://catalog.clarin.eu/ds/ComponentRegistry/rest/registry/profiles/clarin.eu:cr1:p_1320657629667/xsd]
    1514
    1615===== Notes =====
    17 Some services (WebLicht) may depend on optional string-type properties of OAI-PMH endpoints that have been exported since the old API:
    18 * ''WebServiceType'' is the semantic indication of the kind of webservices offered.
    19 * ''WebServicesSet'' is just a name for the OAI-PMH set that contains the relevant web service metadata descriptions. It could be anything, so a harvester should be able to deal with arbitrary set names.
     16Some services (WebLicht) may depend on optional string-type properties of OAI-PMH endpoints that have been exported since the old API:
     17
     18 * ''WebServiceType'' is the semantic indication of the kind of webservices offered.
     19 * ''WebServicesSet'' is just a name for the OAI-PMH set that contains the relevant web service metadata descriptions. It could be anything, so a harvester should be able to deal with arbitrary set names.
    2020
    2121== Dependents ==
    22 * The Harvest Manager at MPI-PL
    23 * WebLicht at various German CLARIN Centres especially UTU
    24 * Monitoring at FZJ
    25 * FCS Aggregator
     22 * The Harvest Manager at MPI-PL
     23 * WebLicht at various German CLARIN Centres especially UTU
     24 * Monitoring at FZJ
     25 * FCS Aggregator
    2626
    2727== Open Tickets ==
    28 
    2928[[TicketQuery(status=accepted|assigned|new|reopened,component=Centre Registry,order=priority,format=table,col=summary|component|priority|owner|reporter)]]
    3029
    3130== Deployment using `alpine-django` image project ==
    32 
    33 See [https://gitlab.com/CLARIN-ERIC/alpine-django `alpine-django`] project.
    34 The following data layout is is needed for deployment:
     31See [https://gitlab.com/CLARIN-ERIC/alpine-django `alpine-django`] project. The following data layout is is needed for deployment:
    3532
    3633{{{
    … …  
    4946└── test_database.sqlite
    5047}}}
    51 
    5248== The Centre Registry before 2.0 ==
    53 
    5449== Open Tickets ==
    55 
    5650[[TicketQuery(status=accepted|assigned|new|reopened,component=CenterRegistry,order=priority,format=table,col=summary|component|priority|owner|reporter)]]
    5751
    5852= Technical Specification =
    59 
    6053== Introduction ==
    61 
    62 The centres form the backbone of the distributed CLARIN infrastructure. So far the administration of the centre details has been done manually, noting down the entry points and contact information on a web site. In order to streamline the information gathering and to ensure machine accessibility of this data a Centre Registry needs to be built. In this page we specify the requirements for such a registry, in accordance with the CLARIN-D AP3 guidelines.
     54The centres form the backbone of the distributed CLARIN infrastructure. So far the administration of the centre details has been done manually, noting down the entry points and contact information on a web site. In order to streamline the information gathering and to ensure machine accessibility of this data a Centre Registry needs to be built. In this page we specify the requirements for such a registry, in accordance with the CLARIN-D AP3 guidelines.
    6355
    6456== Requirements ==
    65 
    6657The Centre Registry is a store for records with information about CLARIN centres.  This document describes the data that it could contain (Data store), the web application for users to view and change the data (Web Interface) and the machine-accessible API (Web Service).
    6758
    6859== Example files ==
    69 
    7060The CMDI files containing information about the CLARIN centre can be found in the SVN repository:
    7161
    … …  
    7363
    7464=== Data store ===
    75 
    7665Each record has these fields:
    7766
    … …  
    8574
    8675'''Extended Information'''
    87    
     76
    8877 * Long term archiving policy (string)
    8978 * CLARIN infrastructure services (0 or 1; string; meaning: non-standard offers like OAI harvesting)
    … …  
    10594   * member of a national identity federation (0 or more; controlled vocabulary: subset of ISO 3166-2)
    10695   * member of the CLARIN Service Provider Federation (boolean)
    107  * organisational information: 
     96 * organisational information:
    10897   * organisation details (see http://www.clarin.eu/organisations/3434 for an example)
    10998   * contact information (name, email, phone) of a technical contact person
    … …  
    112101   * Service Provider test site (URI, link to the [http://clarin.ids-mannheim.de/shib_test.pl shib_test.pl] script)
    113102   * (As the nagios probes will be configured at the monitoring computer center no further fields required)
    114    
    115 Empty values shouldn’t be allowed, e.g., if the Web Services Set field is left empty it isn’t instantiated and this is the same as an instance count of zero. It is very probable that new fields will be needed in the future, so the data model should be flexible. Also it should be easy to add new values to controlled vocabularies, e.g., to add a new allowed Web Service Type.
     103
     104 Empty values shouldn’t be allowed, e.g., if the Web Services Set field is left empty it isn’t instantiated and this is the same as an instance count of zero. It is very probable that new fields will be needed in the future, so the data model should be flexible. Also it should be easy to add new values to controlled vocabularies, e.g., to add a new allowed Web Service Type.
    116105
    117106=== Web interface ===
    … …  
    121110 * authorization: SAML-based, initally via the eduPersonPrincipleName attribute as received from [http://idp.mpi.nl/metadata/homeless-clarin-metadata.xml the CLARIN IdP]:
    122111   * everyone should have read access
    123    * a few administrators ({{{dietuyt@mpi.nl, menwin@mpi.nl, thorsten.trippel@uni-tuebingen.de}}}) have write access
     112   * a few administrators (`dietuyt@mpi.nl, menwin@mpi.nl, thorsten.trippel@uni-tuebingen.de`) have write access
    124113
    125114=== Web service ===
    126115A REST-webservice returns information from the registry as:
     116
    127117 * JSON
    128118 * CMDI (=XML, for the details of this format see below)
    … …  
    133123
    134124A CMDI profile has been created:
     125
    135126 * link to CMDI profile: https://catalog.clarin.eu/ds/ComponentRegistry?item=clarin.eu:cr1:p_1320657629667
    136127 * link to XSD: https://catalog.clarin.eu/ds/ComponentRegistry/rest/registry/profiles/clarin.eu:cr1:p_1320657629667/xsd
    … …  
    139130To start, the following functions should be available:
    140131
    141 * return a list of all centre (together with a unique centre ID): http://foo.eu/rest/centerregistry/centers
    142   * optional parameters: /xml (default, ad hoc xml encoding) or /json
    143   * output: centre ID, Basic information fields, if there is at least 1 OAI access point, providing metadata about web services
    144 * return all information about 1 centre: http://foo.eu/rest/registry/centers/{centreID}
    145   * optional parameters: /cmdi (default) or /json
    146   * output: all fields in the centre record
     132 * return a list of all centre (together with a unique centre ID): http://foo.eu/rest/centerregistry/centers
     133   * optional parameters: /xml (default, ad hoc xml encoding) or /json
     134   * output: centre ID, Basic information fields, if there is at least 1 OAI access point, providing metadata about web services
     135 * return all information about 1 centre: http://foo.eu/rest/registry/centers/{centreID}
     136   * optional parameters: /cmdi (default) or /json
     137   * output: all fields in the centre record
    147138
    148139Documentation about the webservice:
     140
    149141 * as HTML
    150142 * as a WADL file (like e.g.: https://catalog.clarin.eu/ds/ComponentRegistry/rest/application.wadl)
    151143
    152144== Glossary ==
    153 
    154145Archived information: the [wiki:./Glossary Centre Registry Glossary], explaining what each field means