Skip to content

Commit

Permalink
Join REST endpoint documentation in client-proxy.md
Browse files Browse the repository at this point in the history
  • Loading branch information
index-git committed Oct 5, 2023
1 parent f32d4c5 commit 78f9f95
Showing 1 changed file with 6 additions and 34 deletions.
40 changes: 6 additions & 34 deletions doc/client-proxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -49,24 +49,18 @@ then response will change to
```

Currently, value of X-Forwarded headers affects following URLs:
* [GET Publications](rest.md#get-publications)
* [GET Publications](rest.md#get-publications), [GET Layers](rest.md#get-layers), [GET Maps](rest.md#get-maps), [GET Workspace Layers](rest.md#get-workspace-layers) and [GET Workspace Maps](rest.md#get-workspace-maps)
* `url` key
* [GET Layers](rest.md#get-layers)
* [POST Workspace Layers](rest.md#post-workspace-layers) and [POST Workspace Maps](rest.md#post-workspace-maps)
* `url` key
* [GET Workspace Layers](rest.md#get-workspace-layers)
* `url` key
* [GET Maps](rest.md#get-maps)
* `url` key
* [GET Workspace Maps](rest.md#get-workspace-maps)
* `url` key
* [GET Workspace Layer](rest.md#get-workspace-layer)
* [GET Workspace Layer](rest.md#get-workspace-layer) and [PATCH Workspace Layer](rest.md#patch-workspace-layer)
* `url` key
* `wms`.`url` key
* `wfs`.`url` key
* `style`.`url` key
* `thumbnail`.`url` key
* `metadata`.`comparison_url` key
* [GET Workspace Map](rest.md#get-workspace-map)
* [GET Workspace Map](rest.md#get-workspace-map) and [PATCH Workspace Map](rest.md#patch-workspace-map)
* `url` key
* `file`.`url` key
* `thumbnail`.`url` key
Expand All @@ -78,30 +72,8 @@ Currently, value of X-Forwarded headers affects following URLs:
* each `legends` key if its HTTP protocol and netloc corresponds with `url` or `protocol`.`url`
* `style` key if its HTTP protocol and netloc corresponds with `url` or `protocol`.`url`
* NOTE: If client proxy protocol, host, or URL path prefix was used in URLs in uploaded file, then such values are also replaced with values according to X-Forwarded header values. Default values are used for requests without X-Forwarded headers (protocol is the one from [LAYMAN_CLIENT_PUBLIC_URL](env-settings.md#layman_client_public_url), host is [LAYMAN_PROXY_SERVER_NAME](env-settings.md#layman_proxy_server_name), and path prefix is empty string).
* [POST Workspace Layers](rest.md#post-workspace-layers)
* `url` key
* [DELETE Workspace Layer](rest.md#delete-workspace-layer)
* `url` key
* [DELETE Workspace Layers](rest.md#delete-workspace-layers)
* `url` key
* [DELETE Workspace Map](rest.md#delete-workspace-map)
* `url` key
* [DELETE Workspace Maps](rest.md#delete-workspace-maps)
* `url` key
* [POST Workspace Maps](rest.md#post-workspace-maps)
* `url` key
* [PATCH Workspace Layer](rest.md#patch-workspace-layer)
* [DELETE Workspace Layers](rest.md#delete-workspace-layers), [DELETE Workspace Maps](rest.md#delete-workspace-maps), [DELETE Workspace Layer](rest.md#delete-workspace-layer) and [DELETE Workspace Map](rest.md#delete-workspace-map)
* `url` key
* `wms`.`url` key
* `wfs`.`url` key
* `style`.`url` key
* `thumbnail`.`url` key
* `metadata`.`comparison_url` key
* [PATCH Workspace Map](rest.md#patch-workspace-map)
* `url` key
* `file`.`url` key
* `thumbnail`.`url` key
* `metadata`.`comparison_url` key
* [OGC endpoints](endpoints.md)
* Headers `X-Forwarded-For`, `X-Forwarded-Path`, `Forwarded` and `Host` are ignored
* [WMS endpoints](endpoints.md#web-map-service)
Expand All @@ -110,4 +82,4 @@ Currently, value of X-Forwarded headers affects following URLs:
* [WFS endpoints](endpoints.md#web-feature-service)
* all operations URLs

Values of X-Forwarded headers does not affect responses of [GET Workspace Layer Metadata Comparison](rest.md#get-workspace-layer-metadata-comparison) and [GET Workspace Map Metadata Comparison](rest.md#get-workspace-map-metadata-comparison) intentionally, in order to keep URLs in canonical form.
Values of X-Forwarded headers does not affect responses of [GET Workspace Layer Metadata Comparison](rest.md#get-workspace-layer-metadata-comparison) and [GET Workspace Map Metadata Comparison](rest.md#get-workspace-map-metadata-comparison) intentionally, in order to keep URLs in canonical form.

0 comments on commit 78f9f95

Please sign in to comment.