diff --git a/api/catalog/api/docs/README.md b/api/catalog/api/docs/README.md index 708e7ebe0..1bb996012 100644 --- a/api/catalog/api/docs/README.md +++ b/api/catalog/api/docs/README.md @@ -23,7 +23,7 @@ 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 @@ -31,7 +31,7 @@ $ curl \ -X POST \ -H "Content-Type: application/json" \ -d '{"name": "My amazing project", "description": "To access Openverse API", "email": "user@example.com"}' \ - "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`. diff --git a/api/catalog/api/models/models.py b/api/catalog/api/models/models.py index b267e3153..b7911ac58 100644 --- a/api/catalog/api/models/models.py +++ b/api/catalog/api/models/models.py @@ -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 diff --git a/api/catalog/urls/__init__.py b/api/catalog/urls/__init__.py index c37b1d44e..9c96b0943 100644 --- a/api/catalog/urls/__init__.py +++ b/api/catalog/urls/__init__.py @@ -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