Skip to content

Commit dd56a1f

Browse files
committed
Fixed the changelog to follow indentation conventions in the JSON Api release entry.
- Legacy-Id: 9313
1 parent c16b7c5 commit dd56a1f

1 file changed

Lines changed: 36 additions & 36 deletions

File tree

changelog

Lines changed: 36 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -570,42 +570,42 @@ ietfdb (5.8.1) ietf; urgency=medium
570570

571571
ietfdb (5.8.0) ietf; urgency=medium
572572

573-
** JSON Api **
574-
575-
This release introduces a machine-readable API to the datatracker database
576-
content, based on Tastypie (https://django-tastypie.readthedocs.org/).
577-
578-
Currently the API is set to read-only; but Tastypie does support
579-
fine-grained control of create, read, update, and delete permissions, so if
580-
we find that it makes sense at some point, we can open up for authenticated
581-
access to more than just reading database content.
582-
583-
The details of which tables and objects from the database that are exposed
584-
in the API are controlled by a series of resources.py files; one per Django
585-
app. By default, no data is exposed; in order to expose a table, the
586-
resources file must contain a resource specification, in the form of a
587-
python class which determines which table fields should be exposed, and how.
588-
589-
Since we want to expose almost all the database content, rather than only a
590-
few selected tables, there is a lot of code which needs to be specified
591-
(more than 200 classes, with almost 2000 lines, at this writing) in order
592-
to make data available through the API.
593-
594-
Rather than manually type out all of the needed classes, a management
595-
command (ietf/manage.py makeresources) has been added which will generate
596-
the needed resource classes in the resources.py files automatically.
597-
Existing classes will be left intact, though, which makes it feasible to
598-
hand tune the classes if needed, but still auto-generate resource classes
599-
when new tables are added.
600-
601-
In addition to read access to the exposed tables and objects, the Tastypie
602-
API provides support for automated discovery of the available tables. Starting
603-
at the URL https://datatracker.ietf.org/api/v1/, the returned machine-readable
604-
data provides URL information for all available API endpoints, which makes it
605-
possible to recurse down to all available data.
606-
607-
Data is currently provided in JSON and XML format. Adding new formats is
608-
fairly easy, if it should be found desriable.
573+
**JSON Api**
574+
575+
This release introduces a machine-readable API to the datatracker database
576+
content, based on Tastypie (https://django-tastypie.readthedocs.org/).
577+
578+
Currently the API is set to read-only; but Tastypie does support
579+
fine-grained control of create, read, update, and delete permissions, so if
580+
we find that it makes sense at some point, we can open up for authenticated
581+
access to more than just reading database content.
582+
583+
The details of which tables and objects from the database that are exposed
584+
in the API are controlled by a series of resources.py files; one per Django
585+
app. By default, no data is exposed; in order to expose a table, the
586+
resources file must contain a resource specification, in the form of a
587+
python class which determines which table fields should be exposed, and how.
588+
589+
Since we want to expose almost all the database content, rather than only a
590+
few selected tables, there is a lot of code which needs to be specified
591+
(more than 200 classes, with almost 2000 lines, at this writing) in order
592+
to make data available through the API.
593+
594+
Rather than manually type out all of the needed classes, a management
595+
command (ietf/manage.py makeresources) has been added which will generate
596+
the needed resource classes in the resources.py files automatically.
597+
Existing classes will be left intact, though, which makes it feasible to
598+
hand tune the classes if needed, but still auto-generate resource classes
599+
when new tables are added.
600+
601+
In addition to read access to the exposed tables and objects, the Tastypie
602+
API provides support for automated discovery of the available tables. Starting
603+
at the URL https://datatracker.ietf.org/api/v1/, the returned machine-readable
604+
data provides URL information for all available API endpoints, which makes it
605+
possible to recurse down to all available data.
606+
607+
Data is currently provided in JSON and XML format. Adding new formats is
608+
fairly easy, if it should be found desriable.
609609

610610
-- Henrik Levkowetz <henrik@levkowetz.com> 18 Dec 2014 16:06:05 +0000
611611

0 commit comments

Comments
 (0)