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

There is no RESTFUL api #81

Open
fcbond opened this issue Nov 11, 2019 · 4 comments
Open

There is no RESTFUL api #81

fcbond opened this issue Nov 11, 2019 · 4 comments
Assignees

Comments

@fcbond
Copy link
Member

fcbond commented Nov 11, 2019

Currently we do not serve a useful restful interface.

We should aim to be compatible with the interface of the English Wordnet, which basically serves a small wordnet, with all relevant synsets (including lemmas). So if you ask for lemma 'cat' you get all synsets that include 'cat' if you ask for '0123457-n' you get that synset and all it senses and so on.

See https://github.com/jmccrae/wordnet-angular for some sample templates.
Here for an example: See https://github.com/jmccrae/wordnet-angular for some sample templates.

@fcbond
Copy link
Member Author

fcbond commented Nov 15, 2019

Maybe something like this:
http:// omw/xml/lemma/en/[lemma]
http:// omw/xml/lili/[ili-id]
http:// omw/xml/concept/[omw-id]

@goodmami
Copy link
Member

maybe instead:

http://$domain/omw/lemma/en/<lemma>.xml (or .json, or nothing but use headers)
http://$domain/omw/ili/<ili_id>
http://$domain/omw/concept/<omw_id>

This way the content type (xml or whatever) doesn't intervene inside the URL, so later we can get rid of it and not break our URLs.

@jmccrae
Copy link
Member

jmccrae commented Nov 15, 2019

We can document the API here:

https://app.swaggerhub.com/apis/jmccrae/OMW/1.0

@jmccrae
Copy link
Member

jmccrae commented Nov 15, 2019

Nicer version here:
https://app.swaggerhub.com/apis-docs/jmccrae/OMW/1.0

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

No branches or pull requests

3 participants