Skip to content
This repository has been archived by the owner on Feb 22, 2023. It is now read-only.

Fix URL in API consumer docs #1002

Merged
merged 2 commits into from
Nov 4, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
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: 2 additions & 2 deletions api/catalog/api/docs/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -23,15 +23,15 @@ instructions on obtaining an API key.

## Register for a key
Before using the Openverse API, you need to register access via OAuth2. This can
be done using the `/v1/auth_tokens/register` endpoint.
be done using the `/v1/auth_tokens/register/` endpoint.

Example on how to register for a key:
```bash
$ curl \
-X POST \
-H "Content-Type: application/json" \
-d '{"name": "My amazing project", "description": "To access Openverse API", "email": "[email protected]"}' \
"https://api.openverse.engineering/v1/auth_tokens/register"
"https://api.openverse.engineering/v1/auth_tokens/register/"
```
If your request is successful, you will get a `client_id` and `client_secret`.

Expand Down
2 changes: 1 addition & 1 deletion api/catalog/api/models/models.py
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ class ContentProvider(models.Model):

For example,
- Wikimedia for audio can have
``provider_identifier`` as wikimedia_audio" and
``provider_identifier`` as "wikimedia_audio" and
``provider_name`` as "Wikimedia"
- Wikimedia for images can have
``provider_identifier`` as "wikimedia_images" or "wikimedia" and
Expand Down
1 change: 1 addition & 0 deletions api/catalog/urls/__init__.py
Original file line number Diff line number Diff line change
Expand Up @@ -2,6 +2,7 @@

The `urlpatterns` list routes URLs to views. For more information please see:
https://docs.djangoproject.com/en/2.0/topics/http/urls/

Examples:
Function views
1. Add an import: from my_app import views
Expand Down