123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280281282283284285286287288289290291292293294295296297298299300301302303304305306307308309310311312313314315316317318319320321322323324325326327328329330331332333334335336337338339340341342343344345346347348349350351352353354355356357358359360361362363364365366367368369370371372373374375376377378379380381382383384385386387388389390391392393394395396397398399400401402403404405406407408409410411412413414415416417418419420421422423424425426427428429430431432433434435436437438439440441442443444445446447448449450451452453454455456457458459460461462463464465466467468469470471472473474475476477478479480481482483484485486487488489490491492493494495496497498499500501502503504505506507508509510511512513514515516517518519520521522523524525526527528529530531532533534535536537538539540541542543544545546547548549550551552553554555556557558559560561562563564565566567568569570571572573574575576577578579580581582583584585586587588589590591592593594595596597598599600601602603604605606607608609610611612613614615616617618619620621622623624625626627628629630631632633634635636637638639640641642 |
- ---
- swagger: '2.0'
- info:
- version: 1.0.0
- title: GeoServer Template
- description: Manage templates used to configure output (for example GetFeatureInfo reponse). Templates can be registered for the entire server or workspace. You can also configure a template for use with a store, featureType or coverage.
- contact:
- name: GeoServer
- email: 'geoserver-users@osgeo.org'
- url: 'https://geoserver.org/comm/'
- host: localhost:8080
- basePath: /geoserver/rest
- paths:
- /templates:
- get:
- operationId: templatesGet
- tags:
- - "Templates"
- summary: List of templates for the server
- description: Displays a list of templates registered for use on the server.
- produces:
- - text/html
- - application/xml
- - application/json
- responses:
- 200:
- description: OK
- schema:
- $ref: "#/definitions/Templates"
- post:
- operationId: templatesPost
- tags:
- - "Templates"
- description: Invalid. PUT to `/{template}` to edit a template.
- responses:
- 405:
- description: Method Not Allowed
- put:
- operationId: templatesPut
- tags:
- - "Templates"
- description: Invalid. PUT to `/{template}` to edit a template.
- responses:
- 405:
- description: Method Not Allowed
- delete:
- operationId: templatesDelete
- tags:
- - "Templates"
- description: Invalid. Delete from `/{template}` to remove a template.
- responses:
- 405:
- description: Method Not Allowed
- /workspaces/{workspace}/templates:
- parameters:
- - $ref: "#/parameters/Workspace"
- get:
- operationId: templatesWorkspaceGet
- tags:
- - "Templates"
- summary: List of templates for workspace
- description: Displays a list of templates registered for use in a workspace (example for GetFeatureInfo WMS operation).
- produces:
- - text/html
- - application/xml
- - application/json
- responses:
- 200:
- description: OK
- schema:
- $ref: "#/definitions/Templates"
- post:
- operationId: templatesWorkspacePost
- tags:
- - "Templates"
- description: Invalid. PUT to `/{template}` to edit a template.
- responses:
- 405:
- description: Method Not Allowed
- put:
- operationId: templatesWorkspacePut
- tags:
- - "Templates"
- description: Invalid. PUT to `/{template}` to edit a template.
- responses:
- 405:
- description: Method Not Allowed
- delete:
- operationId: templatesWorkspaceDelete
- tags:
- - "Templates"
- description: Invalid. Delete from `/{template}` to remove a template.
- responses:
- 405:
- description: Method Not Allowed
- /workspaces/{workspace}/datastores/{store}/templates:
- parameters:
- - $ref: "#/parameters/Workspace"
- - $ref: "#/parameters/Store"
- get:
- operationId: templatesDataStoreGet
- tags:
- - "Templates"
- summary: List of templates for a data store
- description: Displays a list of templates registered for use by all layers generated by a data store (example for GetFeatureInfo WMS operation).
- produces:
- - text/html
- - application/xml
- - application/json
- responses:
- 200:
- description: OK
- schema:
- $ref: "#/definitions/Templates"
- post:
- operationId: templatesDataStorePost
- tags:
- - "Templates"
- description: Invalid. PUT to `/{template}` to edit a template.
- responses:
- 405:
- description: Method Not Allowed
- put:
- operationId: templatesDataStorePut
- tags:
- - "Templates"
- description: Invalid. PUT to `/{template}` to edit a template.
- responses:
- 405:
- description: Method Not Allowed
- delete:
- operationId: templatesDataStoreDelete
- tags:
- - "Templates"
- description: Invalid. Delete from `/{template}` to remove a template.
- responses:
- 405:
- description: Method Not Allowed
- /workspaces/{workspace}/datastores/{store}/featuretypes/{type}/templates:
- parameters:
- - $ref: "#/parameters/Workspace"
- - $ref: "#/parameters/Store"
- - name: type
- in: path
- required: true
- type: string
- description: The feature type name
- get:
- operationId: templatesDataStoreFTGet
- tags:
- - "Templates"
- summary: List of templates for a feature type.
- description: Displays a list of templates registered for use by feature type (example for GetFeatureInfo WMS operation).
- produces:
- - text/html
- - application/xml
- - application/json
- responses:
- 200:
- description: OK
- schema:
- $ref: "#/definitions/Templates"
- post:
- operationId: templatesDataStoreFTPost
- tags:
- - "Templates"
- description: Invalid. PUT to `/{template}` to edit a template.
- responses:
- 405:
- description: Method Not Allowed
- put:
- operationId: templatesDataStoreFTPut
- tags:
- - "Templates"
- description: Invalid. PUT to `/{template}` to edit a template.
- responses:
- 405:
- description: Method Not Allowed
- delete:
- operationId: templatesDataStoreFTDelete
- tags:
- - "Templates"
- description: Invalid. Delete from `/{template}` to remove a template.
- responses:
- 405:
- description: Method Not Allowed
- /workspaces/{workspace}/coveragestore/{store}/templates:
- parameters:
- - $ref: "#/parameters/Workspace"
- - $ref: "#/parameters/Store"
- get:
- operationId: templatesDataStoreCSGet
- tags:
- - "Templates"
- summary: List of templates for a coverage store
- description: Displays a list of templates registered for use by all layers generated by a coverage store (example for GetFeatureInfo WMS operation).
- produces:
- - text/html
- - application/xml
- - application/json
- responses:
- 200:
- description: OK
- schema:
- $ref: "#/definitions/Templates"
- post:
- operationId: templatesDataStoreCSPost
- tags:
- - "Templates"
- description: Invalid. PUT to `/{template}` to edit a template.
- responses:
- 405:
- description: Method Not Allowed
- put:
- operationId: templatesDataStoreCSPut
- tags:
- - "Templates"
- description: Invalid. PUT to `/{template}` to edit a template.
- responses:
- 405:
- description: Method Not Allowed
- delete:
- operationId: templatesDataStoreCSDelete
- tags:
- - "Templates"
- description: Invalid. Delete from `/{template}` to remove a template.
- responses:
- 405:
- description: Method Not Allowed
- /workspaces/{workspace}/coveragestore/{store}/coverages/{coverage}/templates:
- parameters:
- - $ref: "#/parameters/Workspace"
- - $ref: "#/parameters/Store"
- - name: coverage
- in: path
- required: true
- type: string
- description: The coverage name
- get:
- operationId: templatesCoverageGet
- tags:
- - "Templates"
- summary: List of templates for a coverage
- description: Displays a list of templates registered for use by a coverage (example for GetFeatureInfo WMS operation).
- produces:
- - text/html
- - application/xml
- - application/json
- responses:
- 200:
- description: OK
- schema:
- $ref: "#/definitions/Templates"
- post:
- operationId: templatesCoveragePost
- tags:
- - "Templates"
- description: Invalid. PUT to `/{template}` to edit a template.
- responses:
- 405:
- description: Method Not Allowed
- put:
- operationId: templatesCoveragePut
- tags:
- - "Templates"
- description: Invalid. PUT to `/{template}` to edit a template.
- responses:
- 405:
- description: Method Not Allowed
- delete:
- operationId: templatesCoverageDelete
- tags:
- - "Templates"
- description: Invalid. Delete from `/{template}` to remove a template.
- responses:
- 405:
- description: Method Not Allowed
- /templates/{template}.ftl:
- parameters:
- - $ref: "#/parameters/Template"
- get:
- operationId: templateGet
- tags:
- - "Templates"
- summary: Return a template
- description: Displays a single template registered for use on the server.
- produces:
- - text/plain
- responses:
- 200:
- description: OK
- schema:
- $ref: "#/definitions/Templates"
- post:
- operationId: templatePost
- tags:
- - "Templates"
- description: Invalid. Use PUT to insert a template.
- responses:
- 405:
- description: Method Not Allowed
- put:
- operationId: templatePut
- tags:
- - "Templates"
- summary: Insert or update a template
- description: Inserts or updates a single template registered for use on the server. Overwrites any existing template with the same name and location.
- consumes:
- - text/plain
- parameters:
- - $ref: "#/parameters/TemplateBody"
- responses:
- 201:
- description: Created
- delete:
- operationId: templateDelete
- tags:
- - "Templates"
- summary: Delete a template.
- description: Deletes a single template registered for use on the server.
- responses:
- 200:
- description: OK
- 404:
- description: Template not found
- /workspaces/{workspace}/templates/{template}.ftl:
- parameters:
- - $ref: "#/parameters/Workspace"
- - $ref: "#/parameters/Template"
- get:
- operationId: templateWorkspaceGet
- tags:
- - "Templates"
- summary: Return a template for workspace
- description: Displays a single template registered for use in a workspace (example for GetFeatureInfo WMS operation).
- produces:
- - text/plain
- responses:
- 200:
- description: OK
- schema:
- $ref: "#/definitions/Templates"
- post:
- operationId: templateWorkspacePost
- tags:
- - "Templates"
- description: Invalid. Use PUT to insert a template.
- responses:
- 405:
- description: Method Not Allowed
- put:
- operationId: templateWorkspacePut
- tags:
- - "Templates"
- summary: Insert or update a template
- description: Inserts or updates a single template registered for use in a workspace (example for GetFeatureInfo WMS operation). Overwrites any existing template with the same name and location.
- consumes:
- - text/plain
- parameters:
- - $ref: "#/parameters/TemplateBody"
- responses:
- 201:
- description: Created
- delete:
- operationId: templateWorkspaceDelete
- tags:
- - "Templates"
- summary: Delete a template.
- description: Deletes a single template registered for use in a workspace.
- responses:
- 200:
- description: OK
- 404:
- description: Template not found
- /workspaces/{workspace}/datastores/{store}/templates/{template}.ftl:
- parameters:
- - $ref: "#/parameters/Workspace"
- - $ref: "#/parameters/Store"
- - $ref: "#/parameters/Template"
- get:
- operationId: templateDataStoreGet
- tags:
- - "Templates"
- summary: Return a template for a data store
- description: Displays a single template registered for use by all layers generated by a data store (example for GetFeatureInfo WMS operation).
- produces:
- - text/plain
- responses:
- 200:
- description: OK
- schema:
- $ref: "#/definitions/Templates"
- post:
- operationId: templateDataStorePost
- tags:
- - "Templates"
- description: Invalid. Use PUT to insert a template.
- responses:
- 405:
- description: Method Not Allowed
- put:
- operationId: templateDataStorePut
- tags:
- - "Templates"
- summary: Insert or update a template
- description: Inserts or updates a single template registered for use by all layers generated by a data store (example for GetFeatureInfo WMS operation). Overwrites any existing template with the same name and location.
- consumes:
- - text/plain
- parameters:
- - $ref: "#/parameters/TemplateBody"
- responses:
- 201:
- description: Created
- delete:
- operationId: templateDataStoreDelete
- tags:
- - "Templates"
- summary: Delete a template.
- description: Deletes a single template registered for use by all layers generated by a data store.
- responses:
- 200:
- description: OK
- 404:
- description: Template not found
- /workspaces/{workspace}/datastores/{store}/featuretypes/{type}/templates/{template}.ftl:
- parameters:
- - $ref: "#/parameters/Workspace"
- - $ref: "#/parameters/Store"
- - name: type
- in: path
- required: true
- type: string
- description: The feature type name
- - $ref: "#/parameters/Template"
- get:
- operationId: templateDataStoreFTGet
- tags:
- - "Templates"
- summary: Return a template for a feature type.
- description: Displays a single template registered for use by a feature type (example for GetFeatureInfo WMS operation).
- produces:
- - text/plain
- responses:
- 200:
- description: OK
- schema:
- $ref: "#/definitions/Templates"
- post:
- operationId: templateDataStoreFTPost*
- tags:
- - "Templates"
- description: Invalid. Use PUT to insert a template.
- responses:
- 405:
- description: Method Not Allowed
- put:
- operationId: templateDataStoreFTPut
- tags:
- - "Templates"
- summary: Insert or update a template
- description: Inserts or updates a single template registered for use by a feature type (example for GetFeatureInfo WMS operation). Overwrites any existing template with the same name and location.
- consumes:
- - text/plain
- parameters:
- - $ref: "#/parameters/TemplateBody"
- responses:
- 201:
- description: Created
- delete:
- operationId: templateDataStoreFTDelete
- tags:
- - "Templates"
- summary: Delete a template.
- description: Deletes a single template registered for use by a feature type.
- responses:
- 200:
- description: OK
- 404:
- description: Template not found
- /workspaces/{workspace}/coveragestore/{store}/templates/{template}.ftl:
- parameters:
- - $ref: "#/parameters/Workspace"
- - $ref: "#/parameters/Store"
- - $ref: "#/parameters/Template"
- get:
- operationId: templateDataStoreCSGet
- tags:
- - "Templates"
- summary: Return a template for a coverage store
- description: Displays a single template registered for use by all layers generated by a coverage store (example for GetFeatureInfo WMS operation).
- produces:
- - text/plain
- responses:
- 200:
- description: OK
- schema:
- $ref: "#/definitions/Templates"
- post:
- operationId: templateDataStoreCSPost
- tags:
- - "Templates"
- description: Invalid. Use PUT to insert a template.
- responses:
- 405:
- description: Method Not Allowed
- put:
- operationId: templateDataStoreCSPut
- tags:
- - "Templates"
- summary: Insert or update a template
- description: Inserts or updates a single template registered for use by all layers generated by a coverage store (example for GetFeatureInfo WMS operation). Overwrites any existing template with the same name and location.
- consumes:
- - text/plain
- parameters:
- - $ref: "#/parameters/TemplateBody"
- responses:
- 201:
- description: Created
- delete:
- operationId: templateDataStoreCSDelete
- tags:
- - "Templates"
- summary: Delete a template.
- description: Deletes a single template registered for use by all layers generated by a coverage store.
- responses:
- 200:
- description: OK
- 404:
- description: Template not found
- /workspaces/{workspace}/coveragestore/{store}/coverages/{coverage}/templates/{template}.ftl:
- parameters:
- - $ref: "#/parameters/Workspace"
- - $ref: "#/parameters/Store"
- - name: coverage
- in: path
- required: true
- type: string
- description: The coverage name
- - $ref: "#/parameters/Template"
- get:
- operationId: templateCoverageGet
- tags:
- - "Templates"
- summary: Return a template for a coverage
- description: Displays a single template registered for use by a coverage (example for GetFeatureInfo WMS operation).
- produces:
- - text/plain
- responses:
- 200:
- description: OK
- schema:
- $ref: "#/definitions/Templates"
- post:
- operationId: templateCoveragePost
- tags:
- - "Templates"
- description: Invalid. Use PUT to insert a template.
- responses:
- 405:
- description: Method Not Allowed
- put:
- operationId: templateCoveragePut
- tags:
- - "Templates"
- summary: Insert or update a template
- description: Inserts or updates a single template registered for use by a coverage (example for GetFeatureInfo WMS operation). Overwrites any existing template with the same name and location.
- consumes:
- - text/plain
- parameters:
- - $ref: "#/parameters/TemplateBody"
- responses:
- 201:
- description: Created
- delete:
- operationId: templateCoverageDelete
- tags:
- - "Templates"
- summary: Delete a template.
- description: Deletes a single template registered for use by a coverage.
- responses:
- 200:
- description: OK
- 404:
- description: Template not found
- parameters:
- Workspace:
- name: workspace
- in: path
- required: true
- type: string
- description: The workspace name
- Store:
- name: store
- in: path
- required: true
- type: string
- description: The store name
- Template:
- name: template
- in: path
- required: true
- type: string
- description: The template name
- TemplateBody:
- name: template
- in: body
- required: true
- description: The template content to upload
- schema:
- type: string
- definitions:
- Templates:
- title: templates
- type: object
- properties:
- layerGroups:
- type: object
-
- TemplateReference:
- title: layers
- type: object
- properties:
- name:
- type: string
- description: Name of template
- link:
- type: string
- description: URL to template definition
|