Skip to content
Permalink
Browse files

Update api docs with warnings / fix typos

Various warnings have been added to the api docs to better help notify
users of the difference between process date time and publish date time.

Additionally some small typos have been fixed
  • Loading branch information...
aa29cala authored and stouffers committed Mar 19, 2019
1 parent f7242f6 commit b725a961a09f6431ebe2857058c7a880dc859aa8
@@ -53,7 +53,7 @@ Retrieve a specific committee within an agenda

**Examples**

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

@@ -124,7 +124,7 @@ Search agendas across all years for a term
| offset | Start the results from offset |
+-----------+-----------------------------------------------------------------------------------------+
+-----------+-----------------------------------------------------------------------------------------+
| type | Determine wether to use process date time or published date time |
| type | Determine whether to use process date time or published date time |
+-----------+-----------------------------------------------------------------------------------------+


@@ -139,6 +139,8 @@ Search agendas for a specific term
Get updated agenda Id's
-----------------------

.. warning:: The following api calls work (by default) on the process date time. If we reprocess our data, the timestamps listed may not produce the same results. You can use the published date time to get updates from an earlier time

**Usage**

Return a list of agenda ids that have changed during a specified date/time range
@@ -95,4 +95,6 @@ See the following pages for info on the unique updates responses for each conten
},
"fromDateTime" : "2014-01-10T00:00",
"toDateTime" : "2015-03-18T13:16:17.383999999"
}
}
.. warning:: This example uses processed date time. As we reprocess our data periodically, it's possible this specific api call may not produce the result shown. However, the response you receive will follow the format in the example
@@ -547,6 +547,9 @@ Bills that were updated between February 13, 2019 8:00:00AM and February 13, 201
... (truncated)
}
.. warning:: By default the type is set to 'processed'. As we reprocess our data periodically, it's possible this specific api call may not produce the result shown. However, the response you receive will follow the format in the example
.. _`update filters`:
You can filter the results of the API by specifying a specific type of update you are interested in. For example you
@@ -666,3 +669,5 @@ Sample response:
}
},
... (truncated)
.. warning:: By default the type is set to 'processed'. As we reprocess our data periodically, it's possible this specific api call may not produce the result shown. However, the response you receive will follow the format in the example
@@ -430,4 +430,6 @@ Get updates for calendar 54 of 2014 that occurred between 9 AM and 5 PM on June
],
"size" : 3
}
}
}
.. warning:: By default the type is set to 'processed'. As we reprocess our data periodically, it's possible this specific api call may not produce the result shown. However, the response you receive will follow the format in the example
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
@@ -53,7 +53,7 @@ Retrieve a specific committee within an agenda

**Examples**

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

@@ -124,7 +124,7 @@ Search agendas across all years for a term
| offset | Start the results from offset |
+-----------+-----------------------------------------------------------------------------------------+
+-----------+-----------------------------------------------------------------------------------------+
| type | Determine wether to use process date time or published date time |
| type | Determine whether to use process date time or published date time |
+-----------+-----------------------------------------------------------------------------------------+


@@ -139,6 +139,8 @@ Search agendas for a specific term
Get updated agenda Id's
-----------------------

.. warning:: The following api calls work (by default) on the process date time. If we reprocess our data, the timestamps listed may not produce the same results. You can use the published date time to get updates from an earlier time

**Usage**

