gwcblobstores.yaml 4.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144
  1. ---
  2. swagger: '2.0'
  3. info:
  4. version: 1.0.0
  5. title: GeoWebCache Blobstores
  6. description: BlobStores configure the persistence of tile data.
  7. contact:
  8. name: GeoServer
  9. email: 'geoserver-users@osgeo.org'
  10. url: 'https://geoserver.org/comm/'
  11. host: localhost:8080
  12. schemes:
  13. - http
  14. basePath: /geoserver/gwc/rest
  15. paths:
  16. /blobstores:
  17. get:
  18. operationId: blobstoresGet
  19. tags:
  20. - "GwcBlobStores"
  21. summary: Get a list of configured blobstores
  22. description: Displays a list of all configured blobstores on the server.
  23. produces:
  24. - application/xml
  25. - application/json
  26. responses:
  27. 200:
  28. description: OK
  29. schema:
  30. $ref: "#/definitions/BlobStores"
  31. examples:
  32. application/xml: |
  33. <blobStores>
  34. <blobStore>
  35. <name>defaultCache</name>
  36. <atom:link xmlns:atom="http://www.w3.org/2005/Atom" rel="alternate" href="http://localhost:8080/geowebcache/rest/blobstores/defaultCache.xml" type="text/xml"/>
  37. </blobStore>
  38. </blobStores>
  39. /blobstores/{blobstoreName}:
  40. get:
  41. operationId: blobstoreGet
  42. tags:
  43. - "GwcBlobStores"
  44. summary: Retrieve a configured blobstore
  45. description: Retrieves a single configured blobstore definition.
  46. produces:
  47. - application/xml
  48. - application/json
  49. parameters:
  50. - name: blobstoreName
  51. in: path
  52. required: true
  53. description: The name of the blobstore to retrieve.
  54. type: string
  55. responses:
  56. 200:
  57. description: OK
  58. schema:
  59. $ref: "#/definitions/BlobStore"
  60. examples:
  61. application/xml: |
  62. <FileBlobStore default="false">
  63. <id>defaultCache</id>
  64. <enabled>false</enabled>
  65. <baseDirectory>/tmp/defaultCache</baseDirectory>
  66. <fileSystemBlockSize>4096</fileSystemBlockSize>
  67. </FileBlobStore>
  68. 404:
  69. description: Unknown blobstore
  70. put:
  71. operationId: blobstorePut
  72. tags:
  73. - "GwcBlobStores"
  74. summary: Create or update a configured blobstore.
  75. description: Creates a new configured blobstore on the server, or modifies an existing blobstore.
  76. parameters:
  77. - name: blobstoreName
  78. in: path
  79. required: true
  80. description: The name of the blobstore to add or update.
  81. type: string
  82. - name: blobstoreBody
  83. in: body
  84. description: The new blobstore definition.
  85. required: true
  86. schema:
  87. $ref: "#/definitions/BlobStore"
  88. consumes:
  89. - application/xml
  90. - application/json
  91. responses:
  92. 200:
  93. description: The blobstore was successfully updated.
  94. 201:
  95. description: The blobstore was successfully created.
  96. delete:
  97. operationId: blobstoreDelete
  98. tags:
  99. - "GwcBlobStores"
  100. summary: Delete configured blobstore
  101. description: Deletes a configured blobstore from the server.
  102. parameters:
  103. - name: blobstoreName
  104. in: path
  105. required: true
  106. description: The name of the blobstore to delete.
  107. type: string
  108. responses:
  109. 200:
  110. description: OK
  111. 404:
  112. description: Unknown blobstore
  113. definitions:
  114. BlobStores:
  115. title: blobStores
  116. type: array
  117. items:
  118. $ref: "#/definitions/BlobStoreReference"
  119. BlobStoreReference:
  120. title: blobStore
  121. type: object
  122. properties:
  123. name:
  124. type: string
  125. description: Name of the blobstore
  126. link:
  127. type: string
  128. description: URL to blobstore definition
  129. BlobStore:
  130. title: blobStore
  131. type: object
  132. properties:
  133. id:
  134. type: string
  135. description: Name of the blobstore. Should be unique.
  136. enabled:
  137. type: boolean
  138. description: Whether or not the blobstore is enabled.