rat.yaml 4.3 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133
  1. ---
  2. swagger: '2.0'
  3. info:
  4. version: 1.0.0
  5. title: GeoServer Raster Attribute Table extension
  6. description: The Raster Attribute Table extension allows to explore a raster PAM Dataset, and if
  7. that contains a Raster Attribute table in any bad, to create styles out of it.
  8. contact:
  9. name: GeoServer
  10. email: 'geoserver-users@osgeo.org'
  11. url: 'https://geoserver.org/comm/'
  12. host: localhost:8080
  13. basePath: /geoserver/rest
  14. paths:
  15. /workspaces/{workspace}/coveragestores/{store}/coverages/{coverage}/pam:
  16. get:
  17. operationId: getPAMDataset
  18. summary: Retrieve the PAM dataset eventually available in the coverage.
  19. description: Retrieve the PAM dataset eventually available in the coverage, with the same XML syntax found in GDAL aux.xml files.
  20. tags:
  21. - RasterAttributeTable
  22. parameters:
  23. - name: workspace
  24. in: path
  25. description: The name of the workspace
  26. required: true
  27. type: string
  28. - name: store
  29. in: path
  30. description: The name of the coverage datastore
  31. required: true
  32. type: string
  33. - name: coverage
  34. in: path
  35. description: The name of the coverage
  36. required: true
  37. type: string
  38. produces:
  39. - application/xml
  40. responses:
  41. 200:
  42. description: OK
  43. 404:
  44. description: No PAM dataset found
  45. post:
  46. operationId: createStyleFromRAT
  47. summary: Create a new style from a PAM band Raster Attribute Table
  48. description: Creates a new Proxy Base Extension rule.
  49. tags:
  50. - RasterAttributeTable
  51. parameters:
  52. - name: workspace
  53. in: path
  54. description: The name of the workspace
  55. required: true
  56. type: string
  57. - name: store
  58. in: path
  59. description: The name of the coverage datastore
  60. required: true
  61. type: string
  62. - name: coverage
  63. in: path
  64. description: The name of the coverage
  65. required: true
  66. type: string
  67. - name: band
  68. type: integer
  69. in: query
  70. required: true
  71. description: The band index where the RAT is to be found (zero based)
  72. - name: classification
  73. type: string
  74. in: query
  75. required: true
  76. description: The RAT column to use for classification
  77. - name: styleName
  78. type: string
  79. in: query
  80. required: false
  81. description: The name of the generated style
  82. default: "{coverageName}_b{band}_{classification}"
  83. responses:
  84. 201:
  85. description: Created
  86. schema:
  87. type: string
  88. headers:
  89. Location:
  90. description: URL where the newly created rule can be found
  91. type: string
  92. 303:
  93. description: See Other
  94. schema:
  95. type: string
  96. headers:
  97. Location:
  98. description: URL where the updated style can be found
  99. type: string
  100. 404:
  101. description: No PAM dataset found
  102. 400:
  103. description: Invalid parameters used (e.g., band or classification not found)
  104. /workspaces/{workspace}/coveragestores/{store}/coverages/{coverage}/pam/reload:
  105. post:
  106. operationId: reloadPAMDataset
  107. summary: Reloads/recomputes the PAM dataset
  108. description: The PAM is often cached, this operation forces the source to reload it, eventually recomputing it, if for example it's a mosaic with a summary PAM dataset obtained from all its sources
  109. tags:
  110. - RasterAttributeTable
  111. parameters:
  112. - name: workspace
  113. in: path
  114. description: The name of the workspace
  115. required: true
  116. type: string
  117. - name: store
  118. in: path
  119. description: The name of the coverage datastore
  120. required: true
  121. type: string
  122. - name: coverage
  123. in: path
  124. description: The name of the coverage
  125. required: true
  126. type: string
  127. responses:
  128. 200:
  129. description: OK
  130. 404:
  131. description: No PAM dataset found