[Geoserver-devel] Swagger specification for extension/community modules?

Hi,
I’m writing a new REST API for the OpenSearch module as a Swagger specification.
Now, I would like to add it among the docs, but there does not seem swagger docs
for any extension or community module yet (a leftover from the sprint?).

So, was there a plan, is there any slot or place that I can add my docs into?

Cheers
Andrea

···

==
GeoServer Professional Services from the experts! Visit
http://goo.gl/it488V for more information.

Ing. Andrea Aime

@geowolf
Technical Lead

GeoSolutions S.A.S.
Via di Montramito 3/A
55054 Massarosa (LU)
phone: +39 0584 962313

fax: +39 0584 1660272
mob: +39 339 8844549

http://www.geo-solutions.it
http://twitter.com/geosolutions_it

AVVERTENZE AI SENSI DEL D.Lgs. 196/2003

Le informazioni contenute in questo messaggio di posta elettronica e/o nel/i file/s allegato/i sono da considerarsi strettamente riservate. Il loro utilizzo è consentito esclusivamente al destinatario del messaggio, per le finalità indicate nel messaggio stesso. Qualora riceviate questo messaggio senza esserne il destinatario, Vi preghiamo cortesemente di darcene notizia via e-mail e di procedere alla distruzione del messaggio stesso, cancellandolo dal Vostro sistema. Conservare il messaggio stesso, divulgarlo anche in parte, distribuirlo ad altri soggetti, copiarlo, od utilizzarlo per finalità diverse, costituisce comportamento contrario ai principi dettati dal D.Lgs. 196/2003.

The information in this message and/or attachments, is intended solely for the attention and use of the named addressee(s) and may be confidential or proprietary in nature or covered by the provisions of privacy act (Legislative Decree June, 30 2003, no.196 - Italy’s New Data Protection Code).Any use not in accord with its purpose, any disclosure, reproduction, copying, distribution, or either dissemination, either whole or partial, is strictly forbidden except previous formal approval of the named addressee(s). If you are not the intended recipient, please contact immediately the sender by telephone, fax or e-mail and delete the information in this message that has been received in error. The sender does not give any warranty or accept liability as the content, accuracy or completeness of sent messages and accepts no responsibility for changes made after they were sent or for other risks which arise as a result of e-mail transmission, viruses, etc.


Hi Andrea. I think the short version is that we ran out of time.

But there's no reason why we can't iterate and add extensions/modules now.

New API pages can be added here:

https://github.com/geoserver/geoserver/tree/master/doc/en/api/1.0.0

(I note that this folder structure is flat, and we can probably leave it that way for now, but we may want to add a folder structure for extensions/community modules if the directory gets too unwieldy.)

New docs can be linked to from this page:

https://github.com/geoserver/geoserver/blob/master/doc/en/user/source/rest/index.rst

The process for posting the API docs online at docs.geoserver.org is, if memory serves, a little manual right now (we have to SCP to the server), and as far as I know, not part of any Jenkins build. Someone please correct me if I'm wrong.

Thanks,
Mike

Mike Pumphrey
Education Program Director | Boundless
917-338-0407
mike@anonymised.com
http://boundlessgeo.com
@boundlessgeo

On 6/12/2017 6:09 AM, Andrea Aime wrote:

Hi,
I'm writing a new REST API for the OpenSearch module as a Swagger
specification.
Now, I would like to add it among the docs, but there does not seem swagger
docs
for any extension or community module yet (a leftover from the sprint?).

So, was there a plan, is there any slot or place that I can add my docs
into?

Cheers
Andrea

------------------------------------------------------------------------------
Check out the vibrant tech community on one of the world's most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot

_______________________________________________
Geoserver-devel mailing list
Geoserver-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/geoserver-devel

I think we had a few examples, and made a note in the swagger docs that the extension point was optional.

See example here - http://docs.geoserver.org/api/#/1.0.0/importer.yaml

···

On 12 June 2017 at 09:47, Mike Pumphrey <mike@anonymised.com> wrote:

Hi Andrea. I think the short version is that we ran out of time.

But there’s no reason why we can’t iterate and add extensions/modules now.

New API pages can be added here:

https://github.com/geoserver/geoserver/tree/master/doc/en/api/1.0.0

(I note that this folder structure is flat, and we can probably leave it that way for now, but we may want to add a folder structure for extensions/community modules if the directory gets too unwieldy.)

New docs can be linked to from this page:

https://github.com/geoserver/geoserver/blob/master/doc/en/user/source/rest/index.rst

The process for posting the API docs online at docs.geoserver.org is, if memory serves, a little manual right now (we have to SCP to the server), and as far as I know, not part of any Jenkins build. Someone please correct me if I’m wrong.

Thanks,
Mike

Mike Pumphrey
Education Program Director | Boundless
917-338-0407
mike@anonymised.com
http://boundlessgeo.com
@boundlessgeo

On 6/12/2017 6:09 AM, Andrea Aime wrote:

Hi,
I’m writing a new REST API for the OpenSearch module as a Swagger
specification.
Now, I would like to add it among the docs, but there does not seem swagger
docs
for any extension or community module yet (a leftover from the sprint?).

So, was there a plan, is there any slot or place that I can add my docs
into?

Cheers
Andrea


Check out the vibrant tech community on one of the world’s most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot


Geoserver-devel mailing list
Geoserver-devel@anonymised.comrge.net
https://lists.sourceforge.net/lists/listinfo/geoserver-devel


Check out the vibrant tech community on one of the world’s most
engaging tech sites, Slashdot.org! http://sdm.link/slashdot


Geoserver-devel mailing list
Geoserver-devel@anonymised.comrge.net
https://lists.sourceforge.net/lists/listinfo/geoserver-devel


Jody Garnett