diff options
Diffstat (limited to 'docs/source/api')
| -rw-r--r-- | docs/source/api/authentication.rst | 4 | ||||
| -rw-r--r-- | docs/source/api/objects.rst | 14 |
2 files changed, 9 insertions, 9 deletions
diff --git a/docs/source/api/authentication.rst b/docs/source/api/authentication.rst index 1d52d300..2db4a7bd 100644 --- a/docs/source/api/authentication.rst +++ b/docs/source/api/authentication.rst @@ -144,7 +144,7 @@ Only set client_id for update. Only set client_secret for update. This should only be given when you update. -Logo URL <url> is not a valid URL +Logo URL <URL> is not a valid URL This is when the URL specified did not meet the validation. contacts must be a string of space-separated email addresses. @@ -171,7 +171,7 @@ We are not using OAuth2 as we want to stay completely compatible with pump.io. Endpoints --------- -These are the endpoints you need to use for the oauth requests: +These are the endpoints you need to use for the OAuth requests: `/oauth/request_token` is for getting the request token. diff --git a/docs/source/api/objects.rst b/docs/source/api/objects.rst index 4c199616..854febe1 100644 --- a/docs/source/api/objects.rst +++ b/docs/source/api/objects.rst @@ -19,7 +19,7 @@ Objects Using any the APIs mentioned in this document you will required :doc:`authentication`. There are many ways to interact with objects, some of -which aren't supported yet by mediagoblin such as liking or sharing objects +which aren't supported yet by MediaGoblin such as liking or sharing objects however you can interact with them by updating them, deleting them and commenting on them. @@ -49,16 +49,16 @@ timestamps or any other data the server creates. My activity comment is:: This should be posted to the users feed (outbox) which you can find out about :doc:`activities`. You will get back the full activity containing all of -attributes including ID, urls, etc. +attributes including ID, URLs, etc. Posting Media ~~~~~~~~~~~~~ Posting media is a special case from posting all other objects. This is because you need to submit more than just the JSON image representation, you need to -actually subject the image itself. There is also strange behavour around media +actually subject the image itself. There is also strange behavior around media postings where if you want to give the media you're posting a title or -description you need to peform an update too. A full media posting in order of +description you need to perform an update too. A full media posting in order of steps to do is as follows: 1) Uploads the data to the server @@ -74,7 +74,7 @@ To upload media you should use the URL `/api/user/<username>/uploads`. A POST request should be made to the media upload URL submitting at least two headers: -* `Content-Type` - This being a valid mimetype for the media. +* `Content-Type` - This being a valid MIME type for the media. * `Content-Length` - size in bytes of the media. The media data should be submitted as POST data to the image upload URL. @@ -196,8 +196,8 @@ You should get the full delete activity in response. .. warning:: While deletion works, currently because of the way deletion is implemented - deletion either via the API or the webUI causes any activities to be broken - and will be skipped and unaccessible. A migration to remove the broken + deletion either via the API or the web UI causes any activities to be broken + and will be skipped and inaccessible. A migration to remove the broken activities will come in a future release when soft-deletion has been implemented. |