diff --git a/ietf/templates/api/index.html b/ietf/templates/api/index.html index bc5374001..527ff69fb 100644 --- a/ietf/templates/api/index.html +++ b/ietf/templates/api/index.html @@ -168,15 +168,16 @@
- The datatracker does not use any form of API keys currently (03 Nov
- 2017), but may do so in the future. If so, personal API keys will be
- available from your
- Account API Key page when you are logged in, and document keys
- will be visible to document authors on the document status page when
- logged in.
+ The datatracker has some API endpoints that uses Personal API keys,
+ rather than username/password login, see for example details for
+ {% url 'ietf.doc.views_ballot.api_set_position' %}
further
+ down on this page. Personal API keys are available from your Account API Key
+ page when you are logged in.
When sending notifications to other APIs, the datatracker may sign @@ -194,20 +195,23 @@
- A simplified IESG ballot position interface, intended for automation,
- is available at {% url 'ietf.doc.views_ballot.api_set_position' %}
.
+
+ A simplified IESG ballot position interface, intended for automation, is
+ available at {% url 'ietf.doc.views_ballot.api_set_position' %}
+
. Access is limited to area directors.
+
The interface requires the use of a personal API key, which can be created at {% url 'ietf.ietfauth.views.apikey_index' %}
- It takes the following parameters: + The ballot position API takes the following parameters:
apikey
(required) which is the personal API key hashdoc
(required) which is the balloted document nameposition
(required) which is the position slug, one of: yes, noobj, block, discuss, abstain, recuse, norecord position
(required) which is the position slug, one of: yes, noobj, block, discuss, abstain, recuse, norecord. discuss
(required if position is 'discuss') which is the discuss textcomment
(optional) which is comment text