wmtslayers.yaml 33 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642643644645646647648649650651652653654655656657658659660661662663664665666667668669670671672673674675676677678679680681682683684685686687688689690691692693694695696697698699700701702703704705706707708709710711712713714715716717718719720721722723724725726727728729730731732733734735736737738739740741742743744745746747748749750751752753754755756757758759760761762763764765766767768769770771772773774775776777778779780781782783784785786
  1. ---
  2. swagger: '2.0'
  3. info:
  4. version: 1.0.0
  5. title: GeoServer WMTS Store Layers
  6. description: A WMTS store is a store whose source is a remote WMTS service. Also known as "Cascading WMTS". A WMTS store layer is a layer from this store.
  7. contact:
  8. name: GeoServer
  9. email: 'geoserver-users@osgeo.org'
  10. url: 'https://geoserver.org/comm/'
  11. host: localhost:8080
  12. basePath: /geoserver/rest
  13. paths:
  14. /workspaces/{workspace}/wmtslayers:
  15. get:
  16. operationId: getWMTSStoreLayers
  17. tags:
  18. - "WMTSLayers"
  19. description: Retrieves the WMTS layers available on the server. Use the "Accept:" header to specify format or append an extension to the endpoint (example "/workspaces/{workspace}/wmtslayers" for XML).
  20. parameters:
  21. - name: workspace
  22. in: path
  23. description: Name of the workspace
  24. required: true
  25. type: string
  26. - name: list
  27. in: query
  28. description: Set "list=available" to see all possible layers in the store, not just ones currently published
  29. type: string
  30. default: configured
  31. enum:
  32. - available
  33. - configured
  34. produces:
  35. - application/xml
  36. - application/json
  37. - text/html
  38. responses:
  39. 200:
  40. description: OK
  41. schema:
  42. $ref: "#/definitions/WMTSStoreLayersList"
  43. examples:
  44. application/xml: |
  45. <wmtsLayers>
  46. <wmtsLayer>
  47. <name>dem</name>
  48. <atom:link xmlns:atom="http://www.w3.org/2005/Atom" rel="alternate" href="http://localhost:8080/geoserver/rest/workspaces/cite/wmtsstores/altgs/wmtslayers/dem.xml" type="application/xml"/>
  49. </wmtsLayer>
  50. <wmtsLayer>
  51. <name>states</name>
  52. <atom:link xmlns:atom="http://www.w3.org/2005/Atom" rel="alternate" href="http://localhost:8080/geoserver/rest/workspaces/cite/wmtsstores/altgs/wmtslayers/states.xml" type="application/xml"/>
  53. </wmtsLayer>
  54. </wmtsLayers>
  55. application/json: |
  56. {"wmtsLayers":{"wmtsLayer":[{"name":"dem","href":"http:\/\/localhost:8080\/geoserver\/rest\/workspaces\/cite\/wmtsstores\/altgs\/wmtslayers\/dem.json"},{"name":"states","href":"http:\/\/localhost:8080\/geoserver\/rest\/workspaces\/cite\/wmtsstores\/altgs\/wmtslayers\/states.json"}]}}
  57. application/xml (list=available): |
  58. <list>
  59. <wmtsLayerName>ne:basemap</wmtsLayerName>
  60. <wmtsLayerName>ne:ne1</wmtsLayerName>
  61. <wmtsLayerName>ne:boundary_lines_land</wmtsLayerName>
  62. <wmtsLayerName>ne:states_provinces_lines</wmtsLayerName>
  63. <wmtsLayerName>ne:populated_places</wmtsLayerName>
  64. <wmtsLayerName>opengeo:countries</wmtsLayerName>
  65. <wmtsLayerName>usgs:dem</wmtsLayerName>
  66. <wmtsLayerName>ne:ocean</wmtsLayerName>
  67. <wmtsLayerName>ne:roads</wmtsLayerName>
  68. <wmtsLayerName>usa:states</wmtsLayerName>
  69. <wmtsLayerName>ne:states_provinces_shp</wmtsLayerName>
  70. <wmtsLayerName>ne:urban_areas</wmtsLayerName>
  71. </list>
  72. application/json (list=available): |
  73. {"list":{"string":["ne:basemap","ne:ne1","ne:boundary_lines_land","ne:states_provinces_lines","ne:populated_places","opengeo:countries","usgs:dem","ne:ocean","ne:roads","usa:states","ne:states_provinces_shp","ne:urban_areas"]}}
  74. post:
  75. operationId: postWMTSStoreLayers
  76. tags:
  77. - "WMTSLayers"
  78. description: Publishes a new WMTS store layer.
  79. parameters:
  80. - name: workspace
  81. in: path
  82. description: Name of the workspace
  83. required: true
  84. type: string
  85. - name: WMTSStoreLayerBody
  86. in: body
  87. description: Body of the WMTS store layer
  88. required: true
  89. schema:
  90. $ref: "#/definitions/WMTSStoreLayerInfo"
  91. consumes:
  92. - application/xml
  93. - application/json
  94. responses:
  95. 201:
  96. description: Created
  97. headers:
  98. Location:
  99. description: Location of the newly created layer.
  100. type: string
  101. put:
  102. operationId: putWMTSStoreLayers
  103. tags:
  104. - "WMTSLayers"
  105. description: Invalid. Use POST for adding a new layer, or PUT on an individual layer to edit it.
  106. responses:
  107. 405:
  108. description: Method Not Allowed
  109. delete:
  110. operationId: deleteWMTSStoreLayers
  111. tags:
  112. - "WMTSLayers"
  113. description: Invalid. Can only delete an individual layer.
  114. responses:
  115. 405:
  116. description: Method Not Allowed
  117. /workspaces/{workspace}/wmtslayers/{wmtslayer}:
  118. get:
  119. operationId: getWMTSStoreLayer
  120. tags:
  121. - "WMTSLayers"
  122. description: Retrieves an individual WMTS layer. Use the "Accept:" header to specify format or append an extension to the endpoint (example "/workspaces/{workspace}/wmtslayers/{wmtslayer}.xml" for XML).
  123. produces:
  124. - application/xml
  125. - application/json
  126. - text/html
  127. parameters:
  128. - name: workspace
  129. in: path
  130. description: Name of the workspace
  131. required: true
  132. type: string
  133. - name: wmtslayer
  134. in: path
  135. description: Name of the layer
  136. required: true
  137. type: string
  138. - name: quietOnNotFound
  139. in: query
  140. description: When set to "true", will not log an exception when the style is not present. The 404 status code will still be returned. Allowable values are "true" or "false" (default).
  141. type: boolean
  142. required: false
  143. responses:
  144. 200:
  145. description: OK
  146. schema:
  147. $ref: "#/definitions/WMTSStoreLayerInfo"
  148. examples:
  149. application/xml: |
  150. <wmtsLayer>
  151. <name>dem</name>
  152. <nativeName>usgs:dem</nativeName>
  153. <namespace>
  154. <name>cite</name>
  155. <atom:link xmlns:atom="http://www.w3.org/2005/Atom" rel="alternate" href="http://localhost:8080/geoserver/rest/namespaces/cite.xml" type="application/xml"/>
  156. </namespace>
  157. <title>Digital elevation model</title>
  158. <description>USGS GTOPO30 digital elevation model</description>
  159. <abstract>USGS GTOPO30 digital elevation model</abstract>
  160. <keywords>
  161. <string>WCS</string>
  162. <string>GeoTIFF</string>
  163. <string>W100N40</string>
  164. </keywords>
  165. <nativeCRS>GEOGCS[&quot;WGS 84&quot;, &#xd;
  166. DATUM[&quot;World Geodetic System 1984&quot;, &#xd;
  167. SPHEROID[&quot;WGS 84&quot;, 6378137.0, 298.257223563, AUTHORITY[&quot;EPSG&quot;,&quot;7030&quot;]], &#xd;
  168. AUTHORITY[&quot;EPSG&quot;,&quot;6326&quot;]], &#xd;
  169. PRIMEM[&quot;Greenwich&quot;, 0.0, AUTHORITY[&quot;EPSG&quot;,&quot;8901&quot;]], &#xd;
  170. UNIT[&quot;degree&quot;, 0.017453292519943295], &#xd;
  171. AXIS[&quot;Geodetic longitude&quot;, EAST], &#xd;
  172. AXIS[&quot;Geodetic latitude&quot;, NORTH], &#xd;
  173. AUTHORITY[&quot;EPSG&quot;,&quot;4326&quot;]]</nativeCRS>
  174. <srs>EPSG:4326</srs>
  175. <nativeBoundingBox>
  176. <minx>-100.0</minx>
  177. <maxx>-60.000000000015994</maxx>
  178. <miny>-9.999999999980012</miny>
  179. <maxy>39.99999999999999</maxy>
  180. <crs>EPSG:4326</crs>
  181. </nativeBoundingBox>
  182. <latLonBoundingBox>
  183. <minx>-100.0</minx>
  184. <maxx>-60.000000000015994</maxx>
  185. <miny>-9.999999999980012</miny>
  186. <maxy>39.99999999999999</maxy>
  187. <crs>EPSG:4326</crs>
  188. </latLonBoundingBox>
  189. <projectionPolicy>FORCE_DECLARED</projectionPolicy>
  190. <enabled>true</enabled>
  191. <metadata>
  192. <entry key="cachingEnabled">false</entry>
  193. </metadata>
  194. <store class="wmtsStore">
  195. <name>cite:altgs</name>
  196. <atom:link xmlns:atom="http://www.w3.org/2005/Atom" rel="alternate" href="http://localhost:8080/geoserver/rest/workspaces/cite/wmtsstores/altgs.xml" type="application/xml"/>
  197. </store>
  198. </wmtsLayer>
  199. application/json: |
  200. {"wmtsLayer":{"name":"dem","nativeName":"usgs:dem","namespace":{"name":"cite","href":"http://localhost:8080/geoserver/rest/namespaces/cite.json"},"title":"Digital elevation model","description":"USGS GTOPO30 digital elevation model","abstract":"USGS GTOPO30 digital elevation model","keywords":{"string":["WCS","GeoTIFF","W100N40"]},"nativeCRS":"GEOGCS[\"WGS 84\", \r\n DATUM[\"World Geodetic System 1984\", \r\n SPHEROID[\"WGS 84\", 6378137.0, 298.257223563, AUTHORITY[\"EPSG\",\"7030\"]], \r\n AUTHORITY[\"EPSG\",\"6326\"]], \r\n PRIMEM[\"Greenwich\", 0.0, AUTHORITY[\"EPSG\",\"8901\"]], \r\n UNIT[\"degree\", 0.017453292519943295], \r\n AXIS[\"Geodetic longitude\", EAST], \r\n AXIS[\"Geodetic latitude\", NORTH], \r\n AUTHORITY[\"EPSG\",\"4326\"]]","srs":"EPSG:4326","nativeBoundingBox":{"minx":-100,"maxx":-60.000000000015994,"miny":-9.999999999980012,"maxy":39.99999999999999,"crs":"EPSG:4326"},"latLonBoundingBox":{"minx":-100,"maxx":-60.000000000015994,"miny":-9.999999999980012,"maxy":39.99999999999999,"crs":"EPSG:4326"},"projectionPolicy":"FORCE_DECLARED","enabled":true,"metadata":{"entry":{"@key":"cachingEnabled","$":"false"}},"store":{"@class":"wmtsStore","name":"cite:altgs","href":"http://localhost:8080/geoserver/rest/workspaces/cite/wmtsstores/altgs.json"}}}
  201. post:
  202. operationId: postWMTSStoreLayer
  203. tags:
  204. - "WMTSLayers"
  205. description: Invalid. Use PUT to edit a layer, or POST on the /wmtslayers endpoint to add a new layer.
  206. responses:
  207. 405:
  208. description: Method Not Allowed
  209. put:
  210. operationId: putWMTSStoreLayer
  211. tags:
  212. - "WMTSLayers"
  213. description: Edits an existing WMTS store layer.
  214. parameters:
  215. - name: workspace
  216. in: path
  217. description: Name of the workspace
  218. required: true
  219. type: string
  220. - name: wmtslayer
  221. in: path
  222. description: Name of the layer to be edited
  223. required: true
  224. type: string
  225. - name: WMTSStoreLayerBody
  226. in: body
  227. description: Body of the WMTS store layer
  228. required: true
  229. schema:
  230. $ref: "#/definitions/WMTSStoreLayerInfo"
  231. - name: calculate
  232. in: query
  233. description: Specifies whether to recalculate any bounding boxes for a wmtWMTSs layer. Some properties are automatically recalculated when necessary. In particular, the native bounding box is recalculated when the projection or projection policy are changed, and the lat/lon bounding box is recalculated when the native bounding box is recalculated, or when a new native bounding box is explicitly provided in the request. (The native and lat/lon bounding boxes are not automatically recalculated when they are explicitly included in the request.) In addition, the client may explicitly request a fixed set of fields to calculate, by including a comma-separated list of their names in the recalculate parameter. The empty parameter 'recalculate=' is useful avoid slow recalculation when operating against large datasets as 'recalculate=' avoids calculating any fields, regardless of any changes to projection, projection policy, etc. The nativebbox parameter 'recalculate=nativebbox' is used recalculates the native bounding box, while avoiding recalculating the lat/lon bounding box. Recalculate parameters can be used in together - 'recalculate=nativebbox,latlonbbox' can be used after a bulk import to to recalculates both the native bounding box and the lat/lon bounding box.
  234. required: false
  235. type: array
  236. collectionFormat: csv
  237. minItems: 0
  238. maxItems: 2
  239. items:
  240. type: string
  241. enum: [nativebbox,latlonbbox]
  242. consumes:
  243. - application/xml
  244. - application/json
  245. responses:
  246. 201:
  247. description: Created
  248. headers:
  249. Location:
  250. description: Location of the newly created layer.
  251. type: string
  252. delete:
  253. operationId: deleteWMTSStoreLayer
  254. tags:
  255. - "WMTSLayers"
  256. description: Deletes a layer from the server.
  257. parameters:
  258. - name: workspace
  259. in: path
  260. description: Name of the workspace
  261. required: true
  262. type: string
  263. - name: wmtslayer
  264. in: path
  265. description: Name of the layer to be deleted
  266. required: true
  267. type: string
  268. - name: recurse
  269. in: query
  270. description: Recursively deletes all layers referenced by the specified wmtslayer. Allowed values for this parameter are true or false. The default value is false. A request with 'recurse=false' will fail if any layers reference the wmtslayer.
  271. required: false
  272. type: boolean
  273. default: false
  274. responses:
  275. 200:
  276. description: OK
  277. /workspaces/{workspace}/wmtsstores/{wmtsstore}/layers:
  278. get:
  279. operationId: getWMTSStoreStoreLayers
  280. tags:
  281. - "WMTSLayers"
  282. description: Retrieves the WMTS store layers available in the given store. Use the "Accept:" header to specify format or append an extension to the endpoint (example "/workspaces/{workspace}/wmtsstores/{wmtsstore}/wmtslayers.xml" for XML).
  283. parameters:
  284. - name: workspace
  285. in: path
  286. description: Name of the workspace
  287. required: true
  288. type: string
  289. - name: wmtsstore
  290. in: path
  291. description: Name of the store
  292. required: true
  293. type: string
  294. - name: list
  295. in: query
  296. description: Set "list=available" to see all possible layers in the store, not just ones currently published
  297. default: configured
  298. enum:
  299. - available
  300. - configured
  301. type: string
  302. produces:
  303. - application/xml
  304. - application/json
  305. - text/html
  306. responses:
  307. 200:
  308. description: OK
  309. schema:
  310. $ref: "#/definitions/WMTSStoreLayersList"
  311. examples:
  312. application/xml: |
  313. <wmtsLayers>
  314. <wmtsLayer>
  315. <name>dem</name>
  316. <atom:link xmlns:atom="http://www.w3.org/2005/Atom" rel="alternate" href="http://localhost:8080/geoserver/rest/workspaces/cite/wmtsstores/altgs/wmtslayers/dem.xml" type="application/xml"/>
  317. </wmtsLayer>
  318. <wmtsLayer>
  319. <name>states</name>
  320. <atom:link xmlns:atom="http://www.w3.org/2005/Atom" rel="alternate" href="http://localhost:8080/geoserver/rest/workspaces/cite/wmtsstores/altgs/wmtslayers/states.xml" type="application/xml"/>
  321. </wmtsLayer>
  322. </wmtsLayers>
  323. application/json: |
  324. {"wmtsLayers":{"wmtsLayer":[{"name":"dem","href":"http:\/\/localhost:8080\/geoserver\/rest\/workspaces\/cite\/wmtsstores\/altgs\/wmtslayers\/dem.json"},{"name":"states","href":"http:\/\/localhost:8080\/geoserver\/rest\/workspaces\/cite\/wmtsstores\/altgs\/wmtslayers\/states.json"}]}}
  325. application/xml (list=available): |
  326. <list>
  327. <wmtsLayerName>ne:basemap</wmtsLayerName>
  328. <wmtsLayerName>ne:ne1</wmtsLayerName>
  329. <wmtsLayerName>ne:boundary_lines_land</wmtsLayerName>
  330. <wmtsLayerName>ne:states_provinces_lines</wmtsLayerName>
  331. <wmtsLayerName>ne:populated_places</wmtsLayerName>
  332. <wmtsLayerName>opengeo:countries</wmtsLayerName>
  333. <wmtsLayerName>usgs:dem</wmtsLayerName>
  334. <wmtsLayerName>ne:ocean</wmtsLayerName>
  335. <wmtsLayerName>ne:roads</wmtsLayerName>
  336. <wmtsLayerName>usa:states</wmtsLayerName>
  337. <wmtsLayerName>ne:states_provinces_shp</wmtsLayerName>
  338. <wmtsLayerName>ne:urban_areas</wmsLayerName>
  339. </list>
  340. application/json (list=available): |
  341. {"list":{"string":["ne:basemap","ne:ne1","ne:boundary_lines_land","ne:states_provinces_lines","ne:populated_places","opengeo:countries","usgs:dem","ne:ocean","ne:roads","usa:states","ne:states_provinces_shp","ne:urban_areas"]}}
  342. post:
  343. operationId: postWMTSStoreStoreLayers
  344. tags:
  345. - "WMTSLayers"
  346. description: Publishes a new WMTS store layer in the given store.
  347. parameters:
  348. - name: workspace
  349. in: path
  350. description: Name of the workspace
  351. required: true
  352. type: string
  353. - name: wmtsstore
  354. in: path
  355. description: Name of the data store
  356. required: true
  357. type: string
  358. - name: WMTSStoreLayerBody
  359. in: body
  360. description: Body of the WMTS store layer
  361. required: true
  362. schema:
  363. $ref: "#/definitions/WMTSStoreLayerInfo"
  364. consumes:
  365. - application/xml
  366. - application/json
  367. responses:
  368. 201:
  369. description: Created
  370. headers:
  371. Location:
  372. description: Location of the newly created layer
  373. type: string
  374. put:
  375. operationId: putWMTSStoreStoreLayers
  376. tags:
  377. - "WMTSLayers"
  378. description: Invalid. Use POST for adding a new layer, or PUT on an individual layer to edit it.
  379. responses:
  380. 405:
  381. description: Method Not Allowed
  382. delete:
  383. operationId: deleteWMTSStoreStoreLayers
  384. tags:
  385. - "WMTSLayers"
  386. description: Invalid. Can only delete an individual layer.
  387. responses:
  388. 405:
  389. description: Method Not Allowed
  390. /workspaces/{workspace}/wmtsstores/{wmtsstore}/layers/{wmtslayer}:
  391. get:
  392. operationId: getWMTSStoreStoreLayer
  393. tags:
  394. - "WMTSLayers"
  395. description: Retrieves an individual WMTS store layer for a given store. Use the "Accept:" header to specify format or append an extension to the endpoint (example "/workspaces/{workspace}/wmtsstores/{wmtsstore}/wmtslayers/{wmtslayer}.xml" for XML).
  396. produces:
  397. - application/xml
  398. - application/json
  399. - text/html
  400. parameters:
  401. - name: workspace
  402. in: path
  403. description: Name of the workspace
  404. required: true
  405. type: string
  406. - name: wmtsstore
  407. in: path
  408. description: Name of the store
  409. required: true
  410. type: string
  411. - name: wtmslayer
  412. in: path
  413. description: Name of the layer
  414. required: true
  415. type: string
  416. - name: quietOnNotFound
  417. in: query
  418. description: When set to "true", will not log an exception when the style is not present. The 404 status code will still be returned. Allowable values are "true" or "false" (default).
  419. type: boolean
  420. required: false
  421. responses:
  422. 200:
  423. description: OK
  424. schema:
  425. $ref: "#/definitions/WMTSStoreLayerInfo"
  426. examples:
  427. application/xml: |
  428. <wmtsLayer>
  429. <name>dem</name>
  430. <nativeName>usgs:dem</nativeName>
  431. <namespace>
  432. <name>cite</name>
  433. <atom:link xmlns:atom="http://www.w3.org/2005/Atom" rel="alternate" href="http://localhost:8080/geoserver/rest/namespaces/cite.xml" type="application/xml"/>
  434. </namespace>
  435. <title>Digital elevation model</title>
  436. <description>USGS GTOPO30 digital elevation model</description>
  437. <abstract>USGS GTOPO30 digital elevation model</abstract>
  438. <keywords>
  439. <string>WCS</string>
  440. <string>GeoTIFF</string>
  441. <string>W100N40</string>
  442. </keywords>
  443. <nativeCRS>GEOGCS[&quot;WGS 84&quot;, &#xd;
  444. DATUM[&quot;World Geodetic System 1984&quot;, &#xd;
  445. SPHEROID[&quot;WGS 84&quot;, 6378137.0, 298.257223563, AUTHORITY[&quot;EPSG&quot;,&quot;7030&quot;]], &#xd;
  446. AUTHORITY[&quot;EPSG&quot;,&quot;6326&quot;]], &#xd;
  447. PRIMEM[&quot;Greenwich&quot;, 0.0, AUTHORITY[&quot;EPSG&quot;,&quot;8901&quot;]], &#xd;
  448. UNIT[&quot;degree&quot;, 0.017453292519943295], &#xd;
  449. AXIS[&quot;Geodetic longitude&quot;, EAST], &#xd;
  450. AXIS[&quot;Geodetic latitude&quot;, NORTH], &#xd;
  451. AUTHORITY[&quot;EPSG&quot;,&quot;4326&quot;]]</nativeCRS>
  452. <srs>EPSG:4326</srs>
  453. <nativeBoundingBox>
  454. <minx>-100.0</minx>
  455. <maxx>-60.000000000015994</maxx>
  456. <miny>-9.999999999980012</miny>
  457. <maxy>39.99999999999999</maxy>
  458. <crs>EPSG:4326</crs>
  459. </nativeBoundingBox>
  460. <latLonBoundingBox>
  461. <minx>-100.0</minx>
  462. <maxx>-60.000000000015994</maxx>
  463. <miny>-9.999999999980012</miny>
  464. <maxy>39.99999999999999</maxy>
  465. <crs>EPSG:4326</crs>
  466. </latLonBoundingBox>
  467. <projectionPolicy>FORCE_DECLARED</projectionPolicy>
  468. <enabled>true</enabled>
  469. <metadata>
  470. <entry key="cachingEnabled">false</entry>
  471. </metadata>
  472. <store class="wmtsStore">
  473. <name>cite:altgs</name>
  474. <atom:link xmlns:atom="http://www.w3.org/2005/Atom" rel="alternate" href="http://localhost:8080/geoserver/rest/workspaces/cite/wmtsstores/altgs.xml" type="application/xml"/>
  475. </store>
  476. </wmtsLayer>
  477. application/json: |
  478. {"wmtsLayer":{"name":"dem","nativeName":"usgs:dem","namespace":{"name":"cite","href":"http://localhost:8080/geoserver/rest/namespaces/cite.json"},"title":"Digital elevation model","description":"USGS GTOPO30 digital elevation model","abstract":"USGS GTOPO30 digital elevation model","keywords":{"string":["WCS","GeoTIFF","W100N40"]},"nativeCRS":"GEOGCS[\"WGS 84\", \r\n DATUM[\"World Geodetic System 1984\", \r\n SPHEROID[\"WGS 84\", 6378137.0, 298.257223563, AUTHORITY[\"EPSG\",\"7030\"]], \r\n AUTHORITY[\"EPSG\",\"6326\"]], \r\n PRIMEM[\"Greenwich\", 0.0, AUTHORITY[\"EPSG\",\"8901\"]], \r\n UNIT[\"degree\", 0.017453292519943295], \r\n AXIS[\"Geodetic longitude\", EAST], \r\n AXIS[\"Geodetic latitude\", NORTH], \r\n AUTHORITY[\"EPSG\",\"4326\"]]","srs":"EPSG:4326","nativeBoundingBox":{"minx":-100,"maxx":-60.000000000015994,"miny":-9.999999999980012,"maxy":39.99999999999999,"crs":"EPSG:4326"},"latLonBoundingBox":{"minx":-100,"maxx":-60.000000000015994,"miny":-9.999999999980012,"maxy":39.99999999999999,"crs":"EPSG:4326"},"projectionPolicy":"FORCE_DECLARED","enabled":true,"metadata":{"entry":{"@key":"cachingEnabled","$":"false"}},"store":{"@class":"wmtsStore","name":"cite:altgs","href":"http://localhost:8080/geoserver/rest/workspaces/cite/wmtsstores/altgs.json"}}}
  479. post:
  480. operationId: postWMTSStoreStoreLayer
  481. tags:
  482. - "WMTSLayers"
  483. description: Invalid. Use PUT to edit a layer, or POST on the /wmtslayers endpoint to add a new layer.
  484. responses:
  485. 405:
  486. description: Method Not Allowed
  487. put:
  488. operationId: putWMTSStoreStoreLayer
  489. tags:
  490. - "WMTSLayers"
  491. description: Edits an existing WMTS store layer.
  492. parameters:
  493. - name: workspace
  494. in: path
  495. description: Name of the workspace
  496. required: true
  497. type: string
  498. - name: wmtsstore
  499. in: path
  500. description: Name of the store
  501. required: true
  502. type: string
  503. - name: wmtslayer
  504. in: path
  505. description: Name of the layer to be edited
  506. required: true
  507. type: string
  508. - name: WMTSStoreLayerBody
  509. in: body
  510. description: Body of the WMTS store layer
  511. required: true
  512. schema:
  513. $ref: "#/definitions/WMTSStoreLayerInfo"
  514. - name: calculate
  515. in: query
  516. description: Specifies whether to recalculate any bounding boxes for a wmts layer. Some properties are automatically recalculated when necessary. In particular, the native bounding box is recalculated when the projection or projection policy are changed, and the lat/lon bounding box is recalculated when the native bounding box is recalculated, or when a new native bounding box is explicitly provided in the request. (The native and lat/lon bounding boxes are not automatically recalculated when they are explicitly included in the request.) In addition, the client may explicitly request a fixed set of fields to calculate, by including a comma-separated list of their names in the recalculate parameter. The empty parameter 'recalculate=' is useful avoid slow recalculation when operating against large datasets as 'recalculate=' avoids calculating any fields, regardless of any changes to projection, projection policy, etc. The nativebbox parameter 'recalculate=nativebbox' is used recalculates the native bounding box, while avoiding recalculating the lat/lon bounding box. Recalculate parameters can be used in together - 'recalculate=nativebbox,latlonbbox' can be used after a bulk import to to recalculates both the native bounding box and the lat/lon bounding box.
  517. required: false
  518. type: array
  519. collectionFormat: csv
  520. minItems: 0
  521. maxItems: 2
  522. items:
  523. type: string
  524. enum: [nativebbox,latlonbbox]
  525. consumes:
  526. - application/xml
  527. - application/json
  528. responses:
  529. 201:
  530. description: Created
  531. headers:
  532. Location:
  533. description: Location of the newly created layer
  534. type: string
  535. delete:
  536. operationId: deleteWMTSStoreStoreLayer
  537. tags:
  538. - "WMTSLayers"
  539. description: Deletes a layer from the server.
  540. parameters:
  541. - name: workspace
  542. in: path
  543. description: Name of the workspace
  544. required: true
  545. type: string
  546. - name: wmtsstore
  547. in: path
  548. description: Name of the store
  549. required: true
  550. type: string
  551. - name: wmtslayer
  552. in: path
  553. description: Name of the layer to be deleted
  554. required: true
  555. type: string
  556. - name: recurse
  557. in: query
  558. description: Recursively deletes all layers referenced by the specified wmtslayer. Allowed values for this parameter are true or false. The default value is false. A request with 'recurse=false' will fail if any layers reference the wmtslayer.
  559. required: false
  560. type: boolean
  561. default: false
  562. responses:
  563. 200:
  564. description: OK
  565. definitions:
  566. WMTSStoreLayersList:
  567. title: wmtsLayers
  568. type: array
  569. items:
  570. title: wmtsLayer
  571. type: object
  572. properties:
  573. name:
  574. type: string
  575. description: Name of the layer
  576. link:
  577. type: string
  578. description: URL of the layer representation
  579. WMTSStoreLayersAvailableList:
  580. title: list
  581. type: array
  582. items:
  583. title: wmtsLayerName
  584. type: object
  585. properties:
  586. name:
  587. type: string
  588. description: Name of the layer
  589. link:
  590. type: string
  591. description: URL of the layer representation
  592. WMTSStoreLayerInfo:
  593. title: wmtsLayer
  594. xml:
  595. name: wmtsLayer
  596. type: object
  597. properties:
  598. name:
  599. type: string
  600. description: Name of the layer, corresponding to the published name of the resource
  601. nativeName:
  602. type: string
  603. description: Name of the layer as known on the remote WMTS
  604. namespace:
  605. type: object
  606. description: Namespace of the layer
  607. properties:
  608. name:
  609. type: string
  610. description: Name of the namespace
  611. link:
  612. type: string
  613. description: URL to the namespace representation.
  614. title:
  615. type: string
  616. description: Title of the layer
  617. abstract:
  618. type: string
  619. description: Description of the layer
  620. description:
  621. type: string
  622. description: Same as abstract
  623. keywords:
  624. type: array
  625. description: Collection of keywords associated with the layer
  626. items:
  627. type: object
  628. properties:
  629. string:
  630. type: string
  631. description: Keyword
  632. metadatalinks:
  633. type: object
  634. description: Wraps a collection of metadata links
  635. properties:
  636. metadataLink:
  637. type: array
  638. description: A collection of metadata links
  639. items:
  640. type: object
  641. properties:
  642. type:
  643. type: string
  644. description: MIME type
  645. metadataType:
  646. type: string
  647. description: Type of metadata such as "FGDC"
  648. content:
  649. type: string
  650. description: Link URL
  651. dataLinks:
  652. type: object
  653. description: Wraps a collection of data links
  654. properties:
  655. metadataLink:
  656. type: array
  657. description: Collection of data links
  658. items:
  659. type: object
  660. properties:
  661. type:
  662. type: string
  663. description: MIME type
  664. content:
  665. type: string
  666. description: Link URL
  667. nativeCRS:
  668. type: string
  669. description: Native coordinate reference system object in WKT
  670. srs:
  671. type: string
  672. description: Identifier of coordinate reference system
  673. nativeBoundingBox:
  674. type: object
  675. description: Bounds of the layer in its declared CRS.
  676. properties:
  677. minx:
  678. type: number
  679. description: Min x coordinate
  680. maxx:
  681. type: number
  682. description: Max x coordinate
  683. miny:
  684. type: number
  685. description: Min y coordinate
  686. maxy:
  687. type: number
  688. description: Max y coordinate
  689. crs:
  690. type: string
  691. description: Coordinate reference system of the bounding box
  692. latLonBoundingBox:
  693. type: object
  694. description: Bounds of the layer in latitude / longitude. This value represents a "fixed value" and is not calculated.
  695. properties:
  696. minx:
  697. type: number
  698. description: Min x coordinate
  699. maxx:
  700. type: number
  701. description: Max x coordinate
  702. miny:
  703. type: number
  704. description: Min y coordinate
  705. maxy:
  706. type: number
  707. description: Max y coordinate
  708. crs:
  709. type: string
  710. description: Coordinate reference system object of the bounding box
  711. projectionPolicy:
  712. type: string
  713. description: How to handle the coordinate reference system (native versus declared)
  714. enum:
  715. - FORCE_DECLARED
  716. - REPROJECT_TO_DECLARE
  717. - NONE
  718. enabled:
  719. type: boolean
  720. description: Whether the layer is enabled
  721. metadata:
  722. type: array
  723. description: A list of key/value metadata pairs.
  724. items:
  725. $ref: "#/definitions/MetadataEntry"
  726. store:
  727. type: object
  728. description: Store conaining the resource
  729. properties:
  730. '@class':
  731. type: string
  732. description: Class of the store
  733. name:
  734. type: string
  735. description: Name of the store
  736. href:
  737. type: string
  738. description: URL to the data store
  739. MetadataEntry:
  740. type: object
  741. title: entry
  742. properties:
  743. '@key':
  744. title: key
  745. type: string
  746. enum:
  747. - regionateStrategy
  748. - regionateFeatureLimit
  749. - cacheAgeMax
  750. - cachingEnabled
  751. - regionateAttribute
  752. - indexingEnabled
  753. - dirName
  754. description: Key used for metadata entry
  755. text:
  756. type: string
  757. description: Value of given key