Return a list of agenda ids that have changed during a specified date/time range
@@ -95,4 +95,6 @@ See the following pages for info on the unique updates responses for each conten
},
"fromDateTime" : "2014-01-10T00:00",
"toDateTime" : "2015-03-18T13:16:17.383999999"
}
}
.. warning:: This example uses processed date time. As we reprocess our data periodically, it's possible this specific api call may not produce the result shown. However, the response you receive will follow the format in the example
@@ -547,6 +547,9 @@ Bills that were updated between February 13, 2019 8:00:00AM and February 13, 201
... (truncated)
}
.. warning:: By default the type is set to 'processed'. As we reprocess our data periodically, it's possible this specific api call may not produce the result shown. However, the response you receive will follow the format in the example
.. _`update filters`:
You can filter the results of the API by specifying a specific type of update you are interested in. For example you
@@ -666,3 +669,5 @@ Sample response:
}
},
... (truncated)
.. warning:: By default the type is set to 'processed'. As we reprocess our data periodically, it's possible this specific api call may not produce the result shown. However, the response you receive will follow the format in the example
@@ -430,4 +430,6 @@ Get updates for calendar 54 of 2014 that occurred between 9 AM and 5 PM on June
],
"size" : 3
}
}
}
.. warning:: By default the type is set to 'processed'. As we reprocess our data periodically, it's possible this specific api call may not produce the result shown. However, the response you receive will follow the format in the example
@@ -219,7 +219,7 @@ <h2>Get a specific committee with an agenda<a class="headerlink" href="#get-a-sp
</pre></div>
</div>
<p><strong>Examples</strong></p>
<p>Request the Rules commitee agenda 2 of session year 2017</p>
<p>Request the Rules committee agenda 2 of session year 2017</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="o">/</span><span class="n">api</span><span class="o">/</span><span class="mi">3</span><span class="o">/</span><span class="n">agendas</span><span class="o">/</span><span class="mi">2017</span><span class="o">/</span><span class="mi">2</span><span class="o">/</span><span class="n">Rules</span>
</pre></div>
</div>
@@ -283,34 +283,6 @@ <h2>Search all agendas in a calendar year for a term<a class="headerlink" href="
<p class="last">The param term is required and the value of this parameter is whatever you are looking to find</p>
</div>
<p><strong>Optional Params</strong></p>
<table border="1" class="docutils">
<colgroup>
<col width="11%" />
<col width="89%" />
</colgroup>
<thead valign="bottom">
<tr class="row-odd"><th class="head">Parameter</th>
<th class="head">Values</th>
</tr>
</thead>
<tbody valign="top">
<tr class="row-even"><td>full</td>
<td>‘true’, ‘false’</td>
</tr>
<tr class="row-odd"><td>limit</td>
<td>Limit the number of results</td>
</tr>
<tr class="row-even"><td>offset</td>
<td>Start the results from offset</td>
</tr>
<tr class="row-odd"><td>&#160;</td>
<td>&#160;</td>
</tr>
<tr class="row-even"><td>type</td>
<td>Determine wether to use process date time or published date time</td>
</tr>
</tbody>
</table>
<p><strong>Examples</strong></p>
<p>Search agendas for a specific term</p>
<div class="highlight-default"><div class="highlight"><pre><span></span>/api/3/agendas/2017/search?term=crime&amp;full=false&amp;limit=10&amp;offset=5
@@ -319,6 +291,10 @@ <h2>Search all agendas in a calendar year for a term<a class="headerlink" href="
</div>
<div class="section" id="get-updated-agenda-id-s">
<h2>Get updated agenda Id’s<a class="headerlink" href="#get-updated-agenda-id-s" title="Permalink to this headline">¶</a></h2>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">The following api calls work (by default) on the process date time. If we reprocess our data, the timestamps listed may not produce the same results. You can use the published date time to get updates from an earlier time</p>
</div>
<p><strong>Usage</strong></p>
<p>Return a list of agenda ids that have changed during a specified date/time range</p>
<div class="highlight-default"><div class="highlight"><pre><span></span><span class="p">(</span><span class="n">GET</span><span class="p">)</span> <span class="o">/</span><span class="n">api</span><span class="o">/</span><span class="mi">3</span><span class="o">/</span><span class="n">agendas</span><span class="o">/</span><span class="n">updates</span><span class="o">/</span>
@@ -284,6 +284,10 @@ <h2>Get aggregate updates<a class="headerlink" href="#get-aggregate-updates" tit
<span class="p">}</span>
</pre></div>
</div>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">This example uses processed date time. As we reprocess our data periodically, it’s possible this specific api call may not produce the result shown. However, the response you receive will follow the format in the example</p>
</div>
</div>
</div>

@@ -774,6 +774,10 @@ <h2>Get bill updates<a class="headerlink" href="#get-bill-updates" title="Permal
<span class="p">}</span>
</pre></div>
</div>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">By default the type is set to ‘processed’. As we reprocess our data periodically, it’s possible this specific api call may not produce the result shown. However, the response you receive will follow the format in the example</p>
</div>
<p id="update-filters">You can filter the results of the API by specifying a specific type of update you are interested in. For example you
may only want to know which bills have had status updates, or which bills had full text changes.</p>
<p>Update Filters:</p>
@@ -904,6 +908,10 @@ <h2>Get bill updates<a class="headerlink" href="#get-bill-updates" title="Permal
<span class="p">...</span> <span class="p">(</span><span class="nx">truncated</span><span class="p">)</span>
</pre></div>
</div>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">By default the type is set to ‘processed’. As we reprocess our data periodically, it’s possible this specific api call may not produce the result shown. However, the response you receive will follow the format in the example</p>
</div>
</div>
</div>

@@ -666,6 +666,10 @@ <h2>Get specific calendar updates<a class="headerlink" href="#get-specific-calen
<span class="p">}</span>
</pre></div>
</div>
<div class="admonition warning">
<p class="first admonition-title">Warning</p>
<p class="last">By default the type is set to ‘processed’. As we reprocess our data periodically, it’s possible this specific api call may not produce the result shown. However, the response you receive will follow the format in the example</p>
</div>
</div>
</div>

0 comments on commit b725a96

Please sign in to comment.
You can’t perform that action at this time.