Skip to content

Commit

Permalink
Docs: added 409 and 422 responses
Browse files Browse the repository at this point in the history
  • Loading branch information
sorenabell committed Sep 21, 2016
2 parents 9f5a620 + e3b2f97 commit ae7ae17
Show file tree
Hide file tree
Showing 8 changed files with 583 additions and 487 deletions.
2 changes: 1 addition & 1 deletion docs/source/authentication.rst
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ owner tokens are issued to facilitate multiple actor roles upon object creation.
API keys
--------

API key is username to use with Basic Authenication scheme.
API key is username to use with Basic Authenication scheme (see :rfc:`2617#section-2`).

Owner tokens
------------
Expand Down
6 changes: 6 additions & 0 deletions docs/source/errors.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,15 @@ containing additional information.
Not found. Either the request method and path supplied do not specify a
known action in the API, or the object specified by the request does not
exist.

409
Document update conflict. The request could not be completed due to a conflict with the current state of the target resource. Please repeat your request.

412
Precondition Failed. See :ref:`API in cluster mode <cluster>`.

422
Unprocessable Entity. This status code means the server understands the content type of the request entity. For example, this error condition may occur if a JSON request body contains well-formed (i.e., syntactically correct), but semantically erroneous, JSON instructions.

429
Rate Limit Enforced. See :ref:`Rate control <performance>`.
Expand Down
66 changes: 37 additions & 29 deletions docs/source/locale/uk/LC_MESSAGES/authentication.po
Original file line number Diff line number Diff line change
Expand Up @@ -3,66 +3,77 @@ msgid ""
msgstr ""
"Project-Id-Version: openprocurement.api 0.5\n"
"Report-Msgid-Bugs-To: \n"
"POT-Creation-Date: 2014-12-16 10:43+0200\n"
"PO-Revision-Date: 2015-07-08 16:46+0200\n"
"POT-Creation-Date: 2016-09-21 15:42+0300\n"
"PO-Revision-Date: 2016-09-21 16:15+0200\n"
"Last-Translator: Zoriana Zaiats <sorenabell@quintagroup.com>\n"
"Language-Team: Ukrainian <info@quintagroup.com>\n"
"MIME-Version: 1.0\n"
"Content-Type: text/plain; charset=UTF-8\n"
"Content-Transfer-Encoding: 8bit\n"
"X-Generator: Poedit 1.7.6\n"
"Generated-By: Babel 2.3.4\n"
"Language: uk\n"
"Plural-Forms: nplurals=3; plural=(n%10==1 && n%100!=11 ? 0 : n%10>=2 && n%10<"
"=4 && (n%100<10 || n%100>=20) ? 1 : 2);\n"
"X-Generator: Lokalize 2.0\n"

#: ../../source/authentication.rst:4
msgid "Authentication"
msgstr "Аутентифікація"

#: ../../source/authentication.rst:6
msgid ""
"Some of the API requests (especially the ones that are read-only GET "
"requests) do not require any authenication. The other ones, that modify "
"data into the database, require broker authentication via API key. "
"Additionally, owner tokens are issued to facilitate multiple actor roles "
"upon object creation."
msgstr ""
"Деякі запити API (особливо GET запити лише для читання) не потребують "
"аутентифікації. Інші, ті, які модифікують дані у базі даних, потребують "
"аутентифікації брокера через ключ API. Додатково видаються токени "
"власника, щоб забезпечити кілька ролей дійових осіб при створенні "
"об’єкта."

#: ../../source/authentication.rst:12
msgid "API keys"
msgstr "Ключі API"

#: ../../source/authentication.rst:14
msgid "API key is username to use with Basic Authenication scheme."
msgid ""
"API key is username to use with Basic Authenication scheme (see "
":rfc:`2617#section-2`)."
msgstr ""
"Ключ API - це ім’я користувача, що буде використовуватись зі схемою Базової "
"аутентифікації."
"Ключ API - це ім’я користувача, що буде використовуватись зі схемою "
"базової аутентифікації (див. :rfc:`2617#section-2`)."

#: ../../source/authentication.rst:17
msgid "Owner tokens"
msgstr "Токени власника"

#: ../../source/authentication.rst:22
msgid "The token is issued when object is created in the database:"
msgstr "Токен видається, коли об'єкт створюється в базі даних:"

#: ../../source/authentication.rst:6
msgid ""
"Some of the API requests (especially the ones that are read-only GET requests) "
"do not require any authenication. The other ones, that modify data into the "
"database, require broker authentication via API key. Additionally, owner "
"tokens are issued to facilitate multiple actor roles upon object creation."
msgstr ""
"Деякі запити API (особливо GET запити лише для читання) не потребують "
"аутентифікації. Інші, ті, які модифікують дані у базі даних, потребують "
"аутентифікації брокера через ключ API. Додатково видаються токени власника, "
"щоб забезпечити кілька ролей дійових осіб при створенні об’єкта."

#: ../../source/authentication.rst:20
msgid "Getting token"
msgstr "Отримання токена"

#: ../../source/authentication.rst:22
msgid "The token is issued when object is created in the database:"
msgstr "Токен видається, коли об'єкт створюється в базі даних:"

#: ../../source/authentication.rst:27
msgid ""
"You can see the `access` with `token` in response. Its value can be used to "
"modify objects further under \"Owner role\"."
"You can see the `access` with `token` in response. Its value can be used"
" to modify objects further under \"Owner role\"."
msgstr ""
"У відповіді є `access` разом з `token`. Це значення можна використати для "
"модифікації об’єктів у \"ролі Власника\"."
"У відповіді є `access` разом з `token`. Це значення можна використати для"
" модифікації об’єктів у \"ролі Власника\"."

#: ../../source/authentication.rst:31
msgid "Using token"
msgstr "Використання токена"

#: ../../source/authentication.rst:33
msgid "You can pass access token in the following ways:"
msgstr "Ви можете передати токен доступу такими способами:"

#: ../../source/authentication.rst:35
msgid "`acc_token` URL query string parameter"
msgstr "параметр рядка URL запиту `acc_token` "
Expand All @@ -79,7 +90,4 @@ msgstr "`access.token` в тілі запитів POST/PUT/PATCH"
msgid "See the example of the action with token passed as URL query string:"
msgstr "Ось приклад, де токен передається як рядок URL запиту:"

#: ../../source/authentication.rst:33
msgid "You can pass access token in the following ways:"
msgstr "Ви можете передати токен доступу такими способами:"

0 comments on commit ae7ae17

Please sign in to comment.