Skip to content

Commit

Permalink
added API usage instructions to the docs
Browse files Browse the repository at this point in the history
  • Loading branch information
stouffers committed Oct 27, 2015
1 parent cc99c02 commit c48b07c
Show file tree
Hide file tree
Showing 67 changed files with 13,233 additions and 1,672 deletions.
19 changes: 19 additions & 0 deletions docs/index.rst
Expand Up @@ -19,6 +19,25 @@ The code is open source and available on `Github`_.
.. _nysenate.gov: http://www.nysenate.gov
.. _Github: http://github.com/nysenate/OpenLegislation

API Usage
---------

**Obtaining a key**

To register and obtain an API key, visit our main page `here <http://legislation.nysenate.gov>`_.

**Making requests**

All URIs listed in these docs are relative to the Open Legislation subdomain:
::
legislation.nysenate.gov

To make an API request using your key, set the key string as the value of the 'key' request parameter in the request URL.

For example, if you wanted to get data for bill S1 of the 2015 session, your request would look something like this:
::
legislation.nysenate.gov/api/3/bills/2015/S1?key=*your key goes here*

Legislative Content Types
-------------------------

Expand Down
4 changes: 2 additions & 2 deletions src/main/webapp/Gruntfile.js
Expand Up @@ -13,7 +13,7 @@ module.exports = function(grunt) {
jsDest: '<%= jsRoot %>/dest',
jspSource: 'WEB-INF/view',
tagSource: 'WEB-INF/tags',
tomcatWeb: '/usr/share/tomcat7/webapps/legislation', // <-- CHANGE THIS AS NEEDED
tomcatWeb: '/usr/share/tomcat/webapps/legislation', // <-- CHANGE THIS AS NEEDED
docsSourceRoot: '../../../docs',
docsDestRoot: 'static/docs',

Expand Down Expand Up @@ -149,5 +149,5 @@ module.exports = function(grunt) {
grunt.loadNpmTasks('grunt-contrib-watch');
grunt.loadNpmTasks('grunt-shell');

grunt.registerTask('default', ['compass', 'concat', 'cssmin', 'uglify', 'copy']);
grunt.registerTask('default', ['compass', 'concat', 'cssmin', 'uglify', 'shell:docs', 'copy']);
};

0 comments on commit c48b07c

Please sign in to comment.