search

OParl / spec

Spezifikation für eine offene Schnittstelle für Ratsinformationssysteme
https://oparl.org
Creative Commons Attribution Share Alike 4.0 International
61 stars 21 forks source link

Discovery mittels "Well-Known URIs" #74

Closed akuckartz closed 10 years ago

akuckartz commented 10 years ago

Zum Auffinden des Einstiegs in die OParl-Schnittstelle können durch IETF und W3C standardisierte Well-Known URIs verwendet werden, die so aussehen: http://www.example.com/.well-known/void

Dies ist auch relevant für #28, #58 und #59. Ich bereite einen pull-request vor.

Describing Linked Datasets with the VoID Vocabulary W3C Interest Group Note 03 March 2011 http://www.w3.org/TR/void/#well-known

Well-Known URIs http://www.iana.org/assignments/well-known-uris/well-known-uris.xhtml

Defining Well-Known Uniform Resource Identifiers (URIs) http://tools.ietf.org/html/rfc5785

akuckartz commented 10 years ago

Der erste Entwurf ist vorläufig in chapter_8030.md (oparl:System) aufgenommen. Ein Beispiel fehlt noch und auch die Verlagerung der referenzierten Spezifkationen in Fussnoten.

akuckartz commented 10 years ago

Es scheint einiges dafür zu sprechen, dass man beim Dereferenzieren des Well-Known URI ein oparl:System Dokument erhält.

akuckartz commented 10 years ago

Dazu auch http://semanticweb.org/wiki/VoID und:

Data Catalog Vocabulary (DCAT), W3C Recommendation 16 January 2014 http://www.w3.org/TR/vocab-dcat/

akuckartz commented 10 years ago

Auch in diesem Zusammenhang soll #64 berücksichtigt werden.

marians commented 10 years ago

Ich habe mir RFC 5785 angesehen und habe das Gefühl, dass das nichts mit OParl zu tun hat. Kann auch gut sein, das ich es nicht richtig verstanden habe. Das wiederum würde bedeuten, dass es richtig viel Arbeit machen würde, es vernünftig zu erklären.

Angesichts der Vielzahl von TODOs, die noch zu bearbeiten sind, habe ich mir erlaubt, den Text, der bisher im Dokument stand, wieder raus zu nehmen, denn der passte an der Stelle (unter Schema, oparl:System) nicht gut rein. Das war:

### Well-Known URIs

TODO: eventuell in eigenen Abschnitt oder eigenes Kapitel auslagern.

Es gibt eine standardisierte Technik, mit der ein Einstiegspunkt in die OParl-Daten angegeben werden kann: "Well-Known URIs". Dieser kann dann maschinell gefunden werden. Diese Technik wurde durch die IETF und das W3C standardisiert.

Die Spezifikation von "Well-Known URIs" durch die IETF ist:

Defining Well-Known Uniform Resource Identifiers (URIs)
http://tools.ietf.org/html/rfc5785

Eine Liste der Well-Known URIs wird von der IANA verwaltet:

Well-Known URIs
http://www.iana.org/assignments/well-known-uris/well-known-uris.xhtml

Für OParl sind gegenwärtig nur "Well-Known URIs" für Beschreibungen von Datasets gemäß dem "Vocabulary of Interlinked Datasets" (VoID) relevant.

BEISPIEL:

Wenn ein RIS unter der Domain "example.com" betrieben wird, dann sieht der "Well-Known URI" so aus (der enthaltene "." ist kein Schreibfehler):

https://example.com/.well-known/void

Forwarding ist erlaubt.

Siehe dazu auch:

Describing Linked Datasets with the VoID Vocabulary
W3C Interest Group Note 03 March 2011
http://www.w3.org/TR/void/#well-known

Die über derartige URIs dereferenzierbaren Dokumente sind hier spezifiziert: http://www.w3.org/TR/void/#void-file

BEISPIEL:

Bei einem http GET Request auf https://example.com/.well-known/void mit Angabe des bevorzugten MIME-Type "application/ld+json" antwortet das System mit dem URI https://example.com/.well-known/void.jsonld unter welchem dieses JSON-LD Dokument abrufbar ist:

TODO: Beispiele für JSON-LD und exemplarisch auch für HTML.

Wenn wir alles wichtigere erledigt haben, können wir das ja wieder eröffnen.