{{ page.title }}
+ +
+ {{ content }}
+
+
+
+
+
+
+ Series REST-API
+The 52°North Series API provides a thin access layer to series datasets via RESTful Web binding. It provides different output formats like json, pdf or png.
+ +
+
+ + +
+
+
\ No newline at end of file
diff --git a/web-resources/docs/.gitignore b/web-resources/docs/.gitignore
new file mode 100644
index 000000000..62bf7251e
--- /dev/null
+++ b/web-resources/docs/.gitignore
@@ -0,0 +1,10 @@
+_site
+.DS_Store
+.jekyll
+.jekyll-metadata
+.bundle
+.sass-cache
+Gemfile
+Gemfile.lock
+node_modules
+package.json
diff --git a/web-resources/docs/CNAME b/web-resources/docs/CNAME
new file mode 100644
index 000000000..8b1378917
--- /dev/null
+++ b/web-resources/docs/CNAME
@@ -0,0 +1 @@
+
diff --git a/web-resources/docs/_config.yml b/web-resources/docs/_config.yml
new file mode 100644
index 000000000..5a4de8f21
--- /dev/null
+++ b/web-resources/docs/_config.yml
@@ -0,0 +1,35 @@
+
+# Name of your site (displayed in the header)
+name: 52°North GmbH
+
+# Short bio or description (displayed in the header)
+description: Initiative for Geospatial Open Source Software
+
+# URL of your avatar or profile pic (you could use your GitHub profile pic)
+#avatar: https://raw.githubusercontent.com//master/images/jekyll-logo.png
+
+# Your website URL (e.g. http://barryclark.github.io or http://www.barryclark.co)
+# Used for Sitemap.xml and your RSS feed
+url:
+
+# If you're hosting your site at a Project repository on GitHub pages
+# (http://yourusername.github.io/repository-name)
+# and NOT your User repository (http://yourusername.github.io)
+# then add in the baseurl here, like this: "/repository-name"
+baseurl: "/docs"
+
+permalink: /:title/
+
+markdown: kramdown
+
+# Use the following plug-ins
+gems:
+ - jekyll-sitemap
+
+# Exclude these files from your production _site
+exclude:
+ - Gemfile
+ - Gemfile.lock
+ - LICENSE
+ - README.md
+ - CNAME
diff --git a/web-resources/docs/_data/swagger.yaml b/web-resources/docs/_data/swagger.yaml
new file mode 100644
index 000000000..a8d56d547
--- /dev/null
+++ b/web-resources/docs/_data/swagger.yaml
@@ -0,0 +1,1417 @@
+swagger: '2.0'
+info:
+ title: 52°North Series API
+ description: Thin Web binding API to access series data
+ version: 2.0.0
+host: example.org
+schemes:
+ - https
+basePath: /api/v1
+consumes:
+ - application/json
+produces:
+ - application/json
+paths:
+ /:
+ get:
+ summary: Available endpoints.
+ tags:
+ - general
+ description: >
+ A (static) collection of endpoints available from this API. Each includes a relative path and a short description.
+ responses:
+ '200':
+ description: A collection of API endpoints
+ /search:
+ get:
+ summary: A simple search.
+ tags:
+ - general
+ description: |
+ A simple search over all resource's labels over all available endpoints. Note that the searching respects the current locale being selected.
+ parameters:
+ - name: q
+ in: query
+ description: Term which shall match (case insensitive) a resource's label
+ required: true
+ type: string
+ - $ref: '#/parameters/localeParam'
+ responses:
+ '200':
+ description: A collection of search results
+
+ /platforms:
+ get:
+ summary: Available Platforms
+ tags:
+ - platform
+ - v2.0
+ description: |
+ A collection of available platforms. Depending on the `expanded` parameter the collections items are compact or do inline full metadata.
+
+
+ Filter options help to focus on a particular set of items. Filter either by parameters or spatially.
+ parameters:
+ - $ref: '#/parameters/localeParam'
+ - $ref: '#/parameters/expandedParam'
+ - $ref: '#/parameters/servicesParam'
+ - $ref: '#/parameters/categoriesParam'
+ - $ref: '#/parameters/phenomenaParam'
+ - $ref: '#/parameters/proceduresParam'
+ - $ref: '#/parameters/offeringsParam'
+ - $ref: '#/parameters/platformsParam'
+ - $ref: '#/parameters/stationsParam'
+ - $ref: '#/parameters/platformTypesParam'
+ - $ref: '#/parameters/geometryTypesParam'
+ - $ref: '#/parameters/platformGeometriesParam'
+ - $ref: '#/parameters/observedGeometriesParam'
+ - $ref: '#/parameters/datasetTypesParam'
+ - $ref: '#/parameters/crsParam'
+ - $ref: '#/parameters/bboxParam'
+ - $ref: '#/parameters/nearParam'
+ responses:
+ '200':
+ description: A collection of platforms
+ '400':
+ description: A query parameter does not match expected format
+ '415':
+ description: Media Item not supported
+ schema:
+ $ref: '#/definitions/Error'
+
+ '/platforms/{platformId}':
+ get:
+ summary: Gets a particular platform
+ tags:
+ - platform
+ - v2.0
+ description: |
+ Full view of a platform instance. A platform encodes a POINT geometry which is the actual location for `stationary` platforms and the last detected location for `mobile` platforms.
+ parameters:
+ - name: platformId
+ in: path
+ required: true
+ type: string
+ - $ref: '#/parameters/localeParam'
+ - $ref: '#/parameters/crsParam'
+ responses:
+ '200':
+ description: An expanded item
+ '400':
+ description: A query parameter does not match expected format
+ schema:
+ $ref: '#/definitions/Error'
+ '404':
+ description: Item not found
+ schema:
+ $ref: '#/definitions/Error'
+ '415':
+ description: Media Item not supported
+ schema:
+ $ref: '#/definitions/Error'
+ '/platforms/{platformId}/extras':
+ get:
+ summary: Gets extra infos for platform
+ tags:
+ - platform
+ - v2.0
+ description: >
+ Lists extra metadata which may vary from instance to instance. The available metadata fields are listed in the `extras` metadata field of each dataset.
+
+
+ You can query just the ones you are interested in by appending the `fields` query parameter and passing a comma-separated value list to it.
+ parameters:
+ - name: platformId
+ in: path
+ required: true
+ type: string
+ - name: fields
+ in: query
+ required: false
+ type: array
+ items:
+ type: string
+ collectionFormat: csv
+ responses:
+ '200':
+ description: An expanded item
+ '404':
+ description: Item not found
+ schema:
+ $ref: '#/definitions/Error'
+ '415':
+ description: Media Item not supported
+ schema:
+ $ref: '#/definitions/Error'
+
+
+ /stations:
+ get:
+ summary: Available Stations
+ tags:
+ - station
+ description: |
+ A collection of available stations. Depending on the `expanded` parameter the collections items are compact or do inline full metadata.
+
+
+ Filter options help to focus on a particular set of items. Filter either by parameters or spatially.
+ parameters:
+ - $ref: '#/parameters/localeParam'
+ - $ref: '#/parameters/expandedParam'
+ - $ref: '#/parameters/servicesParam'
+ - $ref: '#/parameters/categoriesParam'
+ - $ref: '#/parameters/phenomenaParam'
+ - $ref: '#/parameters/proceduresParam'
+ - $ref: '#/parameters/offeringsParam'
+ - $ref: '#/parameters/platformsParam'
+ - $ref: '#/parameters/stationsParam'
+ - $ref: '#/parameters/crsParam'
+ - $ref: '#/parameters/bboxParam'
+ - $ref: '#/parameters/nearParam'
+ responses:
+ '200':
+ description: A collection of stations
+ '400':
+ description: A query parameter does not match expected format
+ '415':
+ description: Media Item not supported
+ schema:
+ $ref: '#/definitions/Error'
+ '/stations/{stationId}':
+ get:
+ summary: Gets a particular station
+ tags:
+ - station
+ description: |
+ Full data view of a station. A station is a [GeoJSON point geometry](https://www.rfc-editor.org/info/rfc7946) which encodes available metadata in its `properties` member.
+ parameters:
+ - name: stationId
+ in: path
+ required: true
+ type: string
+ - $ref: '#/parameters/localeParam'
+ - $ref: '#/parameters/crsParam'
+ responses:
+ '200':
+ description: An expanded item
+ '400':
+ description: A query parameter does not match expected format
+ schema:
+ $ref: '#/definitions/Error'
+ '404':
+ description: Item not found
+ schema:
+ $ref: '#/definitions/Error'
+ '415':
+ description: Media Item not supported
+ schema:
+ $ref: '#/definitions/Error'
+ '/stations/{stationId}/extras':
+ get:
+ summary: Gets extra infos for station
+ tags:
+ - station
+ description: >
+ Lists extra metadata which may vary from instance to instance. The available metadata fields are listed in the `extras` metadata field of each dataset.
+
+
+ You can query just the ones you are interested in by appending the `fields` query parameter and passing a comma-separated value list to it.
+ parameters:
+ - name: stationId
+ in: path
+ required: true
+ type: string
+ - name: fields
+ in: query
+ required: false
+ type: array
+ items:
+ type: string
+ collectionFormat: csv
+ responses:
+ '200':
+ description: An expanded item
+ '404':
+ description: Item not found
+ schema:
+ $ref: '#/definitions/Error'
+ '415':
+ description: Media Item not supported
+ schema:
+ $ref: '#/definitions/Error'
+
+
+ /datasets:
+ get:
+ summary: Gets available datasets
+ tags:
+ - dataset
+ - v2.0
+ description: |
+ A collection of available datasets. Depending on the `expanded` parameter the collections items are compact or do inline full metadata.
+
+
+ Filter options help to focus on a particular set of items. Filter either by parameters or spatially.
+ parameters:
+ - $ref: '#/parameters/localeParam'
+ - $ref: '#/parameters/expandedParam'
+ - $ref: '#/parameters/servicesParam'
+ - $ref: '#/parameters/categoriesParam'
+ - $ref: '#/parameters/phenomenaParam'
+ - $ref: '#/parameters/proceduresParam'
+ - $ref: '#/parameters/offeringsParam'
+ - $ref: '#/parameters/platformsParam'
+ - $ref: '#/parameters/stationsParam'
+ - $ref: '#/parameters/platformTypesParam'
+ - $ref: '#/parameters/geometryTypesParam'
+ - $ref: '#/parameters/platformGeometriesParam'
+ - $ref: '#/parameters/observedGeometriesParam'
+ - $ref: '#/parameters/datasetTypesParam'
+ - $ref: '#/parameters/crsParam'
+ - $ref: '#/parameters/bboxParam'
+ - $ref: '#/parameters/nearParam'
+ responses:
+ '200':
+ description: A collection of datasets
+ '400':
+ description: A query parameter does not match expected format
+ '415':
+ description: Media Item not supported
+ schema:
+ $ref: '#/definitions/Error'
+
+ '/datasets/{datasetId}':
+ get:
+ summary: Gets a particular dataset
+ tags:
+ - dataset
+ - v2.0
+ description: |
+ Full view of a dataset instance. All relevant relations (parameters, unit, platform, etc.) are inlined. If any additional information is listed in the `extras` array member it can be retrieved via `/datasets/{datasetId}/extras` (see next).
+ parameters:
+ - name: datasetId
+ in: path
+ required: true
+ type: string
+ - $ref: '#/parameters/localeParam'
+ responses:
+ '200':
+ description: An expanded item
+ '404':
+ description: Item not found
+ schema:
+ $ref: '#/definitions/Error'
+ '415':
+ description: Media Item not supported
+ schema:
+ $ref: '#/definitions/Error'
+
+ '/datasets/{datasetId}/extras':
+ get:
+ summary: Gets extra infos for dataset
+ tags:
+ - dataset
+ - v2.0
+ description: >
+ Lists extra metadata which may vary from instance to instance. The available metadata fields are listed in the `extras` metadata field of each dataset.
+
+
+ You can query just the ones you are interested in by appending the `fields` query parameter and passing a comma-separated value list to it.
+ parameters:
+ - name: datasetId
+ in: path
+ required: true
+ type: string
+ - name: fields
+ in: query
+ required: false
+ type: array
+ items:
+ type: string
+ collectionFormat: csv
+ responses:
+ '200':
+ description: An expanded item
+ '404':
+ description: Item not found
+ schema:
+ $ref: '#/definitions/Error'
+ '415':
+ description: Media Item not supported
+ schema:
+ $ref: '#/definitions/Error'
+
+ '/datasets/{datasetId}/{interval}':
+ get:
+ summary: Gets extra infos for dataset
+ tags:
+ - dataset
+ - v2.0
+ description: >
+ Returns a pre-rendered image of a dataset for the given interval. Allowed interval values are
+
+ * `lastDay.png`
+
+ * `lastWeek.png`
+
+ * `lastMonth.png`
+
+
+ Datasets of type `quantity` can be pre-rendered by a regular task. If pre-rendering is enabled for a given datasets depends on the API provider as it is a configuration issue.
+ parameters:
+ - name: datasetId
+ in: path
+ required: true
+ type: string
+ - name: interval
+ in: path
+ required: true
+ type: string
+ responses:
+ '200':
+ description: A list of (selected) extra infos
+ '404':
+ description: In case no prerendered image available (or is currently being rendered)
+
+ '/datasets/{datasetId}/data':
+ get:
+ summary: Gets data of a dataset
+ tags:
+ - dataset
+ - v2.0
+ description: >
+ Gets data for a given `timespan` filter. Implementations may limit the maximum amount of time intervals a client can query in one request.
+
+
+ What Mime-Types are supported depends on the `datasetType`. For example `quantity` observations can be drawn as a timeseries chart (i.e. either `image/png` or `application/pdf`). Supported Mime-Types are listed for each `datasetType` when querying `/service/{serviceId}?datasetTypes=all`
+ produces:
+ - application/json
+ - image/png
+ - text/csv
+ - application/pdf
+ - application/zip
+ parameters:
+ - name: datasetId
+ in: path
+ required: true
+ type: string
+ - $ref: '#/parameters/expandedParam'
+ - $ref: '#/parameters/timespanParam'
+ responses:
+ '200':
+ description: Data for a given `timespan` in a requested output format
+ '400':
+ description: A query parameter does not match expected format
+ schema:
+ $ref: '#/definitions/Error'
+ '404':
+ description: Item not found
+ schema:
+ $ref: '#/definitions/Error'
+ '415':
+ description: Media Item not supported
+ schema:
+ $ref: '#/definitions/Error'
+
+ /timeseries:
+ get:
+ summary: Gets available timeseries
+ tags:
+ - timeseries
+ description: |
+ A collection of timeseries (i.e. datasets of type `quantity` which have been observed at `stationary`, `insitu` platforms having a 0-dimensional (POINT) location geometry. Depending on the `expanded` parameter the collections items are compact or do inline full metadata.
+
+
+ Filter options help to focus on a particular set of items. Filter either by parameters or spatially.
+ parameters:
+ - $ref: '#/parameters/localeParam'
+ - $ref: '#/parameters/expandedParam'
+ - $ref: '#/parameters/servicesParam'
+ - $ref: '#/parameters/categoriesParam'
+ - $ref: '#/parameters/phenomenaParam'
+ - $ref: '#/parameters/proceduresParam'
+ - $ref: '#/parameters/offeringsParam'
+ - $ref: '#/parameters/platformsParam'
+ - $ref: '#/parameters/stationsParam'
+ - $ref: '#/parameters/platformTypesParam'
+ - $ref: '#/parameters/datasetTypesParam'
+ - $ref: '#/parameters/crsParam'
+ - $ref: '#/parameters/bboxParam'
+ - $ref: '#/parameters/nearParam'
+ responses:
+ '200':
+ description: A collection of timeseries
+ '/timeseries/{timeseriesId}':
+ get:
+ summary: Gets a particular timeseries
+ tags:
+ - timeseries
+ description: |
+ Full view of a timeseries instance. All relevant relations (parameters, unit, station, etc.) are inlined. If any additional information is listed in the `extras` array member it can be retrieved via `/datasets/{datasetId}/extras` (see next).
+
+ For backward compatibility reasons metadata about `renderingHints` and `statusIntervals` are inlined here as well. However, those are listed within `extra` infos to make it consistent.
+ parameters:
+ - name: timeseriesId
+ in: path
+ required: true
+ type: string
+ - $ref: '#/parameters/localeParam'
+ responses:
+ '200':
+ description: An expanded item
+ '400':
+ description: A query parameter does not match expected format
+ schema:
+ $ref: '#/definitions/Error'
+ '404':
+ description: Item not found
+ schema:
+ $ref: '#/definitions/Error'
+ '415':
+ description: Media Item not supported
+ schema:
+ $ref: '#/definitions/Error'
+ '/timeseries/{timeseriesId}/extras':
+ get:
+ summary: Gets extra infos for timeseries
+ tags:
+ - timeseries
+ description: >
+ Lists extra metadata which may vary from instance to instance. The available metadata fields are listed in the `extras` metadata field of each timeseries.
+
+
+ You can query just the ones you are interested in by appending the `fields`query parameter and passing a comma-separated value list to it.
+ parameters:
+ - name: timeseriesId
+ in: path
+ required: true
+ type: string
+ - name: fields
+ in: query
+ required: false
+ type: array
+ items:
+ type: string
+ collectionFormat: csv
+ responses:
+ '200':
+ description: A list of (selected) extra infos
+ '404':
+ description: Item not found
+ schema:
+ $ref: '#/definitions/Error'
+ '415':
+ description: Media Item not supported
+ schema:
+ $ref: '#/definitions/Error'
+ '/timeseries/{timeseriesId}/getData':
+ get:
+ summary: Gets data of a timeseries
+ tags:
+ - timeseries
+ description: >
+ Gets data for a given `timespan` filter. Implementations may limit the maximum amount of time intervals a client can query in one request.
+
+
+ This operation does only return data of `quantity` dataset types from`stationary`, `insitu` platforms having a 0-dimensional location geometry (`station`). Supported Mime-Types are `application/json`, `image/png`, `application/pdf`, and `text/csv`.
+ produces:
+ - application/json
+ - image/png
+ - text/csv
+ - application/pdf
+ - application/zip
+ parameters:
+ - name: timeseriesId
+ in: path
+ required: true
+ type: string
+ - $ref: '#/parameters/expandedParam'
+ - $ref: '#/parameters/timespanParam'
+ - $ref: '#/parameters/widthParam'
+ - $ref: '#/parameters/heightParam'
+ - $ref: '#/parameters/legendParam'
+ - $ref: '#/parameters/gridParam'
+ - $ref: '#/parameters/generalizeParam'
+ - $ref: '#/parameters/formatParam'
+ - $ref: '#/parameters/base64Param'
+ responses:
+ '200':
+ description: Data for a given `timespan` in a requested output format
+ '400':
+ description: A query parameter does not match expected format
+ schema:
+ $ref: '#/definitions/Error'
+ '404':
+ description: Item not found
+ schema:
+ $ref: '#/definitions/Error'
+ '415':
+ description: Media Item not supported
+ schema:
+ $ref: '#/definitions/Error'
+
+ /geometries:
+ get:
+ summary: A collection of available geometries
+ tags:
+ - geometry
+ - v2.0
+ description: |
+ All available geometries instances. Possible geometry types are
+
+ * `site`, i.e. `stationary` platform locations (fixed)
+
+ * `track`, i.e. trajectories made by a `mobile` platform
+
+ * `static`, i.e. a fixed geometry observed by a `remote` platform
+
+ * `dynamic`, i.e. geometry observed by a `remote` platform which changes over time
+ parameters:
+ - $ref: '#/parameters/geometryTypesParam'
+ - $ref: '#/parameters/platformGeometriesParam'
+ - $ref: '#/parameters/observedGeometriesParam'
+ - $ref: '#/parameters/crsParam'
+ - $ref: '#/parameters/bboxParam'
+ - $ref: '#/parameters/nearParam'
+ responses:
+ '200':
+ description: A collection of geometries
+ /geometries/{geometryId}:
+ get:
+ summary: Gets a particular geometry
+ tags:
+ - geometry
+ - v2.0
+ description: |
+ Full view of a geometry instance. Encodes as full [GeoJSON geometry](https://www.rfc-editor.org/info/rfc7946).
+ parameters:
+ - name: geometryId
+ in: path
+ required: true
+ type: string
+ - $ref: '#/parameters/localeParam'
+ - $ref: '#/parameters/crsParam'
+ responses:
+ '200':
+ description: An expanded item
+ '400':
+ description: A query parameter does not match expected format
+ schema:
+ $ref: '#/definitions/Error'
+ '404':
+ description: Item not found
+ schema:
+ $ref: '#/definitions/Error'
+ '415':
+ description: Media Item not supported
+ schema:
+ $ref: '#/definitions/Error'
+
+ /services:
+ get:
+ summary: Get available service instances
+ tags:
+ - parameter
+ description: >
+ All available service instances. For backwards compatibility reasons the output is filtered by default to list only those instances related to `stationary`, `insitu` platforms. To retrieve a full metadata view add `platformTypes=all`.
+ parameters:
+ - $ref: '#/parameters/localeParam'
+ - $ref: '#/parameters/expandedParam'
+ - $ref: '#/parameters/platformTypesParam'
+ - $ref: '#/parameters/datasetTypesParam'
+ responses:
+ '200':
+ description: A collection of services
+ '/services/{serviceId}':
+ get:
+ summary: Gets an instance
+ tags:
+ - parameter
+ description: |
+ Gets a service instance.
+
+
+ Depending on what dataset types are available, differing output formats are available. For example, `image/png` (render as chart) or `application/pdf` (generating a report).
+ parameters:
+ - name: serviceId
+ in: path
+ required: true
+ type: string
+ responses:
+ '200':
+ description: An expanded item
+ '404':
+ description: Item not found
+ schema:
+ $ref: '#/definitions/Error'
+ '415':
+ description: Media Item not supported
+ schema:
+ $ref: '#/definitions/Error'
+ '/services/{serviceId}/extras':
+ get:
+ summary: Gets extra infos for a service
+ tags:
+ - parameter
+ description: >
+ Lists extra metadata which may vary from instance to instance. The available metadata fields are listed in the `extras` metadata field of each service.
+
+
+ You can query just the ones you are interested in by appending the `fields` query parameter and passing a comma-separated value list to it.
+ parameters:
+ - name: serviceId
+ in: path
+ required: true
+ type: string
+ - name: fields
+ in: query
+ required: false
+ type: array
+ items:
+ type: string
+ collectionFormat: csv
+ responses:
+ '200':
+ description: A list of (selected) extra infos
+ '404':
+ description: Item not found
+ schema:
+ $ref: '#/definitions/Error'
+ '415':
+ description: Media Item not supported
+ schema:
+ $ref: '#/definitions/Error'
+ /categories:
+ get:
+ summary: Gets available categories
+ tags:
+ - parameter
+ description: >
+ All available category instances. For backwards compatibility reasons, the output is filtered by default to list only those instances related to `stationary`, `insitu` platforms. To retrieve a full metadata view add `platformTypes=all`. Depending on the `expanded` parameter the collections items are compact or do inline full metadata.
+
+
+ Filter options help to focus on a particular set of items. Filter either by parameters or spatially.
+ parameters:
+ - $ref: '#/parameters/localeParam'
+ - $ref: '#/parameters/expandedParam'
+ - $ref: '#/parameters/servicesParam'
+ - $ref: '#/parameters/categoriesParam'
+ - $ref: '#/parameters/phenomenaParam'
+ - $ref: '#/parameters/proceduresParam'
+ - $ref: '#/parameters/offeringsParam'
+ - $ref: '#/parameters/platformsParam'
+ - $ref: '#/parameters/stationsParam'
+ - $ref: '#/parameters/platformTypesParam'
+ - $ref: '#/parameters/datasetTypesParam'
+ responses:
+ '200':
+ description: A collection of categories
+ '/categories/{categoryId}':
+ get:
+ summary: Gets a catefory instance
+ tags:
+ - parameter
+ description: |
+ Gets a category instance.
+ parameters:
+ - name: categoryId
+ in: path
+ required: true
+ type: string
+ responses:
+ '200':
+ description: An expanded item
+ '404':
+ description: Item not found
+ schema:
+ $ref: '#/definitions/Error'
+ '415':
+ description: Media Item not supported
+ schema:
+ $ref: '#/definitions/Error'
+ '/categories/{categoryId}/extras':
+ get:
+ summary: Gets extra infos for a category
+ tags:
+ - parameter
+ description: >
+ Lists extra metadata which may vary from instance to instance. The available metadata fields are listed in the `extras` metadata field of each category.
+
+
+ You can query just the ones you are interested in by appending the `fields` query parameter and passing a comma-separated value list to it.
+ parameters:
+ - name: categoryId
+ in: path
+ required: true
+ type: string
+ - name: fields
+ in: query
+ required: false
+ type: array
+ items:
+ type: string
+ collectionFormat: csv
+ responses:
+ '200':
+ description: A list of (selected) extra infos
+ '404':
+ description: Item not found
+ schema:
+ $ref: '#/definitions/Error'
+ '415':
+ description: Media Item not supported
+ schema:
+ $ref: '#/definitions/Error'
+ /phenomena:
+ get:
+ summary: Get available phenomenon instances
+ tags:
+ - parameter
+ description: >
+ All available phenomenon instances. For backwards compatibility reasons, the output is filtered by default to list only those instances related to `stationary`, `insitu` platforms. To retrieve a full metadata view add `platformTypes=all`. Depending on the `expanded` parameter the collections items are compact or do inline full metadata.
+
+
+ Filter options help to focus on a particular set of items. Filter either by parameters or spatially.
+ parameters:
+ - $ref: '#/parameters/localeParam'
+ - $ref: '#/parameters/expandedParam'
+ - $ref: '#/parameters/servicesParam'
+ - $ref: '#/parameters/categoriesParam'
+ - $ref: '#/parameters/phenomenaParam'
+ - $ref: '#/parameters/proceduresParam'
+ - $ref: '#/parameters/offeringsParam'
+ - $ref: '#/parameters/platformsParam'
+ - $ref: '#/parameters/stationsParam'
+ - $ref: '#/parameters/platformTypesParam'
+ - $ref: '#/parameters/datasetTypesParam'
+ responses:
+ '200':
+ description: A collection of phenomena
+ '/phenomena/{phenomenonId}':
+ get:
+ summary: Gets a phenomenon instance
+ tags:
+ - parameter
+ description: |
+ Gets a phenomenon instance
+ parameters:
+ - name: phenomenonId
+ in: path
+ required: true
+ type: string
+ responses:
+ '200':
+ description: An expanded item
+ '404':
+ description: Item not found
+ schema:
+ $ref: '#/definitions/Error'
+ '415':
+ description: Media Item not supported
+ schema:
+ $ref: '#/definitions/Error'
+ '/phenomena/{phenomenonId}/extras':
+ get:
+ summary: Gets extra infos for a phenomenon
+ tags:
+ - parameter
+ description: >
+ Lists extra metadata which may vary from instance to instance. The available metadata fields are listed in the `extras` metadata field of each phemomenon.
+
+
+ You can query just the ones you are interested in by appending the `fields` query parameter and passing a comma-separated value list to it.
+ parameters:
+ - name: phenomenonId
+ in: path
+ required: true
+ type: string
+ - name: fields
+ in: query
+ required: false
+ type: array
+ items:
+ type: string
+ collectionFormat: csv
+ responses:
+ '200':
+ description: A list of (selected) extra infos
+ '404':
+ description: Item not found
+ schema:
+ $ref: '#/definitions/Error'
+ '415':
+ description: Media Item not supported
+ schema:
+ $ref: '#/definitions/Error'
+ /procedure:
+ get:
+ summary: Get available procedure instances
+ tags:
+ - parameter
+ description: >
+ All available procedure instances. For backwards compatibility reasons, the output is filtered by default to list only those instances related to `stationary`, `insitu` platforms. To retrieve a full metadata view add `platformTypes=all`. Depending on the `expanded` parameter the collections items are compact or do inline full metadata.
+
+
+ Filter options help to focus on a particular set of items. Filter either by parameters or spatially.
+ parameters:
+ - $ref: '#/parameters/localeParam'
+ - $ref: '#/parameters/expandedParam'
+ - $ref: '#/parameters/servicesParam'
+ - $ref: '#/parameters/categoriesParam'
+ - $ref: '#/parameters/phenomenaParam'
+ - $ref: '#/parameters/proceduresParam'
+ - $ref: '#/parameters/offeringsParam'
+ - $ref: '#/parameters/platformsParam'
+ - $ref: '#/parameters/stationsParam'
+ - $ref: '#/parameters/platformTypesParam'
+ - $ref: '#/parameters/datasetTypesParam'
+ responses:
+ '200':
+ description: A collection of procedures
+ '/procedures/{procedureId}':
+ get:
+ summary: Gets a procedure instance
+ tags:
+ - parameter
+ description: |
+ Gets a procedure instance.
+ parameters:
+ - name: procedureId
+ in: path
+ required: true
+ type: string
+ responses:
+ '200':
+ description: An expanded item
+ '404':
+ description: Item not found
+ schema:
+ $ref: '#/definitions/Error'
+ '415':
+ description: Media Item not supported
+ schema:
+ $ref: '#/definitions/Error'
+ '/procedures/{procedureId}/extras':
+ get:
+ summary: Gets extra infos for a procedure
+ tags:
+ - parameter
+ description: >
+ Lists extra metadata which may vary from instance to instance. The available metadata fields are listed in the `extras` metadata field of each procedure.
+
+
+ You can query just the ones you are interested in by appending the `fields` query parameter and passing a comma-separated value list to it.
+ parameters:
+ - name: procedureId
+ in: path
+ required: true
+ type: string
+ - name: fields
+ in: query
+ required: false
+ type: array
+ items:
+ type: string
+ collectionFormat: csv
+ responses:
+ '200':
+ description: A list of (selected) extra infos
+ '404':
+ description: Item not found
+ schema:
+ $ref: '#/definitions/Error'
+ '415':
+ description: Media Item not supported
+ schema:
+ $ref: '#/definitions/Error'
+ /offerings:
+ get:
+ summary: Get available offerings instances
+ tags:
+ - parameter
+ description: >
+ All available offering instances. For backwards compatibility reasons, the output is filtered by default to list only those instances related to `stationary`, `insitu` platforms. To retrieve a full metadata view add `platformTypes=all`. Depending on the `expanded` parameter the collections items are compact or do inline full metadata.
+
+
+ Filter options help to focus on a particular set of items. Filter either by parameters or spatially.
+ parameters:
+ - $ref: '#/parameters/localeParam'
+ - $ref: '#/parameters/expandedParam'
+ - $ref: '#/parameters/servicesParam'
+ - $ref: '#/parameters/categoriesParam'
+ - $ref: '#/parameters/phenomenaParam'
+ - $ref: '#/parameters/proceduresParam'
+ - $ref: '#/parameters/offeringsParam'
+ - $ref: '#/parameters/platformsParam'
+ - $ref: '#/parameters/stationsParam'
+ - $ref: '#/parameters/platformTypesParam'
+ - $ref: '#/parameters/datasetTypesParam'
+ responses:
+ '200':
+ description: A collection of offerings
+ '/offerings/{offeringId}':
+ get:
+ summary: Gets an offering instance
+ tags:
+ - parameter
+ description: |
+ Gets an offering instance.
+ parameters:
+ - name: offeringId
+ in: path
+ required: true
+ type: string
+ responses:
+ '200':
+ description: An expanded item
+ '404':
+ description: Item not found
+ schema:
+ $ref: '#/definitions/Error'
+ '415':
+ description: Media Item not supported
+ schema:
+ $ref: '#/definitions/Error'
+ '/offerings/{offeringId}/extras':
+ get:
+ summary: Gets extra infos for a phenomenon
+ tags:
+ - parameter
+ description: >
+ Lists extra metadata which may vary from instance to instance. The available metadata fields are listed in the `extras` metadata field of each offering.
+
+
+ You can query just the ones you are interested in by appending the `fields` query parameter and passing a comma-separated value list to it.
+ parameters:
+ - name: offeringId
+ in: path
+ required: true
+ type: string
+ - name: fields
+ in: query
+ required: false
+ type: array
+ items:
+ type: string
+ collectionFormat: csv
+ responses:
+ '200':
+ description: A list of (selected) extra infos
+ '404':
+ description: Item not found
+ schema:
+ $ref: '#/definitions/Error'
+ '415':
+ description: Media Item not supported
+ schema:
+ $ref: '#/definitions/Error'
+ /features:
+ get:
+ summary: Get available feature instances
+ tags:
+ - parameter
+ description: >
+ All available instances. For backwards compatibility reasons the output is filtered by default to list only those instances related to `stationary`, `insitu` platforms. To retrieve a full metadata view add `platformTypes=all`.
+ parameters:
+ - $ref: '#/parameters/localeParam'
+ - $ref: '#/parameters/expandedParam'
+ - $ref: '#/parameters/servicesParam'
+ - $ref: '#/parameters/categoriesParam'
+ - $ref: '#/parameters/phenomenaParam'
+ - $ref: '#/parameters/proceduresParam'
+ - $ref: '#/parameters/offeringsParam'
+ - $ref: '#/parameters/platformsParam'
+ - $ref: '#/parameters/stationsParam'
+ - $ref: '#/parameters/platformTypesParam'
+ - $ref: '#/parameters/datasetTypesParam'
+ responses:
+ '200':
+ description: A collection of features
+ '/features/{featureId}':
+ get:
+ summary: Gets an feature instance
+ tags:
+ - parameter
+ description: |
+ Gets a feature instance.
+ parameters:
+ - name: featureId
+ in: path
+ required: true
+ type: string
+ responses:
+ '200':
+ description: An expanded item
+ '404':
+ description: Item not found
+ schema:
+ $ref: '#/definitions/Error'
+ '415':
+ description: Media Item not supported
+ schema:
+ $ref: '#/definitions/Error'
+ '/features/{featureId}/extras':
+ get:
+ summary: Gets extra infos for a feature
+ tags:
+ - parameter
+ description: >
+ All available feature instances. For backwards compatibility reasons, the output is filtered by default to list only those instances related to `stationary`, `insitu` platforms. To retrieve a full metadata view add `platformTypes=all`. Depending on the `expanded` parameter the collections items are compact or do inline full metadata.
+
+
+ Filter options help to focus on a particular set of items. Filter either by parameters or spatially.
+ parameters:
+ - name: featureId
+ in: path
+ required: true
+ type: string
+ - name: fields
+ in: query
+ required: false
+ type: array
+ items:
+ type: string
+ collectionFormat: csv
+ responses:
+ '200':
+ description: A list of (selected) extra infos
+ '404':
+ description: Item not found
+ schema:
+ $ref: '#/definitions/Error'
+ '415':
+ description: Media Item not supported
+ schema:
+ $ref: '#/definitions/Error'
+
+
+
+
+parameters:
+ expandedParam:
+ name: expanded
+ in: query
+ type: boolean
+ description: >
+ If `true` a list of partially expanded resource items is returned. The expansion provides more detailed information up to a certain point. However, it does not necessarily provide all item information as one may get when request the resource item itself.
+
+
+ The expanded works almost only for resource collection. However, exceptions may exist (e.g. for getting raw data). Exceptions are explicitly documented. The default is `false`.
+ platformTypesParam:
+ name: platformTypes
+ in: query
+ type: array
+ items:
+ type: string
+ collectionFormat: csv
+ description: >
+ Filters the resources to get only those related to the platform type filter.
+
+
+ Allowed values are `stationary`, `mobile`, `insitu`, `remote`, `all`.
+
+
+ The default is `stationary,insitu`.
+ datasetTypesParam:
+ name: datasetTypes
+ in: query
+ type: array
+ items:
+ type: string
+ collectionFormat: csv
+ description: >
+ Filters the resources to get only those related to the dataset type filter.
+
+
+ Allowed values are `quantity`, `count`, `text`, `all` or any other custom types given by the implementing backend.
+
+
+ The default is `quantity`.
+ servicesParam:
+ name: services
+ in: query
+ type: array
+ items:
+ type: string
+ collectionFormat: csv
+ description: >
+ All resources where the given service id does match. The single form (`service`) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.
+ categoriesParam:
+ name: categories
+ in: query
+ type: array
+ items:
+ type: string
+ collectionFormat: csv
+ description: >
+ All resources where the given category id does match. The single form (`category`) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.
+ phenomenaParam:
+ name: phenomena
+ in: query
+ type: array
+ items:
+ type: string
+ collectionFormat: csv
+ description: >
+ All resources where the given phenomenon id does match. The single form (`phenomenon`) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.
+ proceduresParam:
+ name: procedures
+ in: query
+ type: array
+ items:
+ type: string
+ collectionFormat: csv
+ description: >
+ All resources where the given procedure id does match. The single form (`procedure`) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.
+ offeringsParam:
+ name: offerings
+ in: query
+ type: array
+ items:
+ type: string
+ collectionFormat: csv
+ description: >
+ All resources where the given offering id does match. The single form (`offering`) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.
+ stationsParam:
+ name: stations
+ in: query
+ type: array
+ items:
+ type: string
+ collectionFormat: csv
+ description: >
+ All resources where the given station id does match. The single form (`station`) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.
+ platformsParam:
+ name: platforms
+ in: query
+ type: array
+ items:
+ type: string
+ collectionFormat: csv
+ description: |
+ All resources where the given platform id does match.
+ localeParam:
+ name: locale
+ in: query
+ type: string
+ description: >
+ Specifies the language as [ISO639](http://en.wikipedia.org/wiki/ISO_639) code. Subdivisions are respected by an `_` , e.g. `en_US` for American English.
+
+
+ The REST-API should consider the following order to detect a locale
+
+
+ * Accept-Language (e.g. header information)
+
+ * locale parameter
+
+
+ A fallback language cannot be specified as it depends on the data of the service provider.
+ timespanParam:
+ name: timespan
+ in: query
+ type: string
+ description: >
+ An [ISO8601](http://en.wikipedia.org/wiki/ISO_8601#Time_intervals)
+ formatted period. Only backslash formatted values are supported.
+ crsParam:
+ name: crs
+ in: query
+ type: string
+ description: >
+ The client indicates that input geometries shall be interpreted as being referenced by the given CRS (for example in case of `crs=EPSG:25832` to [ETRS89/UTM zone 32N](http://spatialreference.org/ref/epsg/25832/)).
+
+
+ Per default geometries are referenced by the WGS84 CRS (CRS84, i.e.
+ lon/lat order). If crs value differs from default, all output geometries are transformed to match
+ the asked CRS.
+
+
+ Please note that some CRS switch coordinate axes. Double check axes
+ ordering before interpreting coordinates!
+ bboxParam:
+ name: bbox
+ in: query
+ type: string
+ description: >
+ Stations within a given bounding box (in WGS84 by default). Refer to the
+ crs parameter if a non-default CRS shall be used.
+
+
+ ```json
+ bbox={
+ "ll": {
+ "type": "Point",
+ "coordinates": [
+
+
+
+
+ JSON
+Query the sensor status and get all the metadata you want with a simple REST interface. It is lightweight and can be utilized in many workflows. For example you can get a list of platforms.
+ +
+ 
+
+ Graphs
+Plot the highly customizable graphs and use it within your apps.
+
+
+
+ And more
+The all sorts of sensor data can be queried with a Sensor REST-API. See the docs for a complete reference.
+ ++ + +
![](data:image/png;base64," + encodedString + ")
+
+ ```
+
+ geometryTypesParam:
+ name: geometryTypes
+ in: query
+ type: string
+ enum:
+ - point
+ - linestring
+ - polygon
+ description: |
+ The type of geometry based on [WKT types](https://en.wikipedia.org/wiki/Well-known_text).
+ platformGeometriesParam:
+ name: platformGeometries
+ in: query
+ type: array
+ collectionFormat: csv
+ items:
+ type: string
+ enum:
+ - site
+ - track
+ description: |
+ The platform's geometry, either `site` for `stationary` platforms (or `station`s) or `track` for `mobile` platforms.
+ observedGeometriesParam:
+ name: observedGeometries
+ in: query
+ type: array
+ collectionFormat: csv
+ items:
+ type: string
+ enum:
+ - static
+ - dynamic
+ description: |
+ The platform's observed geometry, either `static` for `remote` platforms observing fixed geometries or `dynamic` otherwise.
+definitions:
+ SimpleDataRequest:
+ type: object
+ properties:
+ datasetIds:
+ type: array
+ items:
+ type: string
+ StyledDataRequest:
+ type: object
+ required:
+ - styleOptions
+ properties:
+ legend:
+ type: boolean
+ grid:
+ type: boolean
+ locale:
+ type: string
+ width:
+ type: integer
+ format: int32
+ height:
+ type: integer
+ format: int32
+ timespan:
+ type: string
+ styleOptions:
+ $ref: '#/definitions/Style'
+ Style:
+ type: object
+ description: ''
+ properties:
+ chartType:
+ type: string
+ enum:
+ - line
+ - bar
+
+ Error:
+ type: object
+ properties:
+ statusCode:
+ type: integer
+ format: int32
+ reason:
+ type: string
+ userMessage:
+ type: string
diff --git a/web-resources/docs/_data/swagger_.json b/web-resources/docs/_data/swagger_.json
new file mode 100644
index 000000000..72cb9acba
--- /dev/null
+++ b/web-resources/docs/_data/swagger_.json
@@ -0,0 +1,1945 @@
+{
+ "swagger": "2.0",
+ "info": {
+ "title": "52°North Series API",
+ "description": "Thin Web binding API to access series data",
+ "version": "2.0.0"
+ },
+ "host": "example.org",
+ "schemes": [
+ "https"
+ ],
+ "basePath": "/api/v1",
+ "consumes": [
+ "application/json"
+ ],
+ "produces": [
+ "application/json"
+ ],
+ "paths": {
+ "/": {
+ "get": {
+ "summary": "Available endpoints.",
+ "tags": [
+ "general"
+ ],
+ "description": "A (static) collection of endpoints available from this API. Each includes a relative path and a short description.\n",
+ "responses": {
+ "200": {
+ "description": "A collection of API endpoints"
+ }
+ }
+ }
+ },
+ "/search": {
+ "get": {
+ "summary": "A simple search.",
+ "tags": [
+ "general"
+ ],
+ "description": "A simple search over all resource's labels over all available endpoints. Note that the searching respects the current locale being selected.\n",
+ "parameters": [
+ {
+ "name": "q",
+ "in": "query",
+ "description": "Term which shall match (case insensitive) a resource's label",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/localeParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A collection of search results"
+ }
+ }
+ }
+ },
+ "/platforms": {
+ "get": {
+ "summary": "Available Platforms",
+ "tags": [
+ "platform",
+ "v2.0"
+ ],
+ "description": "A collection of available platforms. Depending on the `expanded` parameter the collections items are compact or do inline full metadata.\n\n\nFilter options help to focus on a particular set of items. Filter either by parameters or spatially.\n",
+ "parameters": [
+ {
+ "$ref": "#/parameters/localeParam"
+ },
+ {
+ "$ref": "#/parameters/expandedParam"
+ },
+ {
+ "$ref": "#/parameters/servicesParam"
+ },
+ {
+ "$ref": "#/parameters/categoriesParam"
+ },
+ {
+ "$ref": "#/parameters/phenomenaParam"
+ },
+ {
+ "$ref": "#/parameters/proceduresParam"
+ },
+ {
+ "$ref": "#/parameters/offeringsParam"
+ },
+ {
+ "$ref": "#/parameters/platformsParam"
+ },
+ {
+ "$ref": "#/parameters/stationsParam"
+ },
+ {
+ "$ref": "#/parameters/platformTypesParam"
+ },
+ {
+ "$ref": "#/parameters/geometryTypesParam"
+ },
+ {
+ "$ref": "#/parameters/platformGeometriesParam"
+ },
+ {
+ "$ref": "#/parameters/observedGeometriesParam"
+ },
+ {
+ "$ref": "#/parameters/datasetTypesParam"
+ },
+ {
+ "$ref": "#/parameters/crsParam"
+ },
+ {
+ "$ref": "#/parameters/bboxParam"
+ },
+ {
+ "$ref": "#/parameters/nearParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A collection of platforms"
+ },
+ "400": {
+ "description": "A query parameter does not match expected format"
+ },
+ "415": {
+ "description": "Media Item not supported",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ }
+ },
+ "/platforms/{platformId}": {
+ "get": {
+ "summary": "Gets a particular platform",
+ "tags": [
+ "platform",
+ "v2.0"
+ ],
+ "description": "Full view of a platform instance. A platform encodes a POINT geometry which is the actual location for `stationary` platforms and the last detected location for `mobile` platforms.\n",
+ "parameters": [
+ {
+ "name": "platformId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/localeParam"
+ },
+ {
+ "$ref": "#/parameters/crsParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "An expanded item"
+ },
+ "400": {
+ "description": "A query parameter does not match expected format",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ },
+ "404": {
+ "description": "Item not found",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ },
+ "415": {
+ "description": "Media Item not supported",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ }
+ },
+ "/platforms/{platformId}/extras": {
+ "get": {
+ "summary": "Gets extra infos for platform",
+ "tags": [
+ "platform",
+ "v2.0"
+ ],
+ "description": "Lists extra metadata which may vary from instance to instance. The available metadata fields are listed in the `extras` metadata field of each dataset.\n\nYou can query just the ones you are interested in by appending the `fields` query parameter and passing a comma-separated value list to it. \n",
+ "parameters": [
+ {
+ "name": "platformId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "fields",
+ "in": "query",
+ "required": false,
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "collectionFormat": "csv"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "An expanded item"
+ },
+ "404": {
+ "description": "Item not found",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ },
+ "415": {
+ "description": "Media Item not supported",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ }
+ },
+ "/stations": {
+ "get": {
+ "summary": "Available Stations",
+ "tags": [
+ "station"
+ ],
+ "description": "A collection of available stations. Depending on the `expanded` parameter the collections items are compact or do inline full metadata.\n\n\nFilter options help to focus on a particular set of items. Filter either by parameters or spatially.\n",
+ "parameters": [
+ {
+ "$ref": "#/parameters/localeParam"
+ },
+ {
+ "$ref": "#/parameters/expandedParam"
+ },
+ {
+ "$ref": "#/parameters/servicesParam"
+ },
+ {
+ "$ref": "#/parameters/categoriesParam"
+ },
+ {
+ "$ref": "#/parameters/phenomenaParam"
+ },
+ {
+ "$ref": "#/parameters/proceduresParam"
+ },
+ {
+ "$ref": "#/parameters/offeringsParam"
+ },
+ {
+ "$ref": "#/parameters/platformsParam"
+ },
+ {
+ "$ref": "#/parameters/stationsParam"
+ },
+ {
+ "$ref": "#/parameters/crsParam"
+ },
+ {
+ "$ref": "#/parameters/bboxParam"
+ },
+ {
+ "$ref": "#/parameters/nearParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A collection of stations"
+ },
+ "400": {
+ "description": "A query parameter does not match expected format"
+ },
+ "415": {
+ "description": "Media Item not supported",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ }
+ },
+ "/stations/{stationId}": {
+ "get": {
+ "summary": "Gets a particular station",
+ "tags": [
+ "station"
+ ],
+ "description": "Full data view of a station. A station is a [GeoJSON point geometry](https://www.rfc-editor.org/info/rfc7946) which encodes available metadata in its `properties` member.\n",
+ "parameters": [
+ {
+ "name": "stationId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/localeParam"
+ },
+ {
+ "$ref": "#/parameters/crsParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "An expanded item"
+ },
+ "400": {
+ "description": "A query parameter does not match expected format",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ },
+ "404": {
+ "description": "Item not found",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ },
+ "415": {
+ "description": "Media Item not supported",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ }
+ },
+ "/stations/{stationId}/extras": {
+ "get": {
+ "summary": "Gets extra infos for station",
+ "tags": [
+ "station"
+ ],
+ "description": "Lists extra metadata which may vary from instance to instance. The available metadata fields are listed in the `extras` metadata field of each dataset.\n\nYou can query just the ones you are interested in by appending the `fields` query parameter and passing a comma-separated value list to it. \n",
+ "parameters": [
+ {
+ "name": "stationId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "fields",
+ "in": "query",
+ "required": false,
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "collectionFormat": "csv"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "An expanded item"
+ },
+ "404": {
+ "description": "Item not found",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ },
+ "415": {
+ "description": "Media Item not supported",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ }
+ },
+ "/datasets": {
+ "get": {
+ "summary": "Gets available datasets",
+ "tags": [
+ "dataset",
+ "v2.0"
+ ],
+ "description": "A collection of available datasets. Depending on the `expanded` parameter the collections items are compact or do inline full metadata.\n\n\nFilter options help to focus on a particular set of items. Filter either by parameters or spatially.\n",
+ "parameters": [
+ {
+ "$ref": "#/parameters/localeParam"
+ },
+ {
+ "$ref": "#/parameters/expandedParam"
+ },
+ {
+ "$ref": "#/parameters/servicesParam"
+ },
+ {
+ "$ref": "#/parameters/categoriesParam"
+ },
+ {
+ "$ref": "#/parameters/phenomenaParam"
+ },
+ {
+ "$ref": "#/parameters/proceduresParam"
+ },
+ {
+ "$ref": "#/parameters/offeringsParam"
+ },
+ {
+ "$ref": "#/parameters/platformsParam"
+ },
+ {
+ "$ref": "#/parameters/stationsParam"
+ },
+ {
+ "$ref": "#/parameters/platformTypesParam"
+ },
+ {
+ "$ref": "#/parameters/geometryTypesParam"
+ },
+ {
+ "$ref": "#/parameters/platformGeometriesParam"
+ },
+ {
+ "$ref": "#/parameters/observedGeometriesParam"
+ },
+ {
+ "$ref": "#/parameters/datasetTypesParam"
+ },
+ {
+ "$ref": "#/parameters/crsParam"
+ },
+ {
+ "$ref": "#/parameters/bboxParam"
+ },
+ {
+ "$ref": "#/parameters/nearParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A collection of datasets"
+ },
+ "400": {
+ "description": "A query parameter does not match expected format"
+ },
+ "415": {
+ "description": "Media Item not supported",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ }
+ },
+ "/datasets/{datasetId}": {
+ "get": {
+ "summary": "Gets a particular dataset",
+ "tags": [
+ "dataset",
+ "v2.0"
+ ],
+ "description": "Full view of a dataset instance. All relevant relations (parameters, unit, platform, etc.) are inlined. If any additional information is listed in the `extras` array member it can be retrieved via `/datasets/{datasetId}/extras` (see next).\n",
+ "parameters": [
+ {
+ "name": "datasetId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/localeParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "An expanded item"
+ },
+ "404": {
+ "description": "Item not found",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ },
+ "415": {
+ "description": "Media Item not supported",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ }
+ },
+ "/datasets/{datasetId}/extras": {
+ "get": {
+ "summary": "Gets extra infos for dataset",
+ "tags": [
+ "dataset",
+ "v2.0"
+ ],
+ "description": "Lists extra metadata which may vary from instance to instance. The available metadata fields are listed in the `extras` metadata field of each dataset.\n\nYou can query just the ones you are interested in by appending the `fields` query parameter and passing a comma-separated value list to it. \n",
+ "parameters": [
+ {
+ "name": "datasetId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "fields",
+ "in": "query",
+ "required": false,
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "collectionFormat": "csv"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "An expanded item"
+ },
+ "404": {
+ "description": "Item not found",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ },
+ "415": {
+ "description": "Media Item not supported",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ }
+ },
+ "/datasets/{datasetId}/{interval}": {
+ "get": {
+ "summary": "Gets extra infos for dataset",
+ "tags": [
+ "dataset",
+ "v2.0"
+ ],
+ "description": "Returns a pre-rendered image of a dataset for the given interval. Allowed interval values are\n* `lastDay.png`\n* `lastWeek.png`\n* `lastMonth.png`\n\nDatasets of type `quantity` can be pre-rendered by a regular task. If pre-rendering is enabled for a given datasets depends on the API provider as it is a configuration issue.\n",
+ "parameters": [
+ {
+ "name": "datasetId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "interval",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A list of (selected) extra infos"
+ },
+ "404": {
+ "description": "In case no prerendered image available (or is currently being rendered)"
+ }
+ }
+ }
+ },
+ "/datasets/{datasetId}/data": {
+ "get": {
+ "summary": "Gets data of a dataset",
+ "tags": [
+ "dataset",
+ "v2.0"
+ ],
+ "description": "Gets data for a given `timespan` filter. Implementations may limit the maximum amount of time intervals a client can query in one request. \n\nWhat Mime-Types are supported depends on the `datasetType`. For example `quantity` observations can be drawn as a timeseries chart (i.e. either `image/png` or `application/pdf`). Supported Mime-Types are listed for each `datasetType` when querying `/service/{serviceId}?datasetTypes=all` produces: - application/json - image/png - text/csv - application/pdf - application/zip\n",
+ "parameters": [
+ {
+ "name": "datasetId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/expandedParam"
+ },
+ {
+ "$ref": "#/parameters/timespanParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Data for a given `timespan` in a requested output format"
+ },
+ "400": {
+ "description": "A query parameter does not match expected format",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ },
+ "404": {
+ "description": "Item not found",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ },
+ "415": {
+ "description": "Media Item not supported",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ }
+ },
+ "/timeseries": {
+ "get": {
+ "summary": "Gets available timeseries",
+ "tags": [
+ "timeseries"
+ ],
+ "description": "A collection of timeseries (i.e. datasets of type `quantity` which have been observed at `stationary`, `insitu` platforms having a 0-dimensional (POINT) location geometry. Depending on the `expanded` parameter the collections items are compact or do inline full metadata.\n\n\nFilter options help to focus on a particular set of items. Filter either by parameters or spatially.\n",
+ "parameters": [
+ {
+ "$ref": "#/parameters/localeParam"
+ },
+ {
+ "$ref": "#/parameters/expandedParam"
+ },
+ {
+ "$ref": "#/parameters/servicesParam"
+ },
+ {
+ "$ref": "#/parameters/categoriesParam"
+ },
+ {
+ "$ref": "#/parameters/phenomenaParam"
+ },
+ {
+ "$ref": "#/parameters/proceduresParam"
+ },
+ {
+ "$ref": "#/parameters/offeringsParam"
+ },
+ {
+ "$ref": "#/parameters/platformsParam"
+ },
+ {
+ "$ref": "#/parameters/stationsParam"
+ },
+ {
+ "$ref": "#/parameters/platformTypesParam"
+ },
+ {
+ "$ref": "#/parameters/datasetTypesParam"
+ },
+ {
+ "$ref": "#/parameters/crsParam"
+ },
+ {
+ "$ref": "#/parameters/bboxParam"
+ },
+ {
+ "$ref": "#/parameters/nearParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A collection of timeseries"
+ }
+ }
+ }
+ },
+ "/timeseries/{timeseriesId}": {
+ "get": {
+ "summary": "Gets a particular timeseries",
+ "tags": [
+ "timeseries"
+ ],
+ "description": "Full view of a timeseries instance. All relevant relations (parameters, unit, station, etc.) are inlined. If any additional information is listed in the `extras` array member it can be retrieved via `/datasets/{datasetId}/extras` (see next).\n\nFor backward compatibility reasons metadata about `renderingHints` and `statusIntervals` are inlined here as well. However, those are listed within `extra` infos to make it consistent.\n",
+ "parameters": [
+ {
+ "name": "timeseriesId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/localeParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "An expanded item"
+ },
+ "400": {
+ "description": "A query parameter does not match expected format",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ },
+ "404": {
+ "description": "Item not found",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ },
+ "415": {
+ "description": "Media Item not supported",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ }
+ },
+ "/timeseries/{timeseriesId}/extras": {
+ "get": {
+ "summary": "Gets extra infos for timeseries",
+ "tags": [
+ "timeseries"
+ ],
+ "description": "Lists extra metadata which may vary from instance to instance. The available metadata fields are listed in the `extras` metadata field of each timeseries.\n\nYou can query just the ones you are interested in by appending the `fields`query parameter and passing a comma-separated value list to it. \n",
+ "parameters": [
+ {
+ "name": "timeseriesId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "fields",
+ "in": "query",
+ "required": false,
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "collectionFormat": "csv"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A list of (selected) extra infos"
+ },
+ "404": {
+ "description": "Item not found",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ },
+ "415": {
+ "description": "Media Item not supported",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ }
+ },
+ "/timeseries/{timeseriesId}/getData": {
+ "get": {
+ "summary": "Gets data of a timeseries",
+ "tags": [
+ "timeseries"
+ ],
+ "description": "Gets data for a given `timespan` filter. Implementations may limit the maximum amount of time intervals a client can query in one request. \n\nThis operation does only return data of `quantity` dataset types from`stationary`, `insitu` platforms having a 0-dimensional location geometry (`station`). Supported Mime-Types are `application/json`, `image/png`, `application/pdf`, and `text/csv`.\n",
+ "produces": [
+ "application/json",
+ "image/png",
+ "text/csv",
+ "application/pdf",
+ "application/zip"
+ ],
+ "parameters": [
+ {
+ "name": "timeseriesId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/expandedParam"
+ },
+ {
+ "$ref": "#/parameters/timespanParam"
+ },
+ {
+ "$ref": "#/parameters/widthParam"
+ },
+ {
+ "$ref": "#/parameters/heightParam"
+ },
+ {
+ "$ref": "#/parameters/legendParam"
+ },
+ {
+ "$ref": "#/parameters/gridParam"
+ },
+ {
+ "$ref": "#/parameters/generalizeParam"
+ },
+ {
+ "$ref": "#/parameters/formatParam"
+ },
+ {
+ "$ref": "#/parameters/base64Param"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "Data for a given `timespan` in a requested output format"
+ },
+ "400": {
+ "description": "A query parameter does not match expected format",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ },
+ "404": {
+ "description": "Item not found",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ },
+ "415": {
+ "description": "Media Item not supported",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ }
+ },
+ "/geometries": {
+ "get": {
+ "summary": "A collection of available geometries",
+ "tags": [
+ "geometry",
+ "v2.0"
+ ],
+ "description": "All available geometries instances. Possible geometry types are \n\n* `site`, i.e. `stationary` platform locations (fixed) \n\n* `track`, i.e. trajectories made by a `mobile` platform\n\n* `static`, i.e. a fixed geometry observed by a `remote` platform\n\n* `dynamic`, i.e. geometry observed by a `remote` platform which changes over time\n",
+ "parameters": [
+ {
+ "$ref": "#/parameters/geometryTypesParam"
+ },
+ {
+ "$ref": "#/parameters/platformGeometriesParam"
+ },
+ {
+ "$ref": "#/parameters/observedGeometriesParam"
+ },
+ {
+ "$ref": "#/parameters/crsParam"
+ },
+ {
+ "$ref": "#/parameters/bboxParam"
+ },
+ {
+ "$ref": "#/parameters/nearParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A collection of geometries"
+ }
+ }
+ }
+ },
+ "/geometries/{geometryId}": {
+ "get": {
+ "summary": "Gets a particular geometry",
+ "tags": [
+ "geometry",
+ "v2.0"
+ ],
+ "description": "Full view of a geometry instance. Encodes as full [GeoJSON geometry](https://www.rfc-editor.org/info/rfc7946).\n",
+ "parameters": [
+ {
+ "name": "geometryId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "$ref": "#/parameters/localeParam"
+ },
+ {
+ "$ref": "#/parameters/crsParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "An expanded item"
+ },
+ "400": {
+ "description": "A query parameter does not match expected format",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ },
+ "404": {
+ "description": "Item not found",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ },
+ "415": {
+ "description": "Media Item not supported",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ }
+ },
+ "/services": {
+ "get": {
+ "summary": "Get available service instances",
+ "tags": [
+ "parameter"
+ ],
+ "description": "All available service instances. For backwards compatibility reasons the output is filtered by default to list only those instances related to `stationary`, `insitu` platforms. To retrieve a full metadata view add `platformTypes=all`.\n",
+ "parameters": [
+ {
+ "$ref": "#/parameters/localeParam"
+ },
+ {
+ "$ref": "#/parameters/expandedParam"
+ },
+ {
+ "$ref": "#/parameters/platformTypesParam"
+ },
+ {
+ "$ref": "#/parameters/datasetTypesParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A collection of services"
+ }
+ }
+ }
+ },
+ "/services/{serviceId}": {
+ "get": {
+ "summary": "Gets an instance",
+ "tags": [
+ "parameter"
+ ],
+ "description": "Gets a service instance.\n\n\nDepending on what dataset types are available, differing output formats are available. For example, `image/png` (render as chart) or `application/pdf` (generating a report).\n",
+ "parameters": [
+ {
+ "name": "serviceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "An expanded item"
+ },
+ "404": {
+ "description": "Item not found",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ },
+ "415": {
+ "description": "Media Item not supported",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ }
+ },
+ "/services/{serviceId}/extras": {
+ "get": {
+ "summary": "Gets extra infos for a service",
+ "tags": [
+ "parameter"
+ ],
+ "description": "Lists extra metadata which may vary from instance to instance. The available metadata fields are listed in the `extras` metadata field of each service.\n\nYou can query just the ones you are interested in by appending the `fields` query parameter and passing a comma-separated value list to it. \n",
+ "parameters": [
+ {
+ "name": "serviceId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "fields",
+ "in": "query",
+ "required": false,
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "collectionFormat": "csv"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A list of (selected) extra infos"
+ },
+ "404": {
+ "description": "Item not found",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ },
+ "415": {
+ "description": "Media Item not supported",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ }
+ },
+ "/categories": {
+ "get": {
+ "summary": "Gets available categories",
+ "tags": [
+ "parameter"
+ ],
+ "description": "All available category instances. For backwards compatibility reasons, the output is filtered by default to list only those instances related to `stationary`, `insitu` platforms. To retrieve a full metadata view add `platformTypes=all`. Depending on the `expanded` parameter the collections items are compact or do inline full metadata.\n\nFilter options help to focus on a particular set of items. Filter either by parameters or spatially.\n",
+ "parameters": [
+ {
+ "$ref": "#/parameters/localeParam"
+ },
+ {
+ "$ref": "#/parameters/expandedParam"
+ },
+ {
+ "$ref": "#/parameters/servicesParam"
+ },
+ {
+ "$ref": "#/parameters/categoriesParam"
+ },
+ {
+ "$ref": "#/parameters/phenomenaParam"
+ },
+ {
+ "$ref": "#/parameters/proceduresParam"
+ },
+ {
+ "$ref": "#/parameters/offeringsParam"
+ },
+ {
+ "$ref": "#/parameters/platformsParam"
+ },
+ {
+ "$ref": "#/parameters/stationsParam"
+ },
+ {
+ "$ref": "#/parameters/platformTypesParam"
+ },
+ {
+ "$ref": "#/parameters/datasetTypesParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A collection of categories"
+ }
+ }
+ }
+ },
+ "/categories/{categoryId}": {
+ "get": {
+ "summary": "Gets a catefory instance",
+ "tags": [
+ "parameter"
+ ],
+ "description": "Gets a category instance.\n",
+ "parameters": [
+ {
+ "name": "categoryId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "An expanded item"
+ },
+ "404": {
+ "description": "Item not found",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ },
+ "415": {
+ "description": "Media Item not supported",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ }
+ },
+ "/categories/{categoryId}/extras": {
+ "get": {
+ "summary": "Gets extra infos for a category",
+ "tags": [
+ "parameter"
+ ],
+ "description": "Lists extra metadata which may vary from instance to instance. The available metadata fields are listed in the `extras` metadata field of each category.\n\nYou can query just the ones you are interested in by appending the `fields` query parameter and passing a comma-separated value list to it. \n",
+ "parameters": [
+ {
+ "name": "categoryId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "fields",
+ "in": "query",
+ "required": false,
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "collectionFormat": "csv"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A list of (selected) extra infos"
+ },
+ "404": {
+ "description": "Item not found",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ },
+ "415": {
+ "description": "Media Item not supported",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ }
+ },
+ "/phenomena": {
+ "get": {
+ "summary": "Get available phenomenon instances",
+ "tags": [
+ "parameter"
+ ],
+ "description": "All available phenomenon instances. For backwards compatibility reasons, the output is filtered by default to list only those instances related to `stationary`, `insitu` platforms. To retrieve a full metadata view add `platformTypes=all`. Depending on the `expanded` parameter the collections items are compact or do inline full metadata.\n\nFilter options help to focus on a particular set of items. Filter either by parameters or spatially.\n",
+ "parameters": [
+ {
+ "$ref": "#/parameters/localeParam"
+ },
+ {
+ "$ref": "#/parameters/expandedParam"
+ },
+ {
+ "$ref": "#/parameters/servicesParam"
+ },
+ {
+ "$ref": "#/parameters/categoriesParam"
+ },
+ {
+ "$ref": "#/parameters/phenomenaParam"
+ },
+ {
+ "$ref": "#/parameters/proceduresParam"
+ },
+ {
+ "$ref": "#/parameters/offeringsParam"
+ },
+ {
+ "$ref": "#/parameters/platformsParam"
+ },
+ {
+ "$ref": "#/parameters/stationsParam"
+ },
+ {
+ "$ref": "#/parameters/platformTypesParam"
+ },
+ {
+ "$ref": "#/parameters/datasetTypesParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A collection of phenomena"
+ }
+ }
+ }
+ },
+ "/phenomena/{phenomenonId}": {
+ "get": {
+ "summary": "Gets a phenomenon instance",
+ "tags": [
+ "parameter"
+ ],
+ "description": "Gets a phenomenon instance\n",
+ "parameters": [
+ {
+ "name": "phenomenonId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "An expanded item"
+ },
+ "404": {
+ "description": "Item not found",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ },
+ "415": {
+ "description": "Media Item not supported",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ }
+ },
+ "/phenomena/{phenomenonId}/extras": {
+ "get": {
+ "summary": "Gets extra infos for a phenomenon",
+ "tags": [
+ "parameter"
+ ],
+ "description": "Lists extra metadata which may vary from instance to instance. The available metadata fields are listed in the `extras` metadata field of each phemomenon.\n\nYou can query just the ones you are interested in by appending the `fields` query parameter and passing a comma-separated value list to it. \n",
+ "parameters": [
+ {
+ "name": "phenomenonId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "fields",
+ "in": "query",
+ "required": false,
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "collectionFormat": "csv"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A list of (selected) extra infos"
+ },
+ "404": {
+ "description": "Item not found",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ },
+ "415": {
+ "description": "Media Item not supported",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ }
+ },
+ "/procedure": {
+ "get": {
+ "summary": "Get available procedure instances",
+ "tags": [
+ "parameter"
+ ],
+ "description": "All available procedure instances. For backwards compatibility reasons, the output is filtered by default to list only those instances related to `stationary`, `insitu` platforms. To retrieve a full metadata view add `platformTypes=all`. Depending on the `expanded` parameter the collections items are compact or do inline full metadata.\n\nFilter options help to focus on a particular set of items. Filter either by parameters or spatially.\n",
+ "parameters": [
+ {
+ "$ref": "#/parameters/localeParam"
+ },
+ {
+ "$ref": "#/parameters/expandedParam"
+ },
+ {
+ "$ref": "#/parameters/servicesParam"
+ },
+ {
+ "$ref": "#/parameters/categoriesParam"
+ },
+ {
+ "$ref": "#/parameters/phenomenaParam"
+ },
+ {
+ "$ref": "#/parameters/proceduresParam"
+ },
+ {
+ "$ref": "#/parameters/offeringsParam"
+ },
+ {
+ "$ref": "#/parameters/platformsParam"
+ },
+ {
+ "$ref": "#/parameters/stationsParam"
+ },
+ {
+ "$ref": "#/parameters/platformTypesParam"
+ },
+ {
+ "$ref": "#/parameters/datasetTypesParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A collection of procedures"
+ }
+ }
+ }
+ },
+ "/procedures/{procedureId}": {
+ "get": {
+ "summary": "Gets a procedure instance",
+ "tags": [
+ "parameter"
+ ],
+ "description": "Gets a procedure instance.\n",
+ "parameters": [
+ {
+ "name": "procedureId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "An expanded item"
+ },
+ "404": {
+ "description": "Item not found",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ },
+ "415": {
+ "description": "Media Item not supported",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ }
+ },
+ "/procedures/{procedureId}/extras": {
+ "get": {
+ "summary": "Gets extra infos for a procedure",
+ "tags": [
+ "parameter"
+ ],
+ "description": "Lists extra metadata which may vary from instance to instance. The available metadata fields are listed in the `extras` metadata field of each procedure.\n\nYou can query just the ones you are interested in by appending the `fields` query parameter and passing a comma-separated value list to it. \n",
+ "parameters": [
+ {
+ "name": "procedureId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "fields",
+ "in": "query",
+ "required": false,
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "collectionFormat": "csv"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A list of (selected) extra infos"
+ },
+ "404": {
+ "description": "Item not found",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ },
+ "415": {
+ "description": "Media Item not supported",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ }
+ },
+ "/offerings": {
+ "get": {
+ "summary": "Get available offerings instances",
+ "tags": [
+ "parameter"
+ ],
+ "description": "All available offering instances. For backwards compatibility reasons, the output is filtered by default to list only those instances related to `stationary`, `insitu` platforms. To retrieve a full metadata view add `platformTypes=all`. Depending on the `expanded` parameter the collections items are compact or do inline full metadata.\n\nFilter options help to focus on a particular set of items. Filter either by parameters or spatially.\n",
+ "parameters": [
+ {
+ "$ref": "#/parameters/localeParam"
+ },
+ {
+ "$ref": "#/parameters/expandedParam"
+ },
+ {
+ "$ref": "#/parameters/servicesParam"
+ },
+ {
+ "$ref": "#/parameters/categoriesParam"
+ },
+ {
+ "$ref": "#/parameters/phenomenaParam"
+ },
+ {
+ "$ref": "#/parameters/proceduresParam"
+ },
+ {
+ "$ref": "#/parameters/offeringsParam"
+ },
+ {
+ "$ref": "#/parameters/platformsParam"
+ },
+ {
+ "$ref": "#/parameters/stationsParam"
+ },
+ {
+ "$ref": "#/parameters/platformTypesParam"
+ },
+ {
+ "$ref": "#/parameters/datasetTypesParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A collection of offerings"
+ }
+ }
+ }
+ },
+ "/offerings/{offeringId}": {
+ "get": {
+ "summary": "Gets an offering instance",
+ "tags": [
+ "parameter"
+ ],
+ "description": "Gets an offering instance.\n",
+ "parameters": [
+ {
+ "name": "offeringId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "An expanded item"
+ },
+ "404": {
+ "description": "Item not found",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ },
+ "415": {
+ "description": "Media Item not supported",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ }
+ },
+ "/offerings/{offeringId}/extras": {
+ "get": {
+ "summary": "Gets extra infos for a phenomenon",
+ "tags": [
+ "parameter"
+ ],
+ "description": "Lists extra metadata which may vary from instance to instance. The available metadata fields are listed in the `extras` metadata field of each offering.\n\nYou can query just the ones you are interested in by appending the `fields` query parameter and passing a comma-separated value list to it. \n",
+ "parameters": [
+ {
+ "name": "offeringId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "fields",
+ "in": "query",
+ "required": false,
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "collectionFormat": "csv"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A list of (selected) extra infos"
+ },
+ "404": {
+ "description": "Item not found",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ },
+ "415": {
+ "description": "Media Item not supported",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ }
+ },
+ "/features": {
+ "get": {
+ "summary": "Get available feature instances",
+ "tags": [
+ "parameter"
+ ],
+ "description": "All available instances. For backwards compatibility reasons the output is filtered by default to list only those instances related to `stationary`, `insitu` platforms. To retrieve a full metadata view add `platformTypes=all`.\n",
+ "parameters": [
+ {
+ "$ref": "#/parameters/localeParam"
+ },
+ {
+ "$ref": "#/parameters/expandedParam"
+ },
+ {
+ "$ref": "#/parameters/servicesParam"
+ },
+ {
+ "$ref": "#/parameters/categoriesParam"
+ },
+ {
+ "$ref": "#/parameters/phenomenaParam"
+ },
+ {
+ "$ref": "#/parameters/proceduresParam"
+ },
+ {
+ "$ref": "#/parameters/offeringsParam"
+ },
+ {
+ "$ref": "#/parameters/platformsParam"
+ },
+ {
+ "$ref": "#/parameters/stationsParam"
+ },
+ {
+ "$ref": "#/parameters/platformTypesParam"
+ },
+ {
+ "$ref": "#/parameters/datasetTypesParam"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A collection of features"
+ }
+ }
+ }
+ },
+ "/features/{featureId}": {
+ "get": {
+ "summary": "Gets an feature instance",
+ "tags": [
+ "parameter"
+ ],
+ "description": "Gets a feature instance.\n",
+ "parameters": [
+ {
+ "name": "featureId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "An expanded item"
+ },
+ "404": {
+ "description": "Item not found",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ },
+ "415": {
+ "description": "Media Item not supported",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ }
+ },
+ "/features/{featureId}/extras": {
+ "get": {
+ "summary": "Gets extra infos for a feature",
+ "tags": [
+ "parameter"
+ ],
+ "description": "All available feature instances. For backwards compatibility reasons, the output is filtered by default to list only those instances related to `stationary`, `insitu` platforms. To retrieve a full metadata view add `platformTypes=all`. Depending on the `expanded` parameter the collections items are compact or do inline full metadata.\n\nFilter options help to focus on a particular set of items. Filter either by parameters or spatially.\n",
+ "parameters": [
+ {
+ "name": "featureId",
+ "in": "path",
+ "required": true,
+ "type": "string"
+ },
+ {
+ "name": "fields",
+ "in": "query",
+ "required": false,
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "collectionFormat": "csv"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "A list of (selected) extra infos"
+ },
+ "404": {
+ "description": "Item not found",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ },
+ "415": {
+ "description": "Media Item not supported",
+ "schema": {
+ "$ref": "#/definitions/Error"
+ }
+ }
+ }
+ }
+ }
+ },
+ "parameters": {
+ "expandedParam": {
+ "name": "expanded",
+ "in": "query",
+ "type": "boolean",
+ "description": "If `true` a list of partially expanded resource items is returned. The expansion provides more detailed information up to a certain point. However, it does not necessarily provide all item information as one may get when request the resource item itself.\n\nThe expanded works almost only for resource collection. However, exceptions may exist (e.g. for getting raw data). Exceptions are explicitly documented. The default is `false`.\n"
+ },
+ "platformTypesParam": {
+ "name": "platformTypes",
+ "in": "query",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "collectionFormat": "csv",
+ "description": "Filters the resources to get only those related to the platform type filter.\n\nAllowed values are `stationary`, `mobile`, `insitu`, `remote`, `all`. \n\nThe default is `stationary,insitu`.\n"
+ },
+ "datasetTypesParam": {
+ "name": "datasetTypes",
+ "in": "query",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "collectionFormat": "csv",
+ "description": "Filters the resources to get only those related to the dataset type filter.\n\nAllowed values are `quantity`, `count`, `text`, `all` or any other custom types given by the implementing backend.\n\nThe default is `quantity`.\n"
+ },
+ "servicesParam": {
+ "name": "services",
+ "in": "query",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "collectionFormat": "csv",
+ "description": "All resources where the given service id does match. The single form (`service`) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.\n"
+ },
+ "categoriesParam": {
+ "name": "categories",
+ "in": "query",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "collectionFormat": "csv",
+ "description": "All resources where the given category id does match. The single form (`category`) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.\n"
+ },
+ "phenomenaParam": {
+ "name": "phenomena",
+ "in": "query",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "collectionFormat": "csv",
+ "description": "All resources where the given phenomenon id does match. The single form (`phenomenon`) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.\n"
+ },
+ "proceduresParam": {
+ "name": "procedures",
+ "in": "query",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "collectionFormat": "csv",
+ "description": "All resources where the given procedure id does match. The single form (`procedure`) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.\n"
+ },
+ "offeringsParam": {
+ "name": "offerings",
+ "in": "query",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "collectionFormat": "csv",
+ "description": "All resources where the given offering id does match. The single form (`offering`) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.\n"
+ },
+ "stationsParam": {
+ "name": "stations",
+ "in": "query",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "collectionFormat": "csv",
+ "description": "All resources where the given station id does match. The single form (`station`) is kept for backwards compatibility. Please use the plural form to filter on multiple ids.\n"
+ },
+ "platformsParam": {
+ "name": "platforms",
+ "in": "query",
+ "type": "array",
+ "items": {
+ "type": "string"
+ },
+ "collectionFormat": "csv",
+ "description": "All resources where the given platform id does match.\n"
+ },
+ "localeParam": {
+ "name": "locale",
+ "in": "query",
+ "type": "string",
+ "description": "Specifies the language as [ISO639](http://en.wikipedia.org/wiki/ISO_639) code. Subdivisions are respected by an `_` , e.g. `en_US` for American English.\n\nThe REST-API should consider the following order to detect a locale\n\n* Accept-Language (e.g. header information)\n* locale parameter\n\nA fallback language cannot be specified as it depends on the data of the service provider.\n"
+ },
+ "timespanParam": {
+ "name": "timespan",
+ "in": "query",
+ "type": "string",
+ "description": "An [ISO8601](http://en.wikipedia.org/wiki/ISO_8601#Time_intervals) formatted period. Only backslash formatted values are supported.\n"
+ },
+ "crsParam": {
+ "name": "crs",
+ "in": "query",
+ "type": "string",
+ "description": "The client indicates that input geometries shall be interpreted as being referenced by the given CRS (for example in case of `crs=EPSG:25832` to [ETRS89/UTM zone 32N](http://spatialreference.org/ref/epsg/25832/)).\n\nPer default geometries are referenced by the WGS84 CRS (CRS84, i.e. lon/lat order). If crs value differs from default, all output geometries are transformed to match the asked CRS.\n\nPlease note that some CRS switch coordinate axes. Double check axes ordering before interpreting coordinates!\n"
+ },
+ "bboxParam": {
+ "name": "bbox",
+ "in": "query",
+ "type": "string",
+ "description": "Stations within a given bounding box (in WGS84 by default). Refer to the crs parameter if a non-default CRS shall be used.\n\n```json bbox={\n \"ll\": {\n \"type\": \"Point\",\n \"coordinates\": [![](data:image/png;base64,\" + encodedString + \")
\n```\n"
+ },
+ "geometryTypesParam": {
+ "name": "geometryTypes",
+ "in": "query",
+ "type": "string",
+ "enum": [
+ "point",
+ "linestring",
+ "polygon"
+ ],
+ "description": "The type of geometry based on [WKT types](https://en.wikipedia.org/wiki/Well-known_text).\n"
+ },
+ "platformGeometriesParam": {
+ "name": "platformGeometries",
+ "in": "query",
+ "type": "array",
+ "collectionFormat": "csv",
+ "items": {
+ "type": "string",
+ "enum": [
+ "site",
+ "track"
+ ]
+ },
+ "description": "The platform's geometry, either `site` for `stationary` platforms (or `station`s) or `track` for `mobile` platforms.\n"
+ },
+ "observedGeometriesParam": {
+ "name": "observedGeometries",
+ "in": "query",
+ "type": "array",
+ "collectionFormat": "csv",
+ "items": {
+ "type": "string",
+ "enum": [
+ "static",
+ "dynamic"
+ ]
+ },
+ "description": "The platform's observed geometry, either `static` for `remote` platforms observing fixed geometries or `dynamic` otherwise.\n"
+ }
+ },
+ "definitions": {
+ "SimpleDataRequest": {
+ "type": "object",
+ "properties": {
+ "datasetIds": {
+ "type": "array",
+ "items": {
+ "type": "string"
+ }
+ }
+ }
+ },
+ "StyledDataRequest": {
+ "type": "object",
+ "required": [
+ "styleOptions"
+ ],
+ "properties": {
+ "legend": {
+ "type": "boolean"
+ },
+ "grid": {
+ "type": "boolean"
+ },
+ "locale": {
+ "type": "string"
+ },
+ "width": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "height": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "timespan": {
+ "type": "string"
+ },
+ "styleOptions": {
+ "$ref": "#/definitions/Style"
+ }
+ }
+ },
+ "Style": {
+ "type": "object",
+ "description": "",
+ "properties": {
+ "chartType": {
+ "type": "string",
+ "enum": [
+ "line",
+ "bar"
+ ]
+ }
+ }
+ },
+ "Error": {
+ "type": "object",
+ "properties": {
+ "statusCode": {
+ "type": "integer",
+ "format": "int32"
+ },
+ "reason": {
+ "type": "string"
+ },
+ "userMessage": {
+ "type": "string"
+ }
+ }
+ }
+ }
+}
\ No newline at end of file
diff --git a/web-resources/docs/_includes/extensions/database_metadata.md b/web-resources/docs/_includes/extensions/database_metadata.md
new file mode 100644
index 000000000..ca8c755f0
--- /dev/null
+++ b/web-resources/docs/_includes/extensions/database_metadata.md
@@ -0,0 +1,32 @@
+
+Next to the actual phenomenon time observation data may have a `resultTime` which
+indicates when the data became available. An example for such cases is forecast data
+which may be (re-)calculated multiple times (optionally based on multiple models).
+Getting the right data values (belonging to a specific result time) a client can add
+the `resultTime=...` parameter when querying `datasets/
+
+
+
+
+
+
+
+
+
+
+
+
+
diff --git a/web-resources/docs/_layouts/page.html b/web-resources/docs/_layouts/page.html
new file mode 100644
index 000000000..4804baf7a
--- /dev/null
+++ b/web-resources/docs/_layouts/page.html
@@ -0,0 +1,11 @@
+---
+layout: default
+---
+
+
+ {{ route[0] }}
+ {% for method in route[1] %}
+
+{% endfor %}
+
+
diff --git a/web-resources/docs/_sass/_bootstrap-compass.scss b/web-resources/docs/_sass/_bootstrap-compass.scss
new file mode 100644
index 000000000..8fbc3cda5
--- /dev/null
+++ b/web-resources/docs/_sass/_bootstrap-compass.scss
@@ -0,0 +1,9 @@
+@function twbs-font-path($path) {
+ @return font-url($path, true);
+}
+
+@function twbs-image-path($path) {
+ @return image-url($path, true);
+}
+
+$bootstrap-sass-asset-helper: true;
diff --git a/web-resources/docs/_sass/_bootstrap-mincer.scss b/web-resources/docs/_sass/_bootstrap-mincer.scss
new file mode 100644
index 000000000..0c4655e32
--- /dev/null
+++ b/web-resources/docs/_sass/_bootstrap-mincer.scss
@@ -0,0 +1,19 @@
+// Mincer asset helper functions
+//
+// This must be imported into a .css.ejs.scss file.
+// Then, <% %>-interpolations will be parsed as strings by Sass, and evaluated by EJS after Sass compilation.
+
+
+@function twbs-font-path($path) {
+ // do something like following
+ // from "path/to/font.ext#suffix" to "<%- asset_path(path/to/font.ext)) + #suffix %>"
+ // from "path/to/font.ext?#suffix" to "<%- asset_path(path/to/font.ext)) + ?#suffix %>"
+ // or from "path/to/font.ext" just "<%- asset_path(path/to/font.ext)) %>"
+ @return "<%- asset_path("#{$path}".replace(/[#?].*$/, '')) + "#{$path}".replace(/(^[^#?]*)([#?]?.*$)/, '$2') %>";
+}
+
+@function twbs-image-path($file) {
+ @return "<%- asset_path("#{$file}") %>";
+}
+
+$bootstrap-sass-asset-helper: true;
diff --git a/web-resources/docs/_sass/_bootstrap-sprockets.scss b/web-resources/docs/_sass/_bootstrap-sprockets.scss
new file mode 100644
index 000000000..9fffc1eb4
--- /dev/null
+++ b/web-resources/docs/_sass/_bootstrap-sprockets.scss
@@ -0,0 +1,9 @@
+@function twbs-font-path($path) {
+ @return font-path($path);
+}
+
+@function twbs-image-path($path) {
+ @return image-path($path);
+}
+
+$bootstrap-sass-asset-helper: true;
diff --git a/web-resources/docs/_sass/_bootstrap.scss b/web-resources/docs/_sass/_bootstrap.scss
new file mode 100644
index 000000000..e72d1def2
--- /dev/null
+++ b/web-resources/docs/_sass/_bootstrap.scss
@@ -0,0 +1,56 @@
+/*!
+ * Bootstrap v3.3.7 (http://getbootstrap.com)
+ * Copyright 2011-2016 Twitter, Inc.
+ * Licensed under MIT (https://github.com/twbs/bootstrap/blob/master/LICENSE)
+ */
+
+// Core variables and mixins
+@import "bootstrap/variables";
+@import "bootstrap/mixins";
+
+// Reset and dependencies
+@import "bootstrap/normalize";
+@import "bootstrap/print";
+@import "bootstrap/glyphicons";
+
+// Core CSS
+@import "bootstrap/scaffolding";
+@import "bootstrap/type";
+@import "bootstrap/code";
+@import "bootstrap/grid";
+@import "bootstrap/tables";
+@import "bootstrap/forms";
+@import "bootstrap/buttons";
+
+// Components
+@import "bootstrap/component-animations";
+@import "bootstrap/dropdowns";
+@import "bootstrap/button-groups";
+@import "bootstrap/input-groups";
+@import "bootstrap/navs";
+@import "bootstrap/navbar";
+@import "bootstrap/breadcrumbs";
+@import "bootstrap/pagination";
+@import "bootstrap/pager";
+@import "bootstrap/labels";
+@import "bootstrap/badges";
+@import "bootstrap/jumbotron";
+@import "bootstrap/thumbnails";
+@import "bootstrap/alerts";
+@import "bootstrap/progress-bars";
+@import "bootstrap/media";
+@import "bootstrap/list-group";
+@import "bootstrap/panels";
+@import "bootstrap/responsive-embed";
+@import "bootstrap/wells";
+@import "bootstrap/close";
+
+// Components w/ JavaScript
+@import "bootstrap/modals";
+@import "bootstrap/tooltip";
+@import "bootstrap/popovers";
+@import "bootstrap/carousel";
+
+// Utility classes
+@import "bootstrap/utilities";
+@import "bootstrap/responsive-utilities";
diff --git a/web-resources/docs/_sass/_highlights.scss b/web-resources/docs/_sass/_highlights.scss
new file mode 100644
index 000000000..cdc2fe71d
--- /dev/null
+++ b/web-resources/docs/_sass/_highlights.scss
@@ -0,0 +1,357 @@
+.highlight {
+ background-color: #efefef;
+ padding: 7px 7px 7px 10px;
+ border: 1px solid #ddd;
+ -moz-box-shadow: 3px 3px rgba(0, 0, 0, 0.1);
+ -webkit-box-shadow: 3px 3px rgba(0, 0, 0, 0.1);
+ box-shadow: 3px 3px rgba(0, 0, 0, 0.1);
+ margin: 20px 0 20px 0;
+ overflow: scroll;
+}
+
+code {
+ font-family: 'Bitstream Vera Sans Mono','Courier', monospace;
+}
+
+.highlight .c {
+ color: #586E75;
+}
+
+/* Comment */
+.highlight .err {
+ color: #93A1A1;
+}
+
+/* Error */
+.highlight .g {
+ color: #93A1A1;
+}
+
+/* Generic */
+.highlight .k {
+ color: #859900;
+}
+
+/* Keyword */
+.highlight .l {
+ color: #93A1A1;
+}
+
+/* Literal */
+.highlight .n {
+ color: #93A1A1;
+}
+
+/* Name */
+.highlight .o {
+ color: #859900;
+}
+
+/* Operator */
+.highlight .x {
+ color: #CB4B16;
+}
+
+/* Other */
+.highlight .p {
+ color: #93A1A1;
+}
+
+/* Punctuation */
+.highlight .cm {
+ color: #586E75;
+}
+
+/* Comment.Multiline */
+.highlight .cp {
+ color: #859900;
+}
+
+/* Comment.Preproc */
+.highlight .c1 {
+ color: #586E75;
+}
+
+/* Comment.Single */
+.highlight .cs {
+ color: #859900;
+}
+
+/* Comment.Special */
+.highlight .gd {
+ color: #2AA198;
+}
+
+/* Generic.Deleted */
+.highlight .ge {
+ color: #93A1A1;
+ font-style: italic;
+}
+
+/* Generic.Emph */
+.highlight .gr {
+ color: #DC322F;
+}
+
+/* Generic.Error */
+.highlight .gh {
+ color: #CB4B16;
+}
+
+/* Generic.Heading */
+.highlight .gi {
+ color: #859900;
+}
+
+/* Generic.Inserted */
+.highlight .go {
+ color: #93A1A1;
+}
+
+/* Generic.Output */
+.highlight .gp {
+ color: #93A1A1;
+}
+
+/* Generic.Prompt */
+.highlight .gs {
+ color: #93A1A1;
+ font-weight: bold;
+}
+
+/* Generic.Strong */
+.highlight .gu {
+ color: #CB4B16;
+}
+
+/* Generic.Subheading */
+.highlight .gt {
+ color: #93A1A1;
+}
+
+/* Generic.Traceback */
+.highlight .kc {
+ color: #CB4B16;
+}
+
+/* Keyword.Constant */
+.highlight .kd {
+ color: #268BD2;
+}
+
+/* Keyword.Declaration */
+.highlight .kn {
+ color: #859900;
+}
+
+/* Keyword.Namespace */
+.highlight .kp {
+ color: #859900;
+}
+
+/* Keyword.Pseudo */
+.highlight .kr {
+ color: #268BD2;
+}
+
+/* Keyword.Reserved */
+.highlight .kt {
+ color: #DC322F;
+}
+
+/* Keyword.Type */
+.highlight .ld {
+ color: #93A1A1;
+}
+
+/* Literal.Date */
+.highlight .m {
+ color: #2AA198;
+}
+
+/* Literal.Number */
+.highlight .s {
+ color: #2AA198;
+}
+
+/* Literal.String */
+.highlight .na {
+ color: #93A1A1;
+}
+
+/* Name.Attribute */
+.highlight .nb {
+ color: #B58900;
+}
+
+/* Name.Builtin */
+.highlight .nc {
+ color: #268BD2;
+}
+
+/* Name.Class */
+.highlight .no {
+ color: #CB4B16;
+}
+
+/* Name.Constant */
+.highlight .nd {
+ color: #268BD2;
+}
+
+/* Name.Decorator */
+.highlight .ni {
+ color: #CB4B16;
+}
+
+/* Name.Entity */
+.highlight .ne {
+ color: #CB4B16;
+}
+
+/* Name.Exception */
+.highlight .nf {
+ color: #268BD2;
+}
+
+/* Name.Function */
+.highlight .nl {
+ color: #93A1A1;
+}
+
+/* Name.Label */
+.highlight .nn {
+ color: #93A1A1;
+}
+
+/* Name.Namespace */
+.highlight .nx {
+ color: #555;
+}
+
+/* Name.Other */
+.highlight .py {
+ color: #93A1A1;
+}
+
+/* Name.Property */
+.highlight .nt {
+ color: #268BD2;
+}
+
+/* Name.Tag */
+.highlight .nv {
+ color: #268BD2;
+}
+
+/* Name.Variable */
+.highlight .ow {
+ color: #859900;
+}
+
+/* Operator.Word */
+.highlight .w {
+ color: #93A1A1;
+}
+
+/* Text.Whitespace */
+.highlight .mf {
+ color: #2AA198;
+}
+
+/* Literal.Number.Float */
+.highlight .mh {
+ color: #2AA198;
+}
+
+/* Literal.Number.Hex */
+.highlight .mi {
+ color: #2AA198;
+}
+
+/* Literal.Number.Integer */
+.highlight .mo {
+ color: #2AA198;
+}
+
+/* Literal.Number.Oct */
+.highlight .sb {
+ color: #586E75;
+}
+
+/* Literal.String.Backtick */
+.highlight .sc {
+ color: #2AA198;
+}
+
+/* Literal.String.Char */
+.highlight .sd {
+ color: #93A1A1;
+}
+
+/* Literal.String.Doc */
+.highlight .s2 {
+ color: #2AA198;
+}
+
+/* Literal.String.Double */
+.highlight .se {
+ color: #CB4B16;
+}
+
+/* Literal.String.Escape */
+.highlight .sh {
+ color: #93A1A1;
+}
+
+/* Literal.String.Heredoc */
+.highlight .si {
+ color: #2AA198;
+}
+
+/* Literal.String.Interpol */
+.highlight .sx {
+ color: #2AA198;
+}
+
+/* Literal.String.Other */
+.highlight .sr {
+ color: #DC322F;
+}
+
+/* Literal.String.Regex */
+.highlight .s1 {
+ color: #2AA198;
+}
+
+/* Literal.String.Single */
+.highlight .ss {
+ color: #2AA198;
+}
+
+/* Literal.String.Symbol */
+.highlight .bp {
+ color: #268BD2;
+}
+
+/* Name.Builtin.Pseudo */
+.highlight .vc {
+ color: #268BD2;
+}
+
+/* Name.Variable.Class */
+.highlight .vg {
+ color: #268BD2;
+}
+
+/* Name.Variable.Global */
+.highlight .vi {
+ color: #268BD2;
+}
+
+/* Name.Variable.Instance */
+.highlight .il {
+ color: #2AA198;
+}
+
+/* Literal.Number.Integer.Long */
diff --git a/web-resources/docs/_sass/_reset.scss b/web-resources/docs/_sass/_reset.scss
new file mode 100644
index 000000000..14cbce7aa
--- /dev/null
+++ b/web-resources/docs/_sass/_reset.scss
@@ -0,0 +1,61 @@
+/***************/
+/* MEYER RESET */
+/***************/
+
+html, body, div, span, applet, object, iframe,
+h1, h2, h3, h4, h5, h6, p, blockquote,
+a, abbr, acronym, address, big, cite, code,
+del, dfn, em, img, ins, kbd, q, s, samp,
+small, strike, strong, sub, sup, tt, var,
+b, u, i, center,
+dl, dt, dd, ol, ul, li,
+fieldset, form, label, legend,
+table, caption, tbody, tfoot, thead, tr, th, td,
+article, aside, canvas, details, embed,
+figure, figcaption, footer, header, hgroup,
+menu, nav, output, ruby, section, summary,
+time, mark, audio, video {
+ margin: 0;
+ padding: 0;
+ border: 0;
+ font-size: 100%;
+ font: inherit;
+ vertical-align: baseline;
+}
+
+// HTML5 display-role reset for older browsers
+article, aside, details, figcaption, figure,
+footer, header, hgroup, menu, nav, section {
+ display: block;
+}
+
+body {
+ line-height: 1;
+}
+
+ol, ul {
+ list-style: none;
+}
+
+blockquote, q {
+ quotes: none;
+}
+
+blockquote:before, blockquote:after,
+q:before, q:after {
+ content: '';
+ content: none;
+}
+
+table {
+ border-collapse: collapse;
+ border-spacing: 2px;
+}
+
+// Apply a natural box layout model to all elements
+// from: http://www.paulirish.com/2012/box-sizing-border-box-ftw/
+*, *:before, *:after {
+ -moz-box-sizing: border-box;
+ -webkit-box-sizing: border-box;
+ box-sizing: border-box;
+}
diff --git a/web-resources/docs/_sass/_swagger.scss b/web-resources/docs/_sass/_swagger.scss
new file mode 100644
index 000000000..7ba1eed91
--- /dev/null
+++ b/web-resources/docs/_sass/_swagger.scss
@@ -0,0 +1,110 @@
+@mixin swagger-method($color) {
+ border: 1px solid $color;
+
+ .swagger-method-title {
+ background: lighten($color, 30%);
+ }
+
+ .swagger-method-link {
+ color: darken($color, 20%);
+ }
+
+ .swagger-method-name {
+ background: $color;
+ }
+}
+
+.swagger-path {
+ font-size: $base-font-size * 1.2;
+ margin: 25px 0 10px 0;
+ font-family: Courier New,Consolas,Monaco,Lucida Console,Liberation Mono,DejaVu Sans Mono,Bitstream Vera Sans Mono, monospace;
+}
+
+.swagger-method {
+ padding: 0;
+ margin: 10px 0;
+ border-radius: 5px;
+}
+
+.swagger-method-title {
+ font-size: $base-font-size;
+ margin: 0;
+ cursor: pointer;
+}
+
+.swagger-method-link {
+ &:hover {
+ text-decoration: none;
+ }
+}
+
+.swagger-method-name {
+ padding: 6px 0;
+ display: inline-block;
+ width: 80px;
+ text-align: center;
+ color: white;
+ margin-right: 10px;
+}
+
+.swagger-method-get {
+ @include swagger-method(#6BBD5B);
+}
+
+.swagger-method-post {
+ @include swagger-method(#248FB2);
+}
+
+.swagger-method-put {
+ @include swagger-method(#9B708B);
+}
+
+.swagger-method-patch {
+ @include swagger-method(#D88541);
+}
+
+.swagger-method-delete {
+ @include swagger-method(#E27A7A);
+}
+
+.swagger-method-details {
+ margin: 0;
+ padding: 15px;
+ display: none;
+
+ &.open {
+ display: block;
+ }
+}
+
+.swagger-response {
+ font-size: $base-font-size;
+
+ h5 {
+ margin: 10px 0 5px 0;
+ }
+}
+
+.swagger-response-code {
+ font-weight: 600;
+
+ &:after {
+ content: ' — ';
+ }
+}
+
+.swagger-parameters {
+ .table {
+ border-spacing: 0px;
+ border-collapse: collapse;
+ margin-bottom: $spacing-unit;
+ width: 100%;
+ }
+}
+
+.swagger-parameter-required {
+ &:after {
+ content: ' *';
+ color: red;
+ }
+}
diff --git a/web-resources/docs/_sass/_variables.scss b/web-resources/docs/_sass/_variables.scss
new file mode 100644
index 000000000..9966cb615
--- /dev/null
+++ b/web-resources/docs/_sass/_variables.scss
@@ -0,0 +1,30 @@
+//
+// VARIABLES
+//
+
+// Colors
+$blue: #4183C4;
+
+// Grays
+$black: #000;
+$darkerGray: #222;
+$darkGray: #333;
+$gray: #666;
+$lightGray: #eee;
+$white: #fff;
+
+// Font stacks
+$helvetica: Helvetica, Arial, sans-serif;
+$helveticaNeue: "Helvetica Neue", Helvetica, Arial, sans-serif;
+$georgia: Georgia, serif;
+
+// Mobile breakpoints
+@mixin mobile {
+ @media screen and (max-width: 640px) {
+ @content;
+ }
+}
+
+$base-font-size: 16px;
+$spacing-unit: 0.5em;
+$grey-color-light: #666
diff --git a/web-resources/docs/_sass/bootstrap/_alerts.scss b/web-resources/docs/_sass/bootstrap/_alerts.scss
new file mode 100644
index 000000000..7d1e1fddd
--- /dev/null
+++ b/web-resources/docs/_sass/bootstrap/_alerts.scss
@@ -0,0 +1,73 @@
+//
+// Alerts
+// --------------------------------------------------
+
+
+// Base styles
+// -------------------------
+
+.alert {
+ padding: $alert-padding;
+ margin-bottom: $line-height-computed;
+ border: 1px solid transparent;
+ border-radius: $alert-border-radius;
+
+ // Headings for larger alerts
+ h4 {
+ margin-top: 0;
+ // Specified for the h4 to prevent conflicts of changing $headings-color
+ color: inherit;
+ }
+
+ // Provide class for links that match alerts
+ .alert-link {
+ font-weight: $alert-link-font-weight;
+ }
+
+ // Improve alignment and spacing of inner content
+ > p,
+ > ul {
+ margin-bottom: 0;
+ }
+
+ > p + p {
+ margin-top: 5px;
+ }
+}
+
+// Dismissible alerts
+//
+// Expand the right padding and account for the close button's positioning.
+
+.alert-dismissable, // The misspelled .alert-dismissable was deprecated in 3.2.0.
+.alert-dismissible {
+ padding-right: ($alert-padding + 20);
+
+ // Adjust close link position
+ .close {
+ position: relative;
+ top: -2px;
+ right: -21px;
+ color: inherit;
+ }
+}
+
+// Alternate styles
+//
+// Generate contextual modifier classes for colorizing the alert.
+
+.alert-success {
+ @include alert-variant($alert-success-bg, $alert-success-border, $alert-success-text);
+}
+
+.alert-info {
+ @include alert-variant($alert-info-bg, $alert-info-border, $alert-info-text);
+}
+
+.alert-warning {
+ @include alert-variant($alert-warning-bg, $alert-warning-border, $alert-warning-text);
+}
+
+.alert-danger {
+ @include alert-variant($alert-danger-bg, $alert-danger-border, $alert-danger-text);
+}
diff --git a/web-resources/docs/_sass/bootstrap/_badges.scss b/web-resources/docs/_sass/bootstrap/_badges.scss
new file mode 100644
index 000000000..70002e085
--- /dev/null
+++ b/web-resources/docs/_sass/bootstrap/_badges.scss
@@ -0,0 +1,68 @@
+//
+// Badges
+// --------------------------------------------------
+
+
+// Base class
+.badge {
+ display: inline-block;
+ min-width: 10px;
+ padding: 3px 7px;
+ font-size: $font-size-small;
+ font-weight: $badge-font-weight;
+ color: $badge-color;
+ line-height: $badge-line-height;
+ vertical-align: middle;
+ white-space: nowrap;
+ text-align: center;
+ background-color: $badge-bg;
+ border-radius: $badge-border-radius;
+
+ // Empty badges collapse automatically (not available in IE8)
+ &:empty {
+ display: none;
+ }
+
+ // Quick fix for badges in buttons
+ .btn & {
+ position: relative;
+ top: -1px;
+ }
+
+ .btn-xs &,
+ .btn-group-xs > .btn & {
+ top: 0;
+ padding: 1px 5px;
+ }
+
+ // [converter] extracted a& to a.badge
+
+ // Account for badges in navs
+ .list-group-item.active > &,
+ .nav-pills > .active > a > & {
+ color: $badge-active-color;
+ background-color: $badge-active-bg;
+ }
+
+ .list-group-item > & {
+ float: right;
+ }
+
+ .list-group-item > & + & {
+ margin-right: 5px;
+ }
+
+ .nav-pills > li > a > & {
+ margin-left: 3px;
+ }
+}
+
+// Hover state, but only for links
+a.badge {
+ &:hover,
+ &:focus {
+ color: $badge-link-hover-color;
+ text-decoration: none;
+ cursor: pointer;
+ }
+}
diff --git a/web-resources/docs/_sass/bootstrap/_breadcrumbs.scss b/web-resources/docs/_sass/bootstrap/_breadcrumbs.scss
new file mode 100644
index 000000000..b61f0c731
--- /dev/null
+++ b/web-resources/docs/_sass/bootstrap/_breadcrumbs.scss
@@ -0,0 +1,28 @@
+//
+// Breadcrumbs
+// --------------------------------------------------
+
+
+.breadcrumb {
+ padding: $breadcrumb-padding-vertical $breadcrumb-padding-horizontal;
+ margin-bottom: $line-height-computed;
+ list-style: none;
+ background-color: $breadcrumb-bg;
+ border-radius: $border-radius-base;
+
+ > li {
+ display: inline-block;
+
+ + li:before {
+ // [converter] Workaround for https://github.com/sass/libsass/issues/1115
+ $nbsp: "\00a0";
+ content: "#{$breadcrumb-separator}#{$nbsp}"; // Unicode space added since inline-block means non-collapsing white-space
+ padding: 0 5px;
+ color: $breadcrumb-color;
+ }
+ }
+
+ > .active {
+ color: $breadcrumb-active-color;
+ }
+}
diff --git a/web-resources/docs/_sass/bootstrap/_button-groups.scss b/web-resources/docs/_sass/bootstrap/_button-groups.scss
new file mode 100644
index 000000000..4b385f569
--- /dev/null
+++ b/web-resources/docs/_sass/bootstrap/_button-groups.scss
@@ -0,0 +1,244 @@
+//
+// Button groups
+// --------------------------------------------------
+
+// Make the div behave like a button
+.btn-group,
+.btn-group-vertical {
+ position: relative;
+ display: inline-block;
+ vertical-align: middle; // match .btn alignment given font-size hack above
+ > .btn {
+ position: relative;
+ float: left;
+ // Bring the "active" button to the front
+ &:hover,
+ &:focus,
+ &:active,
+ &.active {
+ z-index: 2;
+ }
+ }
+}
+
+// Prevent double borders when buttons are next to each other
+.btn-group {
+ .btn + .btn,
+ .btn + .btn-group,
+ .btn-group + .btn,
+ .btn-group + .btn-group {
+ margin-left: -1px;
+ }
+}
+
+// Optional: Group multiple button groups together for a toolbar
+.btn-toolbar {
+ margin-left: -5px; // Offset the first child's margin
+ @include clearfix;
+
+ .btn,
+ .btn-group,
+ .input-group {
+ float: left;
+ }
+ > .btn,
+ > .btn-group,
+ > .input-group {
+ margin-left: 5px;
+ }
+}
+
+.btn-group > .btn:not(:first-child):not(:last-child):not(.dropdown-toggle) {
+ border-radius: 0;
+}
+
+// Set corners individual because sometimes a single button can be in a .btn-group and we need :first-child and :last-child to both match
+.btn-group > .btn:first-child {
+ margin-left: 0;
+ &:not(:last-child):not(.dropdown-toggle) {
+ @include border-right-radius(0);
+ }
+}
+// Need .dropdown-toggle since :last-child doesn't apply, given that a .dropdown-menu is used immediately after it
+.btn-group > .btn:last-child:not(:first-child),
+.btn-group > .dropdown-toggle:not(:first-child) {
+ @include border-left-radius(0);
+}
+
+// Custom edits for including btn-groups within btn-groups (useful for including dropdown buttons within a btn-group)
+.btn-group > .btn-group {
+ float: left;
+}
+.btn-group > .btn-group:not(:first-child):not(:last-child) > .btn {
+ border-radius: 0;
+}
+.btn-group > .btn-group:first-child:not(:last-child) {
+ > .btn:last-child,
+ > .dropdown-toggle {
+ @include border-right-radius(0);
+ }
+}
+.btn-group > .btn-group:last-child:not(:first-child) > .btn:first-child {
+ @include border-left-radius(0);
+}
+
+// On active and open, don't show outline
+.btn-group .dropdown-toggle:active,
+.btn-group.open .dropdown-toggle {
+ outline: 0;
+}
+
+
+// Sizing
+//
+// Remix the default button sizing classes into new ones for easier manipulation.
+
+.btn-group-xs > .btn { @extend .btn-xs; }
+.btn-group-sm > .btn { @extend .btn-sm; }
+.btn-group-lg > .btn { @extend .btn-lg; }
+
+
+// Split button dropdowns
+// ----------------------
+
+// Give the line between buttons some depth
+.btn-group > .btn + .dropdown-toggle {
+ padding-left: 8px;
+ padding-right: 8px;
+}
+.btn-group > .btn-lg + .dropdown-toggle {
+ padding-left: 12px;
+ padding-right: 12px;
+}
+
+// The clickable button for toggling the menu
+// Remove the gradient and set the same inset shadow as the :active state
+.btn-group.open .dropdown-toggle {
+ @include box-shadow(inset 0 3px 5px rgba(0,0,0,.125));
+
+ // Show no shadow for `.btn-link` since it has no other button styles.
+ &.btn-link {
+ @include box-shadow(none);
+ }
+}
+
+
+// Reposition the caret
+.btn .caret {
+ margin-left: 0;
+}
+// Carets in other button sizes
+.btn-lg .caret {
+ border-width: $caret-width-large $caret-width-large 0;
+ border-bottom-width: 0;
+}
+// Upside down carets for .dropup
+.dropup .btn-lg .caret {
+ border-width: 0 $caret-width-large $caret-width-large;
+}
+
+
+// Vertical button groups
+// ----------------------
+
+.btn-group-vertical {
+ > .btn,
+ > .btn-group,
+ > .btn-group > .btn {
+ display: block;
+ float: none;
+ width: 100%;
+ max-width: 100%;
+ }
+
+ // Clear floats so dropdown menus can be properly placed
+ > .btn-group {
+ @include clearfix;
+ > .btn {
+ float: none;
+ }
+ }
+
+ > .btn + .btn,
+ > .btn + .btn-group,
+ > .btn-group + .btn,
+ > .btn-group + .btn-group {
+ margin-top: -1px;
+ margin-left: 0;
+ }
+}
+
+.btn-group-vertical > .btn {
+ &:not(:first-child):not(:last-child) {
+ border-radius: 0;
+ }
+ &:first-child:not(:last-child) {
+ @include border-top-radius($btn-border-radius-base);
+ @include border-bottom-radius(0);
+ }
+ &:last-child:not(:first-child) {
+ @include border-top-radius(0);
+ @include border-bottom-radius($btn-border-radius-base);
+ }
+}
+.btn-group-vertical > .btn-group:not(:first-child):not(:last-child) > .btn {
+ border-radius: 0;
+}
+.btn-group-vertical > .btn-group:first-child:not(:last-child) {
+ > .btn:last-child,
+ > .dropdown-toggle {
+ @include border-bottom-radius(0);
+ }
+}
+.btn-group-vertical > .btn-group:last-child:not(:first-child) > .btn:first-child {
+ @include border-top-radius(0);
+}
+
+
+// Justified button groups
+// ----------------------
+
+.btn-group-justified {
+ display: table;
+ width: 100%;
+ table-layout: fixed;
+ border-collapse: separate;
+ > .btn,
+ > .btn-group {
+ float: none;
+ display: table-cell;
+ width: 1%;
+ }
+ > .btn-group .btn {
+ width: 100%;
+ }
+
+ > .btn-group .dropdown-menu {
+ left: auto;
+ }
+}
+
+
+// Checkbox and radio options
+//
+// In order to support the browser's form validation feedback, powered by the
+// `required` attribute, we have to "hide" the inputs via `clip`. We cannot use
+// `display: none;` or `visibility: hidden;` as that also hides the popover.
+// Simply visually hiding the inputs via `opacity` would leave them clickable in
+// certain cases which is prevented by using `clip` and `pointer-events`.
+// This way, we ensure a DOM element is visible to position the popover from.
+//
+// See https://github.com/twbs/bootstrap/pull/12794 and
+// https://github.com/twbs/bootstrap/pull/14559 for more information.
+
+[data-toggle="buttons"] {
+ > .btn,
+ > .btn-group > .btn {
+ input[type="radio"],
+ input[type="checkbox"] {
+ position: absolute;
+ clip: rect(0,0,0,0);
+ pointer-events: none;
+ }
+ }
+}
diff --git a/web-resources/docs/_sass/bootstrap/_buttons.scss b/web-resources/docs/_sass/bootstrap/_buttons.scss
new file mode 100644
index 000000000..6452b709f
--- /dev/null
+++ b/web-resources/docs/_sass/bootstrap/_buttons.scss
@@ -0,0 +1,168 @@
+//
+// Buttons
+// --------------------------------------------------
+
+
+// Base styles
+// --------------------------------------------------
+
+.btn {
+ display: inline-block;
+ margin-bottom: 0; // For input.btn
+ font-weight: $btn-font-weight;
+ text-align: center;
+ vertical-align: middle;
+ touch-action: manipulation;
+ cursor: pointer;
+ background-image: none; // Reset unusual Firefox-on-Android default style; see https://github.com/necolas/normalize.css/issues/214
+ border: 1px solid transparent;
+ white-space: nowrap;
+ @include button-size($padding-base-vertical, $padding-base-horizontal, $font-size-base, $line-height-base, $btn-border-radius-base);
+ @include user-select(none);
+
+ &,
+ &:active,
+ &.active {
+ &:focus,
+ &.focus {
+ @include tab-focus;
+ }
+ }
+
+ &:hover,
+ &:focus,
+ &.focus {
+ color: $btn-default-color;
+ text-decoration: none;
+ }
+
+ &:active,
+ &.active {
+ outline: 0;
+ background-image: none;
+ @include box-shadow(inset 0 3px 5px rgba(0,0,0,.125));
+ }
+
+ &.disabled,
+ &[disabled],
+ fieldset[disabled] & {
+ cursor: $cursor-disabled;
+ @include opacity(.65);
+ @include box-shadow(none);
+ }
+
+ // [converter] extracted a& to a.btn
+}
+
+a.btn {
+ &.disabled,
+ fieldset[disabled] & {
+ pointer-events: none; // Future-proof disabling of clicks on `` elements
+ }
+}
+
+
+// Alternate buttons
+// --------------------------------------------------
+
+.btn-default {
+ @include button-variant($btn-default-color, $btn-default-bg, $btn-default-border);
+}
+.btn-primary {
+ @include button-variant($btn-primary-color, $btn-primary-bg, $btn-primary-border);
+}
+// Success appears as green
+.btn-success {
+ @include button-variant($btn-success-color, $btn-success-bg, $btn-success-border);
+}
+// Info appears as blue-green
+.btn-info {
+ @include button-variant($btn-info-color, $btn-info-bg, $btn-info-border);
+}
+// Warning appears as orange
+.btn-warning {
+ @include button-variant($btn-warning-color, $btn-warning-bg, $btn-warning-border);
+}
+// Danger and error appear as red
+.btn-danger {
+ @include button-variant($btn-danger-color, $btn-danger-bg, $btn-danger-border);
+}
+
+
+// Link buttons
+// -------------------------
+
+// Make a button look and behave like a link
+.btn-link {
+ color: $link-color;
+ font-weight: normal;
+ border-radius: 0;
+
+ &,
+ &:active,
+ &.active,
+ &[disabled],
+ fieldset[disabled] & {
+ background-color: transparent;
+ @include box-shadow(none);
+ }
+ &,
+ &:hover,
+ &:focus,
+ &:active {
+ border-color: transparent;
+ }
+ &:hover,
+ &:focus {
+ color: $link-hover-color;
+ text-decoration: $link-hover-decoration;
+ background-color: transparent;
+ }
+ &[disabled],
+ fieldset[disabled] & {
+ &:hover,
+ &:focus {
+ color: $btn-link-disabled-color;
+ text-decoration: none;
+ }
+ }
+}
+
+
+// Button Sizes
+// --------------------------------------------------
+
+.btn-lg {
+ // line-height: ensure even-numbered height of button next to large input
+ @include button-size($padding-large-vertical, $padding-large-horizontal, $font-size-large, $line-height-large, $btn-border-radius-large);
+}
+.btn-sm {
+ // line-height: ensure proper height of button next to small input
+ @include button-size($padding-small-vertical, $padding-small-horizontal, $font-size-small, $line-height-small, $btn-border-radius-small);
+}
+.btn-xs {
+ @include button-size($padding-xs-vertical, $padding-xs-horizontal, $font-size-small, $line-height-small, $btn-border-radius-small);
+}
+
+
+// Block button
+// --------------------------------------------------
+
+.btn-block {
+ display: block;
+ width: 100%;
+}
+
+// Vertically space out multiple block buttons
+.btn-block + .btn-block {
+ margin-top: 5px;
+}
+
+// Specificity overrides
+input[type="submit"],
+input[type="reset"],
+input[type="button"] {
+ &.btn-block {
+ width: 100%;
+ }
+}
diff --git a/web-resources/docs/_sass/bootstrap/_carousel.scss b/web-resources/docs/_sass/bootstrap/_carousel.scss
new file mode 100644
index 000000000..753d881f4
--- /dev/null
+++ b/web-resources/docs/_sass/bootstrap/_carousel.scss
@@ -0,0 +1,270 @@
+//
+// Carousel
+// --------------------------------------------------
+
+
+// Wrapper for the slide container and indicators
+.carousel {
+ position: relative;
+}
+
+.carousel-inner {
+ position: relative;
+ overflow: hidden;
+ width: 100%;
+
+ > .item {
+ display: none;
+ position: relative;
+ @include transition(.6s ease-in-out left);
+
+ // Account for jankitude on images
+ > img,
+ > a > img {
+ @include img-responsive;
+ line-height: 1;
+ }
+
+ // WebKit CSS3 transforms for supported devices
+ @media all and (transform-3d), (-webkit-transform-3d) {
+ @include transition-transform(0.6s ease-in-out);
+ @include backface-visibility(hidden);
+ @include perspective(1000px);
+
+ &.next,
+ &.active.right {
+ @include translate3d(100%, 0, 0);
+ left: 0;
+ }
+ &.prev,
+ &.active.left {
+ @include translate3d(-100%, 0, 0);
+ left: 0;
+ }
+ &.next.left,
+ &.prev.right,
+ &.active {
+ @include translate3d(0, 0, 0);
+ left: 0;
+ }
+ }
+ }
+
+ > .active,
+ > .next,
+ > .prev {
+ display: block;
+ }
+
+ > .active {
+ left: 0;
+ }
+
+ > .next,
+ > .prev {
+ position: absolute;
+ top: 0;
+ width: 100%;
+ }
+
+ > .next {
+ left: 100%;
+ }
+ > .prev {
+ left: -100%;
+ }
+ > .next.left,
+ > .prev.right {
+ left: 0;
+ }
+
+ > .active.left {
+ left: -100%;
+ }
+ > .active.right {
+ left: 100%;
+ }
+
+}
+
+// Left/right controls for nav
+// ---------------------------
+
+.carousel-control {
+ position: absolute;
+ top: 0;
+ left: 0;
+ bottom: 0;
+ width: $carousel-control-width;
+ @include opacity($carousel-control-opacity);
+ font-size: $carousel-control-font-size;
+ color: $carousel-control-color;
+ text-align: center;
+ text-shadow: $carousel-text-shadow;
+ background-color: rgba(0, 0, 0, 0); // Fix IE9 click-thru bug
+ // We can't have this transition here because WebKit cancels the carousel
+ // animation if you trip this while in the middle of another animation.
+
+ // Set gradients for backgrounds
+ &.left {
+ @include gradient-horizontal($start-color: rgba(0,0,0,.5), $end-color: rgba(0,0,0,.0001));
+ }
+ &.right {
+ left: auto;
+ right: 0;
+ @include gradient-horizontal($start-color: rgba(0,0,0,.0001), $end-color: rgba(0,0,0,.5));
+ }
+
+ // Hover/focus state
+ &:hover,
+ &:focus {
+ outline: 0;
+ color: $carousel-control-color;
+ text-decoration: none;
+ @include opacity(.9);
+ }
+
+ // Toggles
+ .icon-prev,
+ .icon-next,
+ .glyphicon-chevron-left,
+ .glyphicon-chevron-right {
+ position: absolute;
+ top: 50%;
+ margin-top: -10px;
+ z-index: 5;
+ display: inline-block;
+ }
+ .icon-prev,
+ .glyphicon-chevron-left {
+ left: 50%;
+ margin-left: -10px;
+ }
+ .icon-next,
+ .glyphicon-chevron-right {
+ right: 50%;
+ margin-right: -10px;
+ }
+ .icon-prev,
+ .icon-next {
+ width: 20px;
+ height: 20px;
+ line-height: 1;
+ font-family: serif;
+ }
+
+
+ .icon-prev {
+ &:before {
+ content: '\2039';// SINGLE LEFT-POINTING ANGLE QUOTATION MARK (U+2039)
+ }
+ }
+ .icon-next {
+ &:before {
+ content: '\203a';// SINGLE RIGHT-POINTING ANGLE QUOTATION MARK (U+203A)
+ }
+ }
+}
+
+// Optional indicator pips
+//
+// Add an unordered list with the following class and add a list item for each
+// slide your carousel holds.
+
+.carousel-indicators {
+ position: absolute;
+ bottom: 10px;
+ left: 50%;
+ z-index: 15;
+ width: 60%;
+ margin-left: -30%;
+ padding-left: 0;
+ list-style: none;
+ text-align: center;
+
+ li {
+ display: inline-block;
+ width: 10px;
+ height: 10px;
+ margin: 1px;
+ text-indent: -999px;
+ border: 1px solid $carousel-indicator-border-color;
+ border-radius: 10px;
+ cursor: pointer;
+
+ // IE8-9 hack for event handling
+ //
+ // Internet Explorer 8-9 does not support clicks on elements without a set
+ // `background-color`. We cannot use `filter` since that's not viewed as a
+ // background color by the browser. Thus, a hack is needed.
+ // See https://developer.mozilla.org/en-US/docs/Web/Events/click#Internet_Explorer
+ //
+ // For IE8, we set solid black as it doesn't support `rgba()`. For IE9, we
+ // set alpha transparency for the best results possible.
+ background-color: #000 \9; // IE8
+ background-color: rgba(0,0,0,0); // IE9
+ }
+ .active {
+ margin: 0;
+ width: 12px;
+ height: 12px;
+ background-color: $carousel-indicator-active-bg;
+ }
+}
+
+// Optional captions
+// -----------------------------
+// Hidden by default for smaller viewports
+.carousel-caption {
+ position: absolute;
+ left: 15%;
+ right: 15%;
+ bottom: 20px;
+ z-index: 10;
+ padding-top: 20px;
+ padding-bottom: 20px;
+ color: $carousel-caption-color;
+ text-align: center;
+ text-shadow: $carousel-text-shadow;
+ & .btn {
+ text-shadow: none; // No shadow for button elements in carousel-caption
+ }
+}
+
+
+// Scale up controls for tablets and up
+@media screen and (min-width: $screen-sm-min) {
+
+ // Scale up the controls a smidge
+ .carousel-control {
+ .glyphicon-chevron-left,
+ .glyphicon-chevron-right,
+ .icon-prev,
+ .icon-next {
+ width: ($carousel-control-font-size * 1.5);
+ height: ($carousel-control-font-size * 1.5);
+ margin-top: ($carousel-control-font-size / -2);
+ font-size: ($carousel-control-font-size * 1.5);
+ }
+ .glyphicon-chevron-left,
+ .icon-prev {
+ margin-left: ($carousel-control-font-size / -2);
+ }
+ .glyphicon-chevron-right,
+ .icon-next {
+ margin-right: ($carousel-control-font-size / -2);
+ }
+ }
+
+ // Show and left align the captions
+ .carousel-caption {
+ left: 20%;
+ right: 20%;
+ padding-bottom: 30px;
+ }
+
+ // Move up the indicators
+ .carousel-indicators {
+ bottom: 20px;
+ }
+}
diff --git a/web-resources/docs/_sass/bootstrap/_close.scss b/web-resources/docs/_sass/bootstrap/_close.scss
new file mode 100644
index 000000000..3b74d8a97
--- /dev/null
+++ b/web-resources/docs/_sass/bootstrap/_close.scss
@@ -0,0 +1,36 @@
+//
+// Close icons
+// --------------------------------------------------
+
+
+.close {
+ float: right;
+ font-size: ($font-size-base * 1.5);
+ font-weight: $close-font-weight;
+ line-height: 1;
+ color: $close-color;
+ text-shadow: $close-text-shadow;
+ @include opacity(.2);
+
+ &:hover,
+ &:focus {
+ color: $close-color;
+ text-decoration: none;
+ cursor: pointer;
+ @include opacity(.5);
+ }
+
+ // [converter] extracted button& to button.close
+}
+
+// Additional properties for button version
+// iOS requires the button element instead of an anchor tag.
+// If you want the anchor version, it requires `href="#"`.
+// See https://developer.mozilla.org/en-US/docs/Web/Events/click#Safari_Mobile
+button.close {
+ padding: 0;
+ cursor: pointer;
+ background: transparent;
+ border: 0;
+ -webkit-appearance: none;
+}
diff --git a/web-resources/docs/_sass/bootstrap/_code.scss b/web-resources/docs/_sass/bootstrap/_code.scss
new file mode 100644
index 000000000..caa5f0630
--- /dev/null
+++ b/web-resources/docs/_sass/bootstrap/_code.scss
@@ -0,0 +1,69 @@
+//
+// Code (inline and block)
+// --------------------------------------------------
+
+
+// Inline and block code styles
+code,
+kbd,
+pre,
+samp {
+ font-family: $font-family-monospace;
+}
+
+// Inline code
+code {
+ padding: 2px 4px;
+ font-size: 90%;
+ color: $code-color;
+ background-color: $code-bg;
+ border-radius: $border-radius-base;
+}
+
+// User input typically entered via keyboard
+kbd {
+ padding: 2px 4px;
+ font-size: 90%;
+ color: $kbd-color;
+ background-color: $kbd-bg;
+ border-radius: $border-radius-small;
+ box-shadow: inset 0 -1px 0 rgba(0,0,0,.25);
+
+ kbd {
+ padding: 0;
+ font-size: 100%;
+ font-weight: bold;
+ box-shadow: none;
+ }
+}
+
+// Blocks of code
+pre {
+ display: block;
+ padding: (($line-height-computed - 1) / 2);
+ margin: 0 0 ($line-height-computed / 2);
+ font-size: ($font-size-base - 1); // 14px to 13px
+ line-height: $line-height-base;
+ word-break: break-all;
+ word-wrap: break-word;
+ color: $pre-color;
+ background-color: $pre-bg;
+ border: 1px solid $pre-border-color;
+ border-radius: $border-radius-base;
+
+ // Account for some code outputs that place code tags in pre tags
+ code {
+ padding: 0;
+ font-size: inherit;
+ color: inherit;
+ white-space: pre-wrap;
+ background-color: transparent;
+ border-radius: 0;
+ }
+}
+
+// Enable scrollable blocks of code
+.pre-scrollable {
+ max-height: $pre-scrollable-max-height;
+ overflow-y: scroll;
+}
diff --git a/web-resources/docs/_sass/bootstrap/_component-animations.scss b/web-resources/docs/_sass/bootstrap/_component-animations.scss
new file mode 100644
index 000000000..ca3b43ca7
--- /dev/null
+++ b/web-resources/docs/_sass/bootstrap/_component-animations.scss
@@ -0,0 +1,37 @@
+//
+// Component animations
+// --------------------------------------------------
+
+// Heads up!
+//
+// We don't use the `.opacity()` mixin here since it causes a bug with text
+// fields in IE7-8. Source: https://github.com/twbs/bootstrap/pull/3552.
+
+.fade {
+ opacity: 0;
+ @include transition(opacity .15s linear);
+ &.in {
+ opacity: 1;
+ }
+}
+
+.collapse {
+ display: none;
+
+ &.in { display: block; }
+ // [converter] extracted tr&.in to tr.collapse.in
+ // [converter] extracted tbody&.in to tbody.collapse.in
+}
+
+tr.collapse.in { display: table-row; }
+
+tbody.collapse.in { display: table-row-group; }
+
+.collapsing {
+ position: relative;
+ height: 0;
+ overflow: hidden;
+ @include transition-property(height, visibility);
+ @include transition-duration(.35s);
+ @include transition-timing-function(ease);
+}
diff --git a/web-resources/docs/_sass/bootstrap/_dropdowns.scss b/web-resources/docs/_sass/bootstrap/_dropdowns.scss
new file mode 100644
index 000000000..aac84597a
--- /dev/null
+++ b/web-resources/docs/_sass/bootstrap/_dropdowns.scss
@@ -0,0 +1,216 @@
+//
+// Dropdown menus
+// --------------------------------------------------
+
+
+// Dropdown arrow/caret
+.caret {
+ display: inline-block;
+ width: 0;
+ height: 0;
+ margin-left: 2px;
+ vertical-align: middle;
+ border-top: $caret-width-base dashed;
+ border-top: $caret-width-base solid \9; // IE8
+ border-right: $caret-width-base solid transparent;
+ border-left: $caret-width-base solid transparent;
+}
+
+// The dropdown wrapper (div)
+.dropup,
+.dropdown {
+ position: relative;
+}
+
+// Prevent the focus on the dropdown toggle when closing dropdowns
+.dropdown-toggle:focus {
+ outline: 0;
+}
+
+// The dropdown menu (ul)
+.dropdown-menu {
+ position: absolute;
+ top: 100%;
+ left: 0;
+ z-index: $zindex-dropdown;
+ display: none; // none by default, but block on "open" of the menu
+ float: left;
+ min-width: 160px;
+ padding: 5px 0;
+ margin: 2px 0 0; // override default ul
+ list-style: none;
+ font-size: $font-size-base;
+ text-align: left; // Ensures proper alignment if parent has it changed (e.g., modal footer)
+ background-color: $dropdown-bg;
+ border: 1px solid $dropdown-fallback-border; // IE8 fallback
+ border: 1px solid $dropdown-border;
+ border-radius: $border-radius-base;
+ @include box-shadow(0 6px 12px rgba(0,0,0,.175));
+ background-clip: padding-box;
+
+ // Aligns the dropdown menu to right
+ //
+ // Deprecated as of 3.1.0 in favor of `.dropdown-menu-[dir]`
+ &.pull-right {
+ right: 0;
+ left: auto;
+ }
+
+ // Dividers (basically an hr) within the dropdown
+ .divider {
+ @include nav-divider($dropdown-divider-bg);
+ }
+
+ // Links within the dropdown menu
+ > li > a {
+ display: block;
+ padding: 3px 20px;
+ clear: both;
+ font-weight: normal;
+ line-height: $line-height-base;
+ color: $dropdown-link-color;
+ white-space: nowrap; // prevent links from randomly breaking onto new lines
+ }
+}
+
+// Hover/Focus state
+.dropdown-menu > li > a {
+ &:hover,
+ &:focus {
+ text-decoration: none;
+ color: $dropdown-link-hover-color;
+ background-color: $dropdown-link-hover-bg;
+ }
+}
+
+// Active state
+.dropdown-menu > .active > a {
+ &,
+ &:hover,
+ &:focus {
+ color: $dropdown-link-active-color;
+ text-decoration: none;
+ outline: 0;
+ background-color: $dropdown-link-active-bg;
+ }
+}
+
+// Disabled state
+//
+// Gray out text and ensure the hover/focus state remains gray
+
+.dropdown-menu > .disabled > a {
+ &,
+ &:hover,
+ &:focus {
+ color: $dropdown-link-disabled-color;
+ }
+
+ // Nuke hover/focus effects
+ &:hover,
+ &:focus {
+ text-decoration: none;
+ background-color: transparent;
+ background-image: none; // Remove CSS gradient
+ @include reset-filter;
+ cursor: $cursor-disabled;
+ }
+}
+
+// Open state for the dropdown
+.open {
+ // Show the menu
+ > .dropdown-menu {
+ display: block;
+ }
+
+ // Remove the outline when :focus is triggered
+ > a {
+ outline: 0;
+ }
+}
+
+// Menu positioning
+//
+// Add extra class to `.dropdown-menu` to flip the alignment of the dropdown
+// menu with the parent.
+.dropdown-menu-right {
+ left: auto; // Reset the default from `.dropdown-menu`
+ right: 0;
+}
+// With v3, we enabled auto-flipping if you have a dropdown within a right
+// aligned nav component. To enable the undoing of that, we provide an override
+// to restore the default dropdown menu alignment.
+//
+// This is only for left-aligning a dropdown menu within a `.navbar-right` or
+// `.pull-right` nav component.
+.dropdown-menu-left {
+ left: 0;
+ right: auto;
+}
+
+// Dropdown section headers
+.dropdown-header {
+ display: block;
+ padding: 3px 20px;
+ font-size: $font-size-small;
+ line-height: $line-height-base;
+ color: $dropdown-header-color;
+ white-space: nowrap; // as with > li > a
+}
+
+// Backdrop to catch body clicks on mobile, etc.
+.dropdown-backdrop {
+ position: fixed;
+ left: 0;
+ right: 0;
+ bottom: 0;
+ top: 0;
+ z-index: ($zindex-dropdown - 10);
+}
+
+// Right aligned dropdowns
+.pull-right > .dropdown-menu {
+ right: 0;
+ left: auto;
+}
+
+// Allow for dropdowns to go bottom up (aka, dropup-menu)
+//
+// Just add .dropup after the standard .dropdown class and you're set, bro.
+// TODO: abstract this so that the navbar fixed styles are not placed here?
+
+.dropup,
+.navbar-fixed-bottom .dropdown {
+ // Reverse the caret
+ .caret {
+ border-top: 0;
+ border-bottom: $caret-width-base dashed;
+ border-bottom: $caret-width-base solid \9; // IE8
+ content: "";
+ }
+ // Different positioning for bottom up menu
+ .dropdown-menu {
+ top: auto;
+ bottom: 100%;
+ margin-bottom: 2px;
+ }
+}
+
+
+// Component alignment
+//
+// Reiterate per navbar.less and the modified component alignment there.
+
+@media (min-width: $grid-float-breakpoint) {
+ .navbar-right {
+ .dropdown-menu {
+ right: 0; left: auto;
+ }
+ // Necessary for overrides of the default right aligned menu.
+ // Will remove come v4 in all likelihood.
+ .dropdown-menu-left {
+ left: 0; right: auto;
+ }
+ }
+}
diff --git a/web-resources/docs/_sass/bootstrap/_forms.scss b/web-resources/docs/_sass/bootstrap/_forms.scss
new file mode 100644
index 000000000..ac26a6ad8
--- /dev/null
+++ b/web-resources/docs/_sass/bootstrap/_forms.scss
@@ -0,0 +1,617 @@
+//
+// Forms
+// --------------------------------------------------
+
+
+// Normalize non-controls
+//
+// Restyle and baseline non-control form elements.
+
+fieldset {
+ padding: 0;
+ margin: 0;
+ border: 0;
+ // Chrome and Firefox set a `min-width: min-content;` on fieldsets,
+ // so we reset that to ensure it behaves more like a standard block element.
+ // See https://github.com/twbs/bootstrap/issues/12359.
+ min-width: 0;
+}
+
+legend {
+ display: block;
+ width: 100%;
+ padding: 0;
+ margin-bottom: $line-height-computed;
+ font-size: ($font-size-base * 1.5);
+ line-height: inherit;
+ color: $legend-color;
+ border: 0;
+ border-bottom: 1px solid $legend-border-color;
+}
+
+label {
+ display: inline-block;
+ max-width: 100%; // Force IE8 to wrap long content (see https://github.com/twbs/bootstrap/issues/13141)
+ margin-bottom: 5px;
+ font-weight: bold;
+}
+
+
+// Normalize form controls
+//
+// While most of our form styles require extra classes, some basic normalization
+// is required to ensure optimum display with or without those classes to better
+// address browser inconsistencies.
+
+// Override content-box in Normalize (* isn't specific enough)
+input[type="search"] {
+ @include box-sizing(border-box);
+}
+
+// Position radios and checkboxes better
+input[type="radio"],
+input[type="checkbox"] {
+ margin: 4px 0 0;
+ margin-top: 1px \9; // IE8-9
+ line-height: normal;
+}
+
+input[type="file"] {
+ display: block;
+}
+
+// Make range inputs behave like textual form controls
+input[type="range"] {
+ display: block;
+ width: 100%;
+}
+
+// Make multiple select elements height not fixed
+select[multiple],
+select[size] {
+ height: auto;
+}
+
+// Focus for file, radio, and checkbox
+input[type="file"]:focus,
+input[type="radio"]:focus,
+input[type="checkbox"]:focus {
+ @include tab-focus;
+}
+
+// Adjust output element
+output {
+ display: block;
+ padding-top: ($padding-base-vertical + 1);
+ font-size: $font-size-base;
+ line-height: $line-height-base;
+ color: $input-color;
+}
+
+
+// Common form controls
+//
+// Shared size and type resets for form controls. Apply `.form-control` to any
+// of the following form controls:
+//
+// select
+// textarea
+// input[type="text"]
+// input[type="password"]
+// input[type="datetime"]
+// input[type="datetime-local"]
+// input[type="date"]
+// input[type="month"]
+// input[type="time"]
+// input[type="week"]
+// input[type="number"]
+// input[type="email"]
+// input[type="url"]
+// input[type="search"]
+// input[type="tel"]
+// input[type="color"]
+
+.form-control {
+ display: block;
+ width: 100%;
+ height: $input-height-base; // Make inputs at least the height of their button counterpart (base line-height + padding + border)
+ padding: $padding-base-vertical $padding-base-horizontal;
+ font-size: $font-size-base;
+ line-height: $line-height-base;
+ color: $input-color;
+ background-color: $input-bg;
+ background-image: none; // Reset unusual Firefox-on-Android default style; see https://github.com/necolas/normalize.css/issues/214
+ border: 1px solid $input-border;
+ border-radius: $input-border-radius; // Note: This has no effect on {{ route[0] }}
+ {% for method in route[1] %}
+
+
+
+ {{ method[0] | upcase }}
+ {{ method[1].summary }}
+
+
+
+ {% if method[1].parameters %}
+
+ {{ method[1].description | markdownify }}
+
+
+ Parameters
+
+
+
+ Name
+ In
+ Description
+ Type
+
+
+
+ {% for parameter in method[1].parameters %}
+ {% if parameter.name == null %}
+ {% assign ref = parameter['$ref'] | split:"/" | last %}
+
+
+
+ {% if swagger.parameters[ref].required %}
+
+ {% endif %}
+ {{ swagger.parameters[ref].name }}
+ {% if swagger.parameters[ref].required %}
+
+ {% endif %}
+
+ {{ swagger.parameters[ref].in }}
+ {{ swagger.parameters[ref].description | markdownify }}
+
+ {% if swagger.parameters[ref].type %}
+ {{ swagger.parameters[ref].type | capitalize }}
+ {% if swagger.parameters[ref].items %}
+ of {{ swagger.parameters[ref].items.type | capitalize }}
+ {% endif %}
+ {% else %}
+ String
+ {% endif %}
+
+
+
+ {% else % }
+
+
+
+
+ {% if parameter.required %}
+
+ {% endif %}
+ {{ parameter.name }}
+ {% if parameter.required %}
+
+ {% endif %}
+
+ {{ parameter.in }}
+ {{ parameter.description }}
+
+ {% if parameter.type %}
+ {{ parameter.type | capitalize }}
+ {% if parameter.items %}
+ of {{ parameter.items.type | capitalize }}
+ {% endif %}
+ {% else %}
+ String
+ {% endif %}
+
+
+
+ {% endif %}
+ {% endfor %}
+
+
+
+ {% endif %}
+ {% if method[1].responses %}
+
+ Responses
+ {% for response in method[1].responses %}
+
+ {{ response[0] }}
+ {{ response[1].description }}
+
+ {% for content_type in swagger.produces %}
+ {% if response[1].examples[content_type] %}
+ {% assign example = response[1].examples[content_type] %}
+ {% if content_type contains 'json' %}
+ {% highlight json %}{{ example }}{% endhighlight %}
+ {% elsif content_type contains 'xml' %}
+ {% highlight xml %}{{ example }}{% endhighlight %}
+ {% else %}
+ {% highlight http %}{{ example }}{% endhighlight %}
+ {% endif %}
+ {% endif %}
+ {% endfor %}
+ {% endfor %}
+
+ {% endif %}
+
+
+ {% endfor %}
+
+ + {{ method[0] | upcase }} + {{ method[1].summary }} + +
+
+ {% if method[1].parameters %}
+
+
+ {{ method[1].description | markdownify }}
+
+
+
+
+
+
+ {% endif %}
+ {% if method[1].responses %}
+ Parameters
+| Name | +In | +Description | +Type | +
|---|---|---|---|
| + {% if swagger.parameters[ref].required %} + + {% endif %} + {{ swagger.parameters[ref].name }} + {% if swagger.parameters[ref].required %} + + {% endif %} + | +{{ swagger.parameters[ref].in }} | +{{ swagger.parameters[ref].description | markdownify }} | ++ {% if swagger.parameters[ref].type %} + {{ swagger.parameters[ref].type | capitalize }} + {% if swagger.parameters[ref].items %} + of {{ swagger.parameters[ref].items.type | capitalize }} + {% endif %} + {% else %} + String + {% endif %} + | +
| + {% if parameter.required %} + + {% endif %} + {{ parameter.name }} + {% if parameter.required %} + + {% endif %} + | +{{ parameter.in }} | +{{ parameter.description }} | ++ {% if parameter.type %} + {{ parameter.type | capitalize }} + {% if parameter.items %} + of {{ parameter.items.type | capitalize }} + {% endif %} + {% else %} + String + {% endif %} + | +
+
+ {% endif %}
+