Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add Swagger Documention To The API #2227

Merged
merged 3 commits into from
Sep 7, 2017
Merged

Add Swagger Documention To The API #2227

merged 3 commits into from
Sep 7, 2017

Commits on Sep 6, 2017

  1. Geoprocessing API: Make snappingOn option for RWD

    Alice Rottersman committed Sep 6, 2017
    Configuration menu
    Copy the full SHA
    ad845a4 View commit details
    Browse the repository at this point in the history
  2. Geoprocessing API: Add django-rest-swagger and markdown packages

    * add django-rest-swagger to document the public API
    * add markdown to allow using markdown in the docstrings that show up in swagger
    * setup an initial swagger config with docs available at /api/docs
    Alice Rottersman committed Sep 6, 2017
    Configuration menu
    Copy the full SHA
    684a95e View commit details
    Browse the repository at this point in the history

Commits on Sep 7, 2017

  1. Geoprocessing API: Document API views

    * Write up an initial pass for the API views' documentation. Includes job
      descriptions as well as example requests, request types and formats, and
      example responses.
    
    * NB: The example responses make the docstrings incredibly lengthy. While they
      appear nicely in Swagger under <details> elements, we may need to consider
      declaring them outside the views file
    Alice Rottersman committed Sep 7, 2017
    Configuration menu
    Copy the full SHA
    c89db87 View commit details
    Browse the repository at this point in the history