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

URLs of Documents' Loc/Ids #203

Open
eugenk opened this issue Sep 13, 2017 · 2 comments
Open

URLs of Documents' Loc/Ids #203

eugenk opened this issue Sep 13, 2017 · 2 comments
Labels

Comments

@eugenk
Copy link
Member

eugenk commented Sep 13, 2017

First of all, you may need the class diagram from the wiki to follow this issue. This issue builds on #9 (comment) but it should be self-contained.

I have some questions regarding Loc/Ids of Library and NativeDocument (both of which are subclasses of Document) and their contents: What routes do we want to have for the two, especially NativeDocument? (I left out the /:user/:repository[/rev/:revision] part of the route in the tables)

Type Library NativeDocument Option 1
Document /oms/:library /oms/:library
OMS /oms/:library//:oms /oms/:library//:oms
Symbol /symbols/:library//:oms//:symbol /symbols/:library//:oms//:symbol
Sentence /sentences/:library//:oms//:sentence /sentences/:library//:oms//:sentence
Mapping /mappings/:library//:mapping /mappings/:library//:mapping
Type Library NativeDocument Option 2
Document /oms/:library /oms/:library
OMS /oms/:library//:oms /oms/:oms
Symbol /symbols/:library//:oms//:symbol /symbols/:oms//:symbol
Sentence /sentences/:library//:oms//:sentence /sentences/:oms//:sentence
Mapping /mappings/:library//:mapping /mappings/:library//:mapping

The difference of Library (e.g. DOL) and NativeDocument (e.g. OWL) is that a Library can contain any number of OMS while the NativeDocument contains exactly one OMS.

Do we want to have a separate page for a NativeDocument that serves as an overview page (even though there is not much to show)?

Do we want to use a different namespace for a Document? (/document/:library instead of /oms/:library)

Notes:

  • :library may be equal to :oms which leads to URLs like this in option 1
    http://ontohub.org/admin/test-repository/symbols/pizza//pizza//Margherita
    whereas option 2 would look like
    http://ontohub.org/admin/test-repository/symbols/pizza//Margherita
  • Option 1 is more uniform across the application because it does not treat NativeDocument any different from Library.
  • Option 2 could be more intuitive to the user because an OMS is actually not structured inside a document (considering the URL).

Which option works best with linked open data? What URL does a user want to see when they want to query an OMS/Sentence/Symbol/Mapping in a NativeDocument? (maybe @fabianneuhaus can answer this the best)

Ping @tillmo.

@tillmo
Copy link
Member

tillmo commented Sep 13, 2017

I am in favour of the second option, because the first option always leads to a duplication (or do you have an example where :library and :oms would be different?), and a user not knowing DOL would not understand the reason for this duplication. (Still, such a user could use Ontohub for her/his native OMS.) For the same reason, I think that we do not need a separate overview page, because this also would just be a duplication.

@phyrog
Copy link
Contributor

phyrog commented Feb 7, 2018

Can this be closed?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Projects
None yet
Development

No branches or pull requests

3 participants