Skip to content

Commit

Permalink
Update static files for the docs
Browse files Browse the repository at this point in the history
These updated static files will allow the new Agenda documentation to
appear.

The previous commit is also part of this fix

fixes #11078
  • Loading branch information
aa29cala committed Oct 26, 2018
1 parent 8b263d6 commit dc31447
Show file tree
Hide file tree
Showing 44 changed files with 13,479 additions and 602 deletions.
Binary file modified src/main/webapp/static/docs/doctrees/admin.doctree
Binary file not shown.
Binary file modified src/main/webapp/static/docs/doctrees/agendas.doctree
Binary file not shown.
Binary file modified src/main/webapp/static/docs/doctrees/agg_updates.doctree
Binary file not shown.
Binary file modified src/main/webapp/static/docs/doctrees/bills.doctree
Binary file not shown.
Binary file modified src/main/webapp/static/docs/doctrees/calendars.doctree
Binary file not shown.
Binary file modified src/main/webapp/static/docs/doctrees/committees.doctree
Binary file not shown.
Binary file modified src/main/webapp/static/docs/doctrees/environment.pickle
Binary file not shown.
Binary file modified src/main/webapp/static/docs/doctrees/index.doctree
Binary file not shown.
Binary file modified src/main/webapp/static/docs/doctrees/laws.doctree
Binary file not shown.
Binary file modified src/main/webapp/static/docs/doctrees/members.doctree
Binary file not shown.
Binary file modified src/main/webapp/static/docs/doctrees/reference.doctree
Binary file not shown.
Binary file modified src/main/webapp/static/docs/doctrees/search_api.doctree
Binary file not shown.
Binary file modified src/main/webapp/static/docs/doctrees/transcripts_floor.doctree
Binary file not shown.
Binary file modified src/main/webapp/static/docs/doctrees/transcripts_ph.doctree
Binary file not shown.
2 changes: 1 addition & 1 deletion src/main/webapp/static/docs/html/.buildinfo
@@ -1,4 +1,4 @@
# Sphinx build info version 1
# This file hashes the configuration used when building these files. When it is not found, a full rebuild will be done.
config: ed0c7729217c429bee4cc3aecb1d8fa7
config: e0f11b5bbe254dff089b1fbb74c537fc
tags: 645f666f9bcd5a90fca523b33c5a78b7
199 changes: 198 additions & 1 deletion src/main/webapp/static/docs/html/_sources/agendas.rst.txt
Expand Up @@ -16,8 +16,205 @@ Retrieve an agenda by year and agenda no
::
(GET) /api/3/agendas/{year}/{agendaNo}

More documentation coming soon..
**Examples**

Request agenda 2 of session year 2017
::
/api/3/agendas/2017/2

.. note:: Agenda responses have a lot of data. They contain their own data as well as bill data. The example, agenda 2 has over 10,000 lines.



Get a list of agendas for a single year
---------------------------------------

**Usage**

Returns a list of agenda ids in ascending order that occur in the given year
::
(GET) /api/3/agendas/{year}

**Examples**

Request agenda 2 of session year 2017
::
/api/3/agendas/2017



Get a specific committee with an agenda
---------------------------------------

**Usage**

Retrieve a specific committee within an agenda
::
/api/3/agendas/{year}/{agendaNo}/{committeeName}

**Examples**

Request the Rules commitee agenda 2 of session year 2017
::
/api/3/agendas/2017/2/Rules

Get a list of committee meeting times in a time range
-------------------------------------------------

**Usage**

Retrieve a list of committee meetings between from and to date/time, ordered by earliest first
::
(GET) /api/3/agendas/meetings/{from datetime}/{to datetime}

**Examples**

Retrieve a list of committee meetings between Jan 1st, 2017 to Feb 1st, 2017
::
/api/3/agendas/meetings/2017-01-01/2017-02-01



Search an Agenda for a term
-------------------------------------------------

**Usage**

Search agendas across all years for a term
::
(GET) /api/3/agendas/search

.. note:: The param term is required and the value of this parameter is whatever you are looking to find

**Optional Params**

+-----------+-----------------------------------------------------------------------------------------+
| Parameter | Values |
+===========+=========================================================================================+
| full | 'true', 'false' |
+-----------+-----------------------------------------------------------------------------------------+

**Examples**

Search agendas for the term crime
::
/api/3/agendas/search?term=crime&full=false



Search all agendas in a calendar year for a term
-------------------------------------------------

**Usage**

Search agendas across all years for a term
::
(GET) /api/3/agendas/{year}/search

.. note:: The param term is required and the value of this parameter is whatever you are looking to find

**Optional Params**

+-----------+-----------------------------------------------------------------------------------------+
| Parameter | Values |
+===========+=========================================================================================+
| full | 'true', 'false' |
+-----------+-----------------------------------------------------------------------------------------+
| limit | Limit the number of results |
+-----------+-----------------------------------------------------------------------------------------+
| offset | Start the results from offset |
+-----------+-----------------------------------------------------------------------------------------+


**Examples**

Search agendas for a specific term
::
/api/3/agendas/2017/search?term=crime&full=false&limit=10&offset=5



Get updated agenda Id's
-----------------------

**Usage**

Return a list of agenda ids that have changed during a specified date/time range
::
(GET) /api/3/agendas/updates/

.. note:: This api call gets updates in the last 7 days

**Examples**

Get all of the data in the last week
::
/api/3/agendas/updates/

**Usage**

Get updates from the time specified to now
::
(GET) /api/3/agendas/updates/{from}

**Examples**

Get updates for all of the 2017 session
::
/api/3/agendas/updates/2017-01-01/

**Usage**

::
(GET) /api/3/agendas/updates/{from}/{to}

**Examples**

Get updates for all of January 2018
::
/api/3/agendas/updates/2018-01-01/2018-01-31



Get updated agenda digests
--------------------------

**Usage**

This api call gets all digests for an agenda in a calendar year
::
(GET) /api/3/agendas/{year}/{agendaNo}/updates

**Examples**

Get all updates for agenda 15 in 2017
::
/api/3/agendas/2017/15/updates

**Usage**

Get a list of agenda digests in a specific time range of the calendar year to now
::
(GET) /api/3/agendas/{year}/{agendaNo}/updates/{from}

.. note:: Where 'from' is an ISO date time

**Examples**

Get updates for agenda 12 in 2017 from Feb 1st, 2017 to now
::
/api/3/agendas/2017/12/updates/2017-02-01

**Usage**

Return agenda digests that have changed during a specified date/time range
::
(GET) /api/3/agendas/{year}/{agendaNo}/updates/{from}/{to}

.. note:: Where 'from' and 'to' are ISO date times

**Examples**

Get updates for agenda 12 in 2017 from Jan 1st, 2017 to Dec 1st, 2017
::
/api/3/agendas/2017/12/updates/2017-01-01/2017-12-01
30 changes: 1 addition & 29 deletions src/main/webapp/static/docs/html/_static/basic.css
Expand Up @@ -81,26 +81,10 @@ div.sphinxsidebar input {
font-size: 1em;
}

div.sphinxsidebar #searchbox form.search {
overflow: hidden;
}

div.sphinxsidebar #searchbox input[type="text"] {
float: left;
width: 80%;
padding: 0.25em;
box-sizing: border-box;
width: 170px;
}

div.sphinxsidebar #searchbox input[type="submit"] {
float: left;
width: 20%;
border-left: none;
padding: 0.25em;
box-sizing: border-box;
}


img {
border: 0;
max-width: 100%;
Expand Down Expand Up @@ -215,11 +199,6 @@ table.modindextable td {

/* -- general body styles --------------------------------------------------- */

div.body {
min-width: 450px;
max-width: 800px;
}

div.body p, div.body dd, div.body li, div.body blockquote {
-moz-hyphens: auto;
-ms-hyphens: auto;
Expand Down Expand Up @@ -431,13 +410,6 @@ table.field-list td, table.field-list th {
hyphens: manual;
}

/* -- hlist styles ---------------------------------------------------------- */

table.hlist td {
vertical-align: top;
}


/* -- other body styles ----------------------------------------------------- */

ol.arabic {
Expand Down
3 changes: 2 additions & 1 deletion src/main/webapp/static/docs/html/_static/css/badge_only.css

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit dc31447

Please sign in to comment.