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.

Sign up for GitHub

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

initial docs for create facet API #4629

Merged
merged 3 commits into from
Apr 30, 2018
Merged

initial docs for create facet API #4629

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b080823
initial docs for create facet API
pameyer Apr 28, 2018
e2c0a63
remove unpaired quote in url
pameyer Apr 30, 2018
095cfce
example now uses metadata fields that are actually facetable
pameyer Apr 30, 2018
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions doc/sphinx-guides/source/api/native-api.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -72,6 +72,15 @@ List Facets Configured for a Dataverse

GET http://$SERVER/api/dataverses/$id/facets?key=$apiKey

Set Facets for a Dataverse
~~~~~~~~~~~~~~~~~~~~~~~~~~

Assign search facets for a given dataverse with alias ``$alias``

``curl -H "X-Dataverse-key: $apiKey" -X POST http://$server/api/dataverses/$alias/facets --upload-file facets.json``

Where ``facets.json`` contains a JSON encoded list of metadata keys (e.g. ``["authorName","authorAffiliation"]``).

Create a New Role in a Dataverse
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~

Expand Down