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

Add notes about permissions #14

Closed
wants to merge 2 commits into from
Closed

Add notes about permissions #14

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
92ad8b3
Add notes about permissions
codello Dec 15, 2021
f5420d7
Fix typo
codello Dec 16, 2021
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
4 changes: 4 additions & 0 deletions api/02-songs.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,6 +8,10 @@ Songs reside at the API endpoint
GET <api-root>/<api-version>/songs
```

## Permissions

Currently all of the `song` API is only available for authenticated users. In the future parts of the API may be available anonymously.

## Fields

The following fields are returned by the API when querying the *entity details* endpoint for a song.
Expand Down
4 changes: 4 additions & 0 deletions api/03-users.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,10 @@ This document describes the `users` API entity located at
GET <api-root>/<api-version>/users
```

## Permissions

Currently the `users` API is only available for authenticated users. In the future parts of the API may be available anonymously.

## Accessing Users

In addition the the standard list and details endpoints a special endpoint `.../users/me` is supported. This special endpoint returns data on the user that is associated with the corresponding request.
Expand Down