Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Browse files

Add basic API docs.

  • Loading branch information...
commit a1c4549db59e5c986b5ff9a17213e4dac5bd82f4 1 parent 83f1e7e
@GraylinKim GraylinKim authored
View
130 docs/Makefile
@@ -0,0 +1,130 @@
+# Makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line.
+SPHINXOPTS =
+SPHINXBUILD = sphinx-build
+PAPER =
+BUILDDIR = build
+
+# Internal variables.
+PAPEROPT_a4 = -D latex_paper_size=a4
+PAPEROPT_letter = -D latex_paper_size=letter
+ALLSPHINXOPTS = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
+
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest
+
+help:
+ @echo "Please use \`make <target>' where <target> is one of"
+ @echo " html to make standalone HTML files"
+ @echo " dirhtml to make HTML files named index.html in directories"
+ @echo " singlehtml to make a single large HTML file"
+ @echo " pickle to make pickle files"
+ @echo " json to make JSON files"
+ @echo " htmlhelp to make HTML files and a HTML help project"
+ @echo " qthelp to make HTML files and a qthelp project"
+ @echo " devhelp to make HTML files and a Devhelp project"
+ @echo " epub to make an epub"
+ @echo " latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
+ @echo " latexpdf to make LaTeX files and run them through pdflatex"
+ @echo " text to make text files"
+ @echo " man to make manual pages"
+ @echo " changes to make an overview of all changed/added/deprecated items"
+ @echo " linkcheck to check all external links for integrity"
+ @echo " doctest to run all doctests embedded in the documentation (if enabled)"
+
+clean:
+ -rm -rf $(BUILDDIR)/*
+
+html:
+ $(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
+
+dirhtml:
+ $(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
+ @echo
+ @echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
+
+singlehtml:
+ $(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
+ @echo
+ @echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
+
+pickle:
+ $(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
+ @echo
+ @echo "Build finished; now you can process the pickle files."
+
+json:
+ $(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
+ @echo
+ @echo "Build finished; now you can process the JSON files."
+
+htmlhelp:
+ $(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
+ @echo
+ @echo "Build finished; now you can run HTML Help Workshop with the" \
+ ".hhp project file in $(BUILDDIR)/htmlhelp."
+
+qthelp:
+ $(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
+ @echo
+ @echo "Build finished; now you can run "qcollectiongenerator" with the" \
+ ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
+ @echo "# qcollectiongenerator $(BUILDDIR)/qthelp/OpenLegislation.qhcp"
+ @echo "To view the help file:"
+ @echo "# assistant -collectionFile $(BUILDDIR)/qthelp/OpenLegislation.qhc"
+
+devhelp:
+ $(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
+ @echo
+ @echo "Build finished."
+ @echo "To view the help file:"
+ @echo "# mkdir -p $$HOME/.local/share/devhelp/OpenLegislation"
+ @echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/OpenLegislation"
+ @echo "# devhelp"
+
+epub:
+ $(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
+ @echo
+ @echo "Build finished. The epub file is in $(BUILDDIR)/epub."
+
+latex:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo
+ @echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
+ @echo "Run \`make' in that directory to run these through (pdf)latex" \
+ "(use \`make latexpdf' here to do that automatically)."
+
+latexpdf:
+ $(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
+ @echo "Running LaTeX files through pdflatex..."
+ make -C $(BUILDDIR)/latex all-pdf
+ @echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
+
+text:
+ $(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
+ @echo
+ @echo "Build finished. The text files are in $(BUILDDIR)/text."
+
+man:
+ $(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
+ @echo
+ @echo "Build finished. The manual pages are in $(BUILDDIR)/man."
+
+changes:
+ $(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
+ @echo
+ @echo "The overview file is in $(BUILDDIR)/changes."
+
+linkcheck:
+ $(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
+ @echo
+ @echo "Link check complete; look for any errors in the above output " \
+ "or in $(BUILDDIR)/linkcheck/output.txt."
+
+doctest:
+ $(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
+ @echo "Testing of doctests in the sources finished, look at the " \
+ "results in $(BUILDDIR)/doctest/output.txt."
View
170 docs/make.bat
@@ -0,0 +1,170 @@
+@ECHO OFF
+
+REM Command file for Sphinx documentation
+
+if "%SPHINXBUILD%" == "" (
+ set SPHINXBUILD=sphinx-build
+)
+set BUILDDIR=build
+set ALLSPHINXOPTS=-d %BUILDDIR%/doctrees %SPHINXOPTS% source
+if NOT "%PAPER%" == "" (
+ set ALLSPHINXOPTS=-D latex_paper_size=%PAPER% %ALLSPHINXOPTS%
+)
+
+if "%1" == "" goto help
+
+if "%1" == "help" (
+ :help
+ echo.Please use `make ^<target^>` where ^<target^> is one of
+ echo. html to make standalone HTML files
+ echo. dirhtml to make HTML files named index.html in directories
+ echo. singlehtml to make a single large HTML file
+ echo. pickle to make pickle files
+ echo. json to make JSON files
+ echo. htmlhelp to make HTML files and a HTML help project
+ echo. qthelp to make HTML files and a qthelp project
+ echo. devhelp to make HTML files and a Devhelp project
+ echo. epub to make an epub
+ echo. latex to make LaTeX files, you can set PAPER=a4 or PAPER=letter
+ echo. text to make text files
+ echo. man to make manual pages
+ echo. changes to make an overview over all changed/added/deprecated items
+ echo. linkcheck to check all external links for integrity
+ echo. doctest to run all doctests embedded in the documentation if enabled
+ goto end
+)
+
+if "%1" == "clean" (
+ for /d %%i in (%BUILDDIR%\*) do rmdir /q /s %%i
+ del /q /s %BUILDDIR%\*
+ goto end
+)
+
+if "%1" == "html" (
+ %SPHINXBUILD% -b html %ALLSPHINXOPTS% %BUILDDIR%/html
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The HTML pages are in %BUILDDIR%/html.
+ goto end
+)
+
+if "%1" == "dirhtml" (
+ %SPHINXBUILD% -b dirhtml %ALLSPHINXOPTS% %BUILDDIR%/dirhtml
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The HTML pages are in %BUILDDIR%/dirhtml.
+ goto end
+)
+
+if "%1" == "singlehtml" (
+ %SPHINXBUILD% -b singlehtml %ALLSPHINXOPTS% %BUILDDIR%/singlehtml
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The HTML pages are in %BUILDDIR%/singlehtml.
+ goto end
+)
+
+if "%1" == "pickle" (
+ %SPHINXBUILD% -b pickle %ALLSPHINXOPTS% %BUILDDIR%/pickle
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; now you can process the pickle files.
+ goto end
+)
+
+if "%1" == "json" (
+ %SPHINXBUILD% -b json %ALLSPHINXOPTS% %BUILDDIR%/json
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; now you can process the JSON files.
+ goto end
+)
+
+if "%1" == "htmlhelp" (
+ %SPHINXBUILD% -b htmlhelp %ALLSPHINXOPTS% %BUILDDIR%/htmlhelp
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; now you can run HTML Help Workshop with the ^
+.hhp project file in %BUILDDIR%/htmlhelp.
+ goto end
+)
+
+if "%1" == "qthelp" (
+ %SPHINXBUILD% -b qthelp %ALLSPHINXOPTS% %BUILDDIR%/qthelp
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; now you can run "qcollectiongenerator" with the ^
+.qhcp project file in %BUILDDIR%/qthelp, like this:
+ echo.^> qcollectiongenerator %BUILDDIR%\qthelp\OpenLegislation.qhcp
+ echo.To view the help file:
+ echo.^> assistant -collectionFile %BUILDDIR%\qthelp\OpenLegislation.ghc
+ goto end
+)
+
+if "%1" == "devhelp" (
+ %SPHINXBUILD% -b devhelp %ALLSPHINXOPTS% %BUILDDIR%/devhelp
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished.
+ goto end
+)
+
+if "%1" == "epub" (
+ %SPHINXBUILD% -b epub %ALLSPHINXOPTS% %BUILDDIR%/epub
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The epub file is in %BUILDDIR%/epub.
+ goto end
+)
+
+if "%1" == "latex" (
+ %SPHINXBUILD% -b latex %ALLSPHINXOPTS% %BUILDDIR%/latex
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished; the LaTeX files are in %BUILDDIR%/latex.
+ goto end
+)
+
+if "%1" == "text" (
+ %SPHINXBUILD% -b text %ALLSPHINXOPTS% %BUILDDIR%/text
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The text files are in %BUILDDIR%/text.
+ goto end
+)
+
+if "%1" == "man" (
+ %SPHINXBUILD% -b man %ALLSPHINXOPTS% %BUILDDIR%/man
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Build finished. The manual pages are in %BUILDDIR%/man.
+ goto end
+)
+
+if "%1" == "changes" (
+ %SPHINXBUILD% -b changes %ALLSPHINXOPTS% %BUILDDIR%/changes
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.The overview file is in %BUILDDIR%/changes.
+ goto end
+)
+
+if "%1" == "linkcheck" (
+ %SPHINXBUILD% -b linkcheck %ALLSPHINXOPTS% %BUILDDIR%/linkcheck
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Link check complete; look for any errors in the above output ^
+or in %BUILDDIR%/linkcheck/output.txt.
+ goto end
+)
+
+if "%1" == "doctest" (
+ %SPHINXBUILD% -b doctest %ALLSPHINXOPTS% %BUILDDIR%/doctest
+ if errorlevel 1 exit /b 1
+ echo.
+ echo.Testing of doctests in the sources finished, look at the ^
+results in %BUILDDIR%/doctest/output.txt.
+ goto end
+)
+
+:end
View
256 docs/source/conf.py
@@ -0,0 +1,256 @@
+# -*- coding: utf-8 -*-
+#
+# OpenLegislation documentation build configuration file, created by
+# sphinx-quickstart on Tue Sep 13 13:55:14 2011.
+#
+# This file is execfile()d with the current directory set to its containing dir.
+#
+# Note that not all possible configuration values are present in this
+# autogenerated file.
+#
+# All configuration values have a default; values that are commented out
+# serve to show the default.
+
+import sys, os
+
+# If extensions (or modules to document with autodoc) are in another directory,
+# add these directories to sys.path here. If the directory is relative to the
+# documentation root, use os.path.abspath to make it absolute, like shown here.
+#sys.path.insert(0, os.path.abspath('.'))
+
+# -- General configuration -----------------------------------------------------
+
+# If your documentation needs a minimal Sphinx version, state it here.
+#needs_sphinx = '1.0'
+
+# Add any Sphinx extension module names here, as strings. They can be extensions
+# coming with Sphinx (named 'sphinx.ext.*') or your custom ones.
+extensions = ['sphinx.ext.todo']
+
+# Add any paths that contain templates here, relative to this directory.
+templates_path = ['_templates']
+
+# The suffix of source filenames.
+source_suffix = '.rst'
+
+# The encoding of source files.
+#source_encoding = 'utf-8-sig'
+
+# The master toctree document.
+master_doc = 'index'
+
+# General information about the project.
+project = u'OpenLegislation'
+copyright = u'2011, NY Senate Technology Services'
+
+# The version info for the project you're documenting, acts as replacement for
+# |version| and |release|, also used in various other places throughout the
+# built documents.
+#
+# The short X.Y version.
+version = '2.0'
+# The full version, including alpha/beta/rc tags.
+release = '2.0'
+
+# The language for content autogenerated by Sphinx. Refer to documentation
+# for a list of supported languages.
+#language = None
+
+# There are two options for replacing |today|: either, you set today to some
+# non-false value, then it is used:
+#today = ''
+# Else, today_fmt is used as the format for a strftime call.
+#today_fmt = '%B %d, %Y'
+
+# List of patterns, relative to source directory, that match files and
+# directories to ignore when looking for source files.
+exclude_patterns = []
+
+# The reST default role (used for this markup: `text`) to use for all documents.
+#default_role = None
+
+# If true, '()' will be appended to :func: etc. cross-reference text.
+#add_function_parentheses = True
+
+# If true, the current module name will be prepended to all description
+# unit titles (such as .. function::).
+#add_module_names = True
+
+# If true, sectionauthor and moduleauthor directives will be shown in the
+# output. They are ignored by default.
+#show_authors = False
+
+# The name of the Pygments (syntax highlighting) style to use.
+pygments_style = 'sphinx'
+
+# A list of ignored prefixes for module index sorting.
+#modindex_common_prefix = []
+
+
+# -- Options for HTML output ---------------------------------------------------
+
+# The theme to use for HTML and HTML Help pages. See the documentation for
+# a list of builtin themes.
+html_theme = 'nature'
+
+# Theme options are theme-specific and customize the look and feel of a theme
+# further. For a list of options available for each theme, see the
+# documentation.
+#html_theme_options = {}
+
+# Add any paths that contain custom themes here, relative to this directory.
+#html_theme_path = []
+
+# The name for this set of Sphinx documents. If None, it defaults to
+# "<project> v<release> documentation".
+#html_title = None
+
+# A shorter title for the navigation bar. Default is the same as html_title.
+#html_short_title = None
+
+# The name of an image file (relative to this directory) to place at the top
+# of the sidebar.
+#html_logo = None
+
+# The name of an image file (within the static path) to use as favicon of the
+# docs. This file should be a Windows icon file (.ico) being 16x16 or 32x32
+# pixels large.
+#html_favicon = None
+
+# Add any paths that contain custom static files (such as style sheets) here,
+# relative to this directory. They are copied after the builtin static files,
+# so a file named "default.css" will overwrite the builtin "default.css".
+html_static_path = ['_static']
+
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
+# using the given strftime format.
+#html_last_updated_fmt = '%b %d, %Y'
+
+# If true, SmartyPants will be used to convert quotes and dashes to
+# typographically correct entities.
+#html_use_smartypants = True
+
+# Custom sidebar templates, maps document names to template names.
+#html_sidebars = {}
+
+# Additional templates that should be rendered to pages, maps page names to
+# template names.
+#html_additional_pages = {}
+
+# If false, no module index is generated.
+#html_domain_indices = True
+
+# If false, no index is generated.
+#html_use_index = True
+
+# If true, the index is split into individual pages for each letter.
+#html_split_index = False
+
+# If true, links to the reST sources are added to the pages.
+#html_show_sourcelink = True
+
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
+#html_show_sphinx = True
+
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
+#html_show_copyright = True
+
+# If true, an OpenSearch description file will be output, and all pages will
+# contain a <link> tag referring to it. The value of this option must be the
+# base URL from which the finished HTML is served.
+#html_use_opensearch = ''
+
+# This is the file name suffix for HTML files (e.g. ".xhtml").
+#html_file_suffix = None
+
+# Output file base name for HTML help builder.
+htmlhelp_basename = 'OpenLegislationdoc'
+
+
+# -- Options for LaTeX output --------------------------------------------------
+
+# The paper size ('letter' or 'a4').
+#latex_paper_size = 'letter'
+
+# The font size ('10pt', '11pt' or '12pt').
+#latex_font_size = '10pt'
+
+# Grouping the document tree into LaTeX files. List of tuples
+# (source start file, target name, title, author, documentclass [howto/manual]).
+latex_documents = [
+ ('index', 'OpenLegislation.tex', u'OpenLegislation Documentation',
+ u'NY Senate Technology Services', 'manual'),
+]
+
+# The name of an image file (relative to this directory) to place at the top of
+# the title page.
+#latex_logo = None
+
+# For "manual" documents, if this is true, then toplevel headings are parts,
+# not chapters.
+#latex_use_parts = False
+
+# If true, show page references after internal links.
+#latex_show_pagerefs = False
+
+# If true, show URL addresses after external links.
+#latex_show_urls = False
+
+# Additional stuff for the LaTeX preamble.
+#latex_preamble = ''
+
+# Documents to append as an appendix to all manuals.
+#latex_appendices = []
+
+# If false, no module index is generated.
+#latex_domain_indices = True
+
+
+# -- Options for manual page output --------------------------------------------
+
+# One entry per manual page. List of tuples
+# (source start file, name, description, authors, manual section).
+man_pages = [
+ ('index', 'openlegislation', u'OpenLegislation Documentation',
+ [u'NY Senate Technology Services'], 1)
+]
+
+
+# -- Options for Epub output ---------------------------------------------------
+
+# Bibliographic Dublin Core info.
+epub_title = u'OpenLegislation'
+epub_author = u'NY Senate Technology Services'
+epub_publisher = u'NY Senate Technology Services'
+epub_copyright = u'2011, NY Senate Technology Services'
+
+# The language of the text. It defaults to the language option
+# or en if the language is not set.
+#epub_language = ''
+
+# The scheme of the identifier. Typical schemes are ISBN or URL.
+#epub_scheme = ''
+
+# The unique identifier of the text. This can be a ISBN number
+# or the project homepage.
+#epub_identifier = ''
+
+# A unique identification for the text.
+#epub_uid = ''
+
+# HTML files that should be inserted before the pages created by sphinx.
+# The format is a list of tuples containing the path and title.
+#epub_pre_files = []
+
+# HTML files shat should be inserted after the pages created by sphinx.
+# The format is a list of tuples containing the path and title.
+#epub_post_files = []
+
+# A list of files that should not be packed into the epub file.
+#epub_exclude_files = []
+
+# The depth of the table of contents in toc.ncx.
+#epub_tocdepth = 3
+
+# Allow duplicate toc entries.
+#epub_tocdup = True
View
355 docs/source/index.rst
@@ -0,0 +1,355 @@
+The OpenLegislation API
+============================
+
+The OpenLegislation API exposes methods for retrieval of individual documents
+by object id as well as retrieval of arbitrary feeds by supported by the `Lucene`_
+document search engine. The API has full support for ``XML`` and ``JSON``
+standard formats as well as support for ``RSS`` and ``ATOM`` formats for all
+search queries.
+
+The available toplevel document types are currently:
+
+* Bill_
+* Meeting_
+* Calendar_
+* Transcript_
+
+Additionally, we have produced json files for `senator` and `committee` data
+to provide limited support for information from the NYSenate.gov site. A
+deeper integration would require using the SenateServices library which can
+be provided as necessary.
+
+
+Document Requests
+~~~~~~~~~~~~~~~~~~~~
+
+The API offers a series of document requests in the following general format::
+
+ legislation/2.0/<object type>/<object id>.<format>
+
+Available object types and the format of their object ids.
+
++-------------+--------------------------------------+----------------------------+
+| Object Type | Object Id Format | Example |
++=============+======================================+============================+
+| Bill | <bill id>-YYYY | S1234-2011 |
++-------------+--------------------------------------+----------------------------+
+| Meeting | <committee>-MM-DD-YYY | Finance-06-24-2011 |
++-------------+--------------------------------------+----------------------------+
+| Calendar | <floor|active>-MM-DD-YYYY | floor-06-24-2011 |
++-------------+--------------------------------------+----------------------------+
+| Transcript | <regular|special>-session-MM-DD-YYYY | regular-session-08-03-2011 |
++-------------+--------------------------------------+----------------------------+
+
+These requests are really just specialized cases of the search request for which
+the details are handled internally in the OpenLegislation system.
+
+Search Requests
+~~~~~~~~~~~~~~~~~~~~~~~
+
+The API's primary offering is the search request that enables custom lucene queries::
+
+ legislation/2.0/search.<format>?term=<lucene query>
+
+The lucene query can be any `valid lucene query`_ composed of any logically valid
+combination of the documents fields in the section below.
+
+Search Parameters
+-----------------------
+
+Search requests can take advantage of several other parameters as well.
+
++-----------+--------------------+--------------------------------------------------------+
+| Parameter | Values | Description |
++===========+====================+========================================================+
+| pageSize | 1-1000 | Limits the number of results returned by each request. |
++-----------+--------------------+--------------------------------------------------------+
+| pageIdx | 1+ | Indicates the which page of results you want. |
++-----------+--------------------+--------------------------------------------------------+
+| sortOrder | true/false | True - Descending, False -Decending by the sort field. |
++-----------+--------------------+--------------------------------------------------------+
+| sort | any document field | sorts the result set by the indicated document field. |
++-----------+--------------------+--------------------------------------------------------+
+
+
+The Fields Table
+--------------------
+
+.. note::
+
+ - Dates are in Mon DD, YYYY format and usually correspond to the document when field.
+ - <XXXX> refers to field XXXX of the same document.
+
+Becuase documents are organized into different structures based on otype you must be careful
+that all the fields you reference in your (sub)query are present in all the document types
+that you intend to retrieve. Mixing fields incorrectly will give you empty set results.
+
++-----------------+------------------+--------------------------------------------------------+
+| Document Type | Document Field | Field Description |
++=================+==================+========================================================+
+| **ALL** |
++-----------------+------------------+--------------------------------------------------------+
+| | modified | Unix time stamp of when document was last modified. |
++-----------------+------------------+--------------------------------------------------------+
+| | active | Boolean value indicating if the document is active. |
++-----------------+------------------+--------------------------------------------------------+
+| | oid | A document's unique object id. |
++-----------------+------------------+--------------------------------------------------------+
+| | otype | The document type of the bill. |
++-----------------+------------------+--------------------------------------------------------+
+| | osearch | The default search field. Contect varies by otype. |
++-----------------+------------------+--------------------------------------------------------+
+| |
++-----------------+------------------+--------------------------------------------------------+
+| **action** *(sub-document of the bill document)* |
++-----------------+------------------+--------------------------------------------------------+
+| | oid | <billno>-<when>-<title> |
++-----------------+------------------+--------------------------------------------------------+
+| | otype | ``action`` |
++-----------------+------------------+--------------------------------------------------------+
+| | osearch | <billno> <title> |
++-----------------+------------------+--------------------------------------------------------+
+| | billno | The parent bill number. |
++-----------------+------------------+--------------------------------------------------------+
+| | title | The action text. |
++-----------------+------------------+--------------------------------------------------------+
+| | when | The unix time stamp for the action |
++-----------------+------------------+--------------------------------------------------------+
+| |
++-----------------+------------------+--------------------------------------------------------+
+| **bill** |
++-----------------+------------------+--------------------------------------------------------+
+| | oid | <bill number>-<year> |
++-----------------+------------------+--------------------------------------------------------+
+| | otype | ``bill`` |
++-----------------+------------------+--------------------------------------------------------+
+| | osearch | <bill number> <sameas> <sponsor> <summary> <title> |
++-----------------+------------------+--------------------------------------------------------+
+| | actclause | The bill act clause |
++-----------------+------------------+--------------------------------------------------------+
+| | actions | Contains the text for all the bill's previous actions. |
++-----------------+------------------+--------------------------------------------------------+
+| | committee | The name of the current committee holding the bill. |
++-----------------+------------------+--------------------------------------------------------+
+| | cosponsors | Contains the short names of all bill cosponsors. |
++-----------------+------------------+--------------------------------------------------------+
+| | full | The full text of the bill. |
++-----------------+------------------+--------------------------------------------------------+
+| | lawsection | The lawsection of the bill, i.e. General Business Law. |
++-----------------+------------------+--------------------------------------------------------+
+| | memo | The bill memo. |
++-----------------+------------------+--------------------------------------------------------+
+| | pastcommittees | Contains the names of all the bills past committees. |
++-----------------+------------------+--------------------------------------------------------+
+| | sameas | Specifies the id of the bill's sister document. Senate |
+| | | bills introduced in the assembly and visa versa. |
++-----------------+------------------+--------------------------------------------------------+
+| | sponsor | The short name of the bill sponsor. |
++-----------------+------------------+--------------------------------------------------------+
+| | stricken | Boolean value indicating if the bill has been stricken.|
++-----------------+------------------+--------------------------------------------------------+
+| | summary | The bill summary text. |
++-----------------+------------------+--------------------------------------------------------+
+| | title | The bill title. |
++-----------------+------------------+--------------------------------------------------------+
+| | year | The bill session year (2009, 2011, etc.) |
++-----------------+------------------+--------------------------------------------------------+
+| |
++-----------------+------------------+--------------------------------------------------------+
+| **calendar** |
++-----------------+------------------+--------------------------------------------------------+
+| | oid | <ctype>-MM-DD-YYYY |
++-----------------+------------------+--------------------------------------------------------+
+| | otype | ``calendar`` |
++-----------------+------------------+--------------------------------------------------------+
+| | osearch | <title> |
++-----------------+------------------+--------------------------------------------------------+
+| | bills | Contains all the oids for the calendar's bills. |
++-----------------+------------------+--------------------------------------------------------+
+| | ctype | Calendar type, either ``floor`` or ``active`` |
++-----------------+------------------+--------------------------------------------------------+
+| | summary | <calendar notes or calendar name> - <# of bills> |
++-----------------+------------------+--------------------------------------------------------+
+| | title | <calendar number> - <ctype> - <calendar date> |
++-----------------+------------------+--------------------------------------------------------+
+| | when | unix timestamp of the calendar datetime. |
++-----------------+------------------+--------------------------------------------------------+
+| |
++-----------------+------------------+--------------------------------------------------------+
+| **meeting** |
++-----------------+------------------+--------------------------------------------------------+
+| | oid | <committee>-MM-DD-YYYY |
++-----------------+------------------+--------------------------------------------------------+
+| | otype | ``meeting`` |
++-----------------+------------------+--------------------------------------------------------+
+| | osearch | <committee> - <chair> - <location> - <note> |
++-----------------+------------------+--------------------------------------------------------+
+| | bills | Contains the oids of bill the meeting's bills. |
++-----------------+------------------+--------------------------------------------------------+
+| | chair | A freetext field representing the chair person's name. |
++-----------------+------------------+--------------------------------------------------------+
+| | committee | The name of the committee that is meeting. |
++-----------------+------------------+--------------------------------------------------------+
+| | location | The name of the room the meeting was held in. |
++-----------------+------------------+--------------------------------------------------------+
+| | notes | A text field for miscellaneous meeting notes. |
++-----------------+------------------+--------------------------------------------------------+
+| | title | <committee - <meeting date> |
++-----------------+------------------+--------------------------------------------------------+
+| | when | unix timestamp of the meeting datetime. |
++-----------------+------------------+--------------------------------------------------------+
+| |
++-----------------+------------------+--------------------------------------------------------+
+| **transcript** |
++-----------------+------------------+--------------------------------------------------------+
+| | oid | <session-type>-MM-DD-YY |
++-----------------+------------------+--------------------------------------------------------+
+| | otype | ``transcript`` |
++-----------------+------------------+--------------------------------------------------------+
+| | osearch | <full> |
++-----------------+------------------+--------------------------------------------------------+
+| | full | The full text of the transcript. |
++-----------------+------------------+--------------------------------------------------------+
+| | location | The location the transcript was recorded. |
++-----------------+------------------+--------------------------------------------------------+
+| | session-type | ``regular`` or ``extra-ordinary`` |
++-----------------+------------------+--------------------------------------------------------+
+| | summary | <location> |
++-----------------+------------------+--------------------------------------------------------+
+| | when | unix time stamp of when the transcript was recorded. |
++-----------------+------------------+--------------------------------------------------------+
+| |
++-----------------+------------------+--------------------------------------------------------+
+| **vote** *(sub-document of the bill document)* |
++-----------------+------------------+--------------------------------------------------------+
+| | oid | <when>-<billno>-<count(aye)>-<count(nay)> |
++-----------------+------------------+--------------------------------------------------------+
+| | otype | ``vote`` |
++-----------------+------------------+--------------------------------------------------------+
+| | osearch | <billno> - <voteType> |
++-----------------+------------------+--------------------------------------------------------+
+| | abstain | Contains short names for all abstaining senators. |
++-----------------+------------------+--------------------------------------------------------+
+| | aye | Contains short names for all the senators voting aye. |
++-----------------+------------------+--------------------------------------------------------+
+| | billno | The oid of the bill being voted on. |
++-----------------+------------------+--------------------------------------------------------+
+| | committee | If it is a committee vote, the name of the committee. |
++-----------------+------------------+--------------------------------------------------------+
+| | excused | Contains short names for all excused senators. |
++-----------------+------------------+--------------------------------------------------------+
+| | nay | Contains short names for all the senators voting nay. |
++-----------------+------------------+--------------------------------------------------------+
+| | summary | <vote date> |
++-----------------+------------------+--------------------------------------------------------+
+| | title | <billno> - <vote date> - <voteType> |
++-----------------+------------------+--------------------------------------------------------+
+| | voteType | A 1 or a 2 for ``FLOOR`` or ``COMMITTEE`` votes. |
++-----------------+------------------+--------------------------------------------------------+
+| | when | unix timestamp of the vote datetime. |
++-----------------+------------------+--------------------------------------------------------+
+
+
+
+
+Result Structure
+~~~~~~~~~~~~~~~~~~~~
+
+All request results are returned within a response object with the following
+structure::
+
+ {"response": {
+ "metadata": {
+ "totalresults": <number>,
+ },
+ "results": [{
+ "type": <object type>,
+ "oid": <unique object id>,
+ "url": <url for the corresponding webpage>,
+ "data": {
+ #Object specific data structure
+ }
+ }, {
+ #Next object
+ }, {
+ ....
+ }]
+ }
+
+Document requests will have always have a single result object in
+the results list. We use the same response structure regardless of the access
+method or result count for consistency and because all access paths are really
+just specialized shortcuts for the search request.
+
+Metadata
+------------------
+
+
+The metadata response property currently only reports the totalresults returned
+from the generated (or supplied) lucene query. For document requests this should
+always be 1. The property will be expanded as necessary to include other useful
+and relevant metadata in the future.
+
+
+Results
+-----------------
+
+Each result object has type, oid, and html link information in addition to the
+complete serialization of the matching document. This is to prevent the need to
+perform a search and then perform a series of document requests for further
+information.
+
+When possible, please use the provided values for oid, url links, and other
+items as they become available. As OpenLegislation changes over time, these
+fields will be updated and remain correct while those that you generate will
+be depreciated. If you find yourself generating information that you think is
+generally useful and could be supplied in the response `let us know`_.
+
+
+Document Structure
+~~~~~~~~~~~~~~~~~~~~~~~~
+
+Each document and subdocument has its own structure which reflects the full
+amount of information we have available at current time with exception to
+instances where including information could cause cycles in the object
+serialization process.
+
+Bill
+---------
+
+Bill Stuff
+
+Action
+**********
+
+Action stuff
+
+Vote
+*******
+
+Vote Stuff
+
+Meeting
+----------
+
+Meeting stuff
+
+Calendar
+-----------
+
+Calendar Stuff
+
+Transcript
+------------
+
+Transcript Stuff
+
+
+Examples
+=============
+
+.. _senator: http://open.nysenate.gov/legislation/senators.json
+.. _committee: http://open.nysenate.gov/legislation/committees.json
+.. _Lucene: http://lucene.apache.org
+.. _valid lucene query: http://lucene.apache.org/java/3_3_0/queryparsersyntax.html
+.. _let us know: williams@nysenate.gov
View
20 docs/source/index.rst.old
@@ -0,0 +1,20 @@
+.. OpenLegislation documentation master file, created by
+ sphinx-quickstart on Tue Sep 13 13:55:14 2011.
+ You can adapt this file completely to your liking, but it should at least
+ contain the root `toctree` directive.
+
+Welcome to OpenLegislation's documentation!
+===========================================
+
+Contents:
+
+.. toctree::
+ :maxdepth: 2
+
+Indices and tables
+==================
+
+* :ref:`genindex`
+* :ref:`modindex`
+* :ref:`search`
+
Please sign in to comment.
Something went wrong with that request. Please try again.