Commit 521ec9a8 authored by J Hunt's avatar J Hunt Committed by root

Generated code by SwaggerHub

parent 72152f6f
......@@ -2,7 +2,7 @@
"openapi" : "3.0.1",
"info" : {
"title" : "ClimbNZ API",
"description" : "# Overview\nClimbNZ knows about Places, Routes (with Pitches), and Guides.\n\nPlaces exist in a containment hierarchy where a Place is spatially located (mostly) in, or is reached from, another Place, starting with NZ. E.g. NZ / South Island / Aoraki / Mt Cook Range / Aoraki Mt Cook (<a href=\"https://climbnz.org.nz/nz/si/aoraki/mt-cook-range/aoraki-mt-cook\">#</a>). Places may have one or more parents (e.g. Aoraki Mt Cook is parented off Mt Cook Range, and also Hooker Glacier and Grand Plateau). Place fields include: Id, Name, Type, Aspect, Altitude, Description, Access, Access (Private), Walk time, Location (NZMS260, Topo50, LatLon). Places may reference Routes at that Place (especially if the place is a Peak or Crag), images of the place, comments about the place, and so on.\n\nRoutes are associated with a Place (usually a Face or a Mountain, or Crag or Wall, or Boulder). Routes have Types: Alpine, Rock, Boulder, Ice, Ski. The Route type determines the grade system(s) used for each Pitch. Routes consist of 1..N Pitches, and each Pitch can have a 1..N grades, Length, Bolt count, Trad flag, Description. Route fields include: Id, Reference (to topo), Name, Type, 1..N Pitches, 1..N First ascent, Quality, Multi-pitch description, 0..N Route images, Grade, Length, Bolts, Natural pro, Attribution, Gone, associated Place.\n\nGuides are distinct (print) publications that may describe a place or set of places. For example, \"Aoraki Mount Cook: a guide for mountaineers\".\n\n# Roadmap\nTo be determined, but for now see <a href=\"https://gitlab.com/kayakr/climbnz.org.nz/issues\">https://gitlab.com/kayakr/climbnz.org.nz/issues</a>.\n\n# Authentication\nAt present, no authentication is required. The API is read-only for now. Authentication will be added when the API allows POST requests, most likely based on OAuth2.\n\n# Content types\n<abbr>JSON</abbr>, specifically <a href=\"https://jsonapi.org/format/1.1/\">JSON:API v1.1</a> is returned. API clients should specifically request JSON API media type via the HTTP Accept header, e.g. <code>Accept:application/vnd.api+json</code>, although <code>application/json</code> and <code>text/xml</code> will also be accepted.\n\n# Versioning\nThe API is currently unversioned. A version number is returned in results, but it is not yet possible to request a specific version number. If and when versioning is introduced it will most likely be via Accept header, or (less preferably) via URL path.\n\nRequesting an unknown version will return <code>HTTP/1.1 406 Not Acceptable : Unknown or unsupported response format.</code>\n\n# HTTP Response codes\nThe API should return appropriate HTTP response codes, e.g. <code>HTTP 200 OK</code> for a GET request. Clients should expect an HTTP 301 or similar redirect if a place name is changed, causing the canonical URL to change.\n\n# Licence and Attribution\nThe ClimbNZ Route Database content is licensed as CC BY-NC-SA 3.0 NZ. You are free to reuse the data provided you (a) display attribution to NZAC (see below), and (b) share any derivative works under the same licence terms. For full details, read the specific licence text.\n\nOur preferred attribution is as follows:\n\n<code>&lt;a href=\"https://climbnz.org.nz/nz\"&gt;ClimbNZ&lt;/a&gt; licensed per &lt;a href=\"https://creativecommons.org/licenses/by-nc-sa/3.0/nz/\"&gt;Creative Commons CC BY-NC-SA 3.0 NZ&lt;/a&gt;</code>\n\nwhich renders as\n\n<a href=\"https://climbnz.org.nz/nz\">ClimbNZ</a> licensed per <a href=\"https://creativecommons.org/licenses/by-nc-sa/3.0/nz/\">Creative Commons CC BY-NC-SA 3.0 NZ</a>.\n\nThe licence and preferred attribution markup are included in API responses.\n\n# Notes\n* Note that some names contain special characters, e.g. macrons, e.g. \"Kaikōura\" or the caret in arête, so ensure your app is configured for UTF-8 at least.\n* Descriptions, history and some other fields may contain HTML markup.\n\n# Support\nFor technical support, please raise an issue at <a href=\"https://gitlab.com/kayakr/climbnz.org.nz/issues\">https://gitlab.com/kayakr/climbnz.org.nz/issues</a>. If you build something cool with the API, please let us know (webmaster@alpineclub.org.nz). If you want to receive notice of API availability or changes, please get in touch. ",
"description" : "# Overview\nClimbNZ knows about Places, Routes (with Pitches), and Guides.\n\nPlaces exist in a containment hierarchy where a Place is spatially located (mostly) in, or is reached from, another Place, starting with NZ. E.g. NZ / South Island / Aoraki / Mt Cook Range / Aoraki Mt Cook (<a href=\"https://climbnz.org.nz/nz/si/aoraki/mt-cook-range/aoraki-mt-cook\">#</a>). Places may have one or more parents (e.g. Aoraki Mt Cook is parented off Mt Cook Range, and also Hooker Glacier and Grand Plateau). Place fields include: Id, Name, Type, Aspect, Altitude, Description, Access, Access (Private), Walk time, Location (NZMS260, Topo50, LatLon). Places may reference Routes at that Place (especially if the place is a Peak or Crag), images of the place, comments about the place, and so on.\n\nRoutes are associated with a Place (usually a Face or a Mountain, or Crag or Wall, or Boulder). Routes have Types: Alpine, Rock, Boulder, Ice, Ski. The Route type determines the grade system(s) used for each Pitch. Routes consist of 1..N Pitches, and each Pitch can have a 1..N grades, Length, Bolt count, Trad flag, Description. Route fields include: Id, Reference (to topo), Name, Type, 1..N Pitches, 1..N First ascent, Quality, Multi-pitch description, 0..N Route images, Grade, Length, Bolts, Natural pro, Attribution, Gone, associated Place.\n\nGuides are distinct (print) publications that may describe a place or set of places. For example, \"Aoraki Mount Cook: a guide for mountaineers\".\n\n# Roadmap\nTo be determined, but for now see <a href=\"https://gitlab.com/kayakr/climbnz.org.nz/issues\">https://gitlab.com/kayakr/climbnz.org.nz/issues</a>.\n\n# Authentication\nAt present, no authentication is required. The API is read-only for now. Authentication will be added when the API allows POST requests, most likely based on OAuth2.\n\n# Content types\n<abbr>JSON</abbr>, specifically <a href=\"https://jsonapi.org/format/1.1/\">JSON:API v1.1</a> is returned. API clients should specifically request JSON API media type via the HTTP Accept header, e.g. <code>Accept:application/vnd.api+json</code>, although <code>application/json</code> and <code>text/xml</code> will also be accepted.\n\n# Versioning\nThe API is currently unversioned. A version number is returned in results, but it is not yet possible to request a specific version number. If and when versioning is introduced it will most likely be via Accept header, or (less preferably) via URL path.\n\nRequesting an unknown version will return <code>HTTP/1.1 406 Not Acceptable : Unknown or unsupported response format.</code>\n\n# HTTP Response codes\nThe API should return appropriate HTTP response codes, e.g. <code>HTTP 200 OK</code> for a successful GET request. Clients should expect an HTTP 301 or similar redirect if a place name is changed, causing the canonical URL to change.\n\n# Licence and Attribution\nThe ClimbNZ Route Database content is licensed as CC BY-NC-SA 3.0 NZ. You are free to reuse the data provided you (a) display attribution to NZAC (see below), and (b) share any derivative works under the same licence terms. For full details, read the specific licence text.\n\nOur preferred attribution is as follows:\n\n<code>&lt;a href=\"https://climbnz.org.nz/nz\"&gt;ClimbNZ&lt;/a&gt; licensed per &lt;a href=\"https://creativecommons.org/licenses/by-nc-sa/3.0/nz/\"&gt;Creative Commons CC BY-NC-SA 3.0 NZ&lt;/a&gt;</code>\n\nwhich renders as:\n\n<a href=\"https://climbnz.org.nz/nz\">ClimbNZ</a> licensed per <a href=\"https://creativecommons.org/licenses/by-nc-sa/3.0/nz/\">Creative Commons CC BY-NC-SA 3.0 NZ</a>.\n\nThe licence and preferred attribution markup are included in API responses.\n\n# Notes\n* Note that some names contain special characters, e.g. macrons, e.g. \"Kaikōura\" or the caret in arête, so ensure your app is configured for UTF-8 at least.\n* Descriptions, history and some other fields may contain HTML markup.\n\n# Support\nFor technical support, please raise an issue at <a href=\"https://gitlab.com/kayakr/climbnz.org.nz/issues\">https://gitlab.com/kayakr/climbnz.org.nz/issues</a>. If you build something cool with the API, please let us know (webmaster@alpineclub.org.nz). If you want to receive notice of API availability or changes, please get in touch. ",
"version" : "0.1"
},
"servers" : [ {
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment