[Geoserver-devel] Error in Swagger documentation?

Torben,

I received off-list what looks like a Swagger REST API documentation bug report. I could not verify because it looks like our Swagger API docs are down: <http://docs.geoserver.org/latest/en/api/&gt;\.

小进 can you please clarify?

- Do you have a URL for the documentation that you believe is incorrect?

- Also, what version of GeoServer are you using? The API may have changed with the move to Spring REST in GeoServer 2.12.x.

Kind regards,
Ben.

-------- Forwarded Message --------
Subject: Advice on official documentation
Date: Thu, 21 Dec 2017 16:48:23 +0800 (CST)
From: 小进 <ouo6688@anonymised.com>
To: ben@anonymised.com

It is not correct to create a workspace official document

--
Ben Caradoc-Davies <ben@anonymised.com>
Director
Transient Software Limited <https://transient.nz/&gt;
New Zealand

(attachments)

image1.png
image2.png

Ben - I can still reach the swagger docs fine, e.g. http://docs.geoserver.org/api/#/1.0.0/workspaces.yaml
Perhaps it was a temporary outage?

As for the error, I do see some typos on the page, but don’t see any issues with the model. Some clarification on what the error is would be helpful.

Torben

···

On Thu, Dec 21, 2017 at 2:14 PM, Ben Caradoc-Davies <ben@anonymised.com1…> wrote:

Torben,

I received off-list what looks like a Swagger REST API documentation bug report. I could not verify because it looks like our Swagger API docs are down: <http://docs.geoserver.org/latest/en/api/>.

小进 can you please clarify?

  • Do you have a URL for the documentation that you believe is incorrect?

  • Also, what version of GeoServer are you using? The API may have changed with the move to Spring REST in GeoServer 2.12.x.

Kind regards,
Ben.

-------- Forwarded Message --------
Subject: Advice on official documentation
Date: Thu, 21 Dec 2017 16:48:23 +0800 (CST)
From: 小进 <ouo6688@anonymised.com>
To: ben@anonymised.com

It is not correct to create a workspace official document


Ben Caradoc-Davies <ben@anonymised.com>
Director
Transient Software Limited <https://transient.nz/>
New Zealand

Thanks, Torben. Do we expect to see anything here?
http://docs.geoserver.org/latest/en/api/

It is the top Google hit for GeoServer Swagger and has only the Swagger banner.

On 22/12/17 11:23, Torben Barsballe wrote:

Ben - I can still reach the swagger docs fine, e.g.
http://docs.geoserver.org/api/#/1.0.0/workspaces.yaml
Perhaps it was a temporary outage?

As for the error, I do see some typos on the page, but don't see any issues
with the model. Some clarification on what the error is would be helpful.

Torben

On Thu, Dec 21, 2017 at 2:14 PM, Ben Caradoc-Davies <ben@anonymised.com>
wrote:

Torben,

I received off-list what looks like a Swagger REST API documentation bug
report. I could not verify because it looks like our Swagger API docs are
down: <http://docs.geoserver.org/latest/en/api/&gt;\.

小进 can you please clarify?

- Do you have a URL for the documentation that you believe is incorrect?

- Also, what version of GeoServer are you using? The API may have changed
with the move to Spring REST in GeoServer 2.12.x.

Kind regards,
Ben.

-------- Forwarded Message --------
Subject: Advice on official documentation
Date: Thu, 21 Dec 2017 16:48:23 +0800 (CST)
From: 小进 <ouo6688@anonymised.com>
To: ben@anonymised.com

It is not correct to create a workspace official document

--
Ben Caradoc-Davies <ben@anonymised.com>
Director
Transient Software Limited <https://transient.nz/&gt;
New Zealand

--
Ben Caradoc-Davies <ben@anonymised.com>
Director
Transient Software Limited <https://transient.nz/&gt;
New Zealand

I don’t think we have a landing page for the swagger docs, we generally assumed that users will go through the links at http://docs.geoserver.org/latest/en/user/rest/index.html#rest
So, I wasn’t expecting there to be anything, no. The search bar should still work.

Honestly not to sure about how swagger is supposed to work with respect to a landing page / homepage or similar.

Torben

···

On Thu, Dec 21, 2017 at 2:27 PM, Ben Caradoc-Davies <ben@anonymised.com4191…> wrote:

Thanks, Torben. Do we expect to see anything here?
http://docs.geoserver.org/latest/en/api/

It is the top Google hit for GeoServer Swagger and has only the Swagger banner.

On 22/12/17 11:23, Torben Barsballe wrote:

Ben - I can still reach the swagger docs fine, e.g.
http://docs.geoserver.org/api/#/1.0.0/workspaces.yaml
Perhaps it was a temporary outage?

As for the error, I do see some typos on the page, but don’t see any issues
with the model. Some clarification on what the error is would be helpful.

Torben

On Thu, Dec 21, 2017 at 2:14 PM, Ben Caradoc-Davies <ben@anonymised.com>
wrote:

Torben,

I received off-list what looks like a Swagger REST API documentation bug
report. I could not verify because it looks like our Swagger API docs are
down: <http://docs.geoserver.org/latest/en/api/>.

小进 can you please clarify?

  • Do you have a URL for the documentation that you believe is incorrect?

  • Also, what version of GeoServer are you using? The API may have changed
    with the move to Spring REST in GeoServer 2.12.x.

Kind regards,
Ben.

-------- Forwarded Message --------
Subject: Advice on official documentation
Date: Thu, 21 Dec 2017 16:48:23 +0800 (CST)
From: 小进 <ouo6688@anonymised.com>
To: ben@anonymised.com

It is not correct to create a workspace official document


Ben Caradoc-Davies <ben@anonymised.com>
Director
Transient Software Limited <https://transient.nz/>
New Zealand


Ben Caradoc-Davies <ben@anonymised.com>
Director
Transient Software Limited <https://transient.nz/>
New Zealand