-
Notifications
You must be signed in to change notification settings - Fork 2
Instance specific customization #40
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
Changes from all commits
da70a48
7f030f5
c937ba8
4ce4a27
c10c4c9
1d00ac9
b32bf1a
44af5c8
a9c7963
f29331d
6eb8534
04a320f
2b5c105
587ff95
1b82554
73c5314
5016499
32e7fe0
6dd1847
cd99d76
1b02eb4
1f64242
7aecac5
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,27 +1,11 @@ | ||
syntax: glob | ||
.idea/ | ||
_site/ | ||
|
||
*.DS_Store | ||
*~ | ||
|
||
*.~lock* | ||
|
||
*.orig | ||
|
||
Gemfile.lock | ||
|
||
.ruby-version | ||
|
||
#seek application folders that may hang around | ||
filestore*/ | ||
config/ | ||
coverage/ | ||
log/ | ||
public/ | ||
solr/ | ||
tmp/ | ||
.bundle/ | ||
db/ | ||
filestore | ||
vendor/ | ||
.vscode/ |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -2,20 +2,20 @@ | |
title: API Introduction | ||
--- | ||
|
||
FAIRDOM-SEEK includes a [JSON](https://www.json.org/) Application | ||
{{ site.seek_instance.name | default: "FAIRDOM-SEEK" }} includes a [JSON](https://www.json.org/) Application | ||
Programming Interface (API) that allows the **searching, | ||
listing, reading, updating and creating** of many items in SEEK, | ||
listing, reading, updating and creating** of many items in SEEK, | ||
along with their attributes. | ||
|
||
The API conforms to the [JSON API](http://jsonapi.org) specification which | ||
describes a standard way of representing APIs in JSON. | ||
|
||
Technical details about the JSON structures and available endpoints | ||
comes bundled with FAIRDOM-SEEK and can be found served from: | ||
comes bundled with {{ site.seek_instance.name | default: "FAIRDOM-SEEK" }} and can be found served from: | ||
|
||
http://<host>:<port>/api | ||
|
||
For example, on the FAIRDOMHub it is [https://fairdomhub.org/api](https://fairdomhub.org/api), | ||
For example, on the FAIRDOMHub it is [{{ site.seek_instance.url | default: "https://fairdomhub.org" }}/api]({{ site.seek_instance.url | default: "https://fairdomhub.org" }}/api), | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Would this URL ever change? The text before the link says FAIRDOMHub, so surely the link should always go to FAIRDOMHub API? |
||
or for a local running instance it would be [http://localhost:3000/api](http://localhost:3000/api) | ||
|
||
There are also some examples that are available as Jupyter notebook scripts. They were created for training events, and give | ||
|
@@ -25,7 +25,7 @@ a general overview and walk through some typical scenarios. They can be found at | |
|
||
The API supports [Basic Authentication](https://en.wikipedia.org/wiki/Basic_access_authentication), OAuth and API Tokens. | ||
|
||
More details can be found in [FAIRDOMHub API Docs](https://fairdomhub.org/api#section/Authentication). | ||
More details can be found in [{{ site.seek_instance.name }} API Docs]({{ site.seek_instance.url | default: "https://fairdomhub.org" }}/api#section/Authentication) | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This time, you've put the variable in the instance name too. So perhaps line 18 should have the instance name variable as well? |
||
|
||
The API can also be used without any authentication, | ||
in which case only publicly viewable information will | ||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,5 @@ | ||
--- | ||
title: Browsing content on FAIRDOM-SEEK | ||
title: Browsing content | ||
--- | ||
|
||
|
||
|
Uh oh!
There was an error while loading. Please reload this page.