[Geoserver-devel] Request to merge pull request #111

GeoServer GeoServer Developer
1

This pull request updates /corrects the REST API documentation. I know that we are in the middle of a release process, so I just wanted to ask (specifically Andrea) if it's okay if I go ahead and merge it in, or whether I should wait.

https://github.com/geoserver/geoserver/pull/111

  Thanks,
Mike Pumphrey
OpenGeo - http://opengeo.org

2

I think you should be fine here Mike. I think jody is going to be trying a 2.3 release again tonight but this shouldn’t conflict.

···

On Tue, Jan 22, 2013 at 11:44 AM, Mike Pumphrey <mike@anonymised.com> wrote:

This pull request updates /corrects the REST API documentation. I know that we are in the middle of a release process, so I just wanted to ask (specifically Andrea) if it’s okay if I go ahead and merge it in, or whether I should wait.

https://github.com/geoserver/geoserver/pull/111

Thanks,
Mike Pumphrey
OpenGeo - http://opengeo.org

–
Justin Deoliveira
OpenGeo - http://opengeo.org
Enterprise support for open source geospatial.

3

Hi Mike,
I think we have missed (cutted off) some pieces of documentation during this “Improved / corrected REST documentation (see GEOS-5595)” refactoring (regarding the about/version about/manifest improvements):
please take a look to:
on branch 2.2.x - the commit “619156c0e2a0946b58ea0e3877dfda806417300d” “adding documentation”
on branch master - the commit ‘54eebfb03058538e34c47e05f08f2450d76a347e’ “adding documentation”

To marge missing part of the documentation.
Cheers,
Carlo

2013/1/23 Justin Deoliveira <jdeolive@anonymised.com>

···

On Tue, Jan 22, 2013 at 11:44 AM, Mike Pumphrey <mike@anonymised.com> wrote:

This pull request updates /corrects the REST API documentation. I know that we are in the middle of a release process, so I just wanted to ask (specifically Andrea) if it’s okay if I go ahead and merge it in, or whether I should wait.

https://github.com/geoserver/geoserver/pull/111

Thanks,
Mike Pumphrey
OpenGeo - http://opengeo.org

–

Justin Deoliveira
OpenGeo - http://opengeo.org
Enterprise support for open source geospatial.

4

Hello Carlo. My apologies, I'm sorry to have overwritten your work. That does explain the strange conflicts I found when I tried to merge.

I'm not excellent at figuring out diffs manually, but looking at that commit, I see that the primary difference is the "About" section. Did I miss something else? Please let me know, and I'll copy the section(s) back in.

Thanks,
Mike Pumphrey
OpenGeo - http://opengeo.org

On 1/24/2013 6:49 AM, carlo cancellieri wrote:

Hi Mike,
  I think we have missed (cutted off) some pieces of documentation during
this "Improved / corrected REST documentation (see GEOS-5595)" refactoring
(regarding the about/version about/manifest improvements):
please take a look to:
on branch 2.2.x - the commit "619156c0e2a0946b58ea0e3877dfda806417300d"
  "adding documentation"
on branch master - the commit '54eebfb03058538e34c47e05f08f2450d76a347e'
"adding documentation"

To marge missing part of the documentation.
Cheers,
Carlo

2013/1/23 Justin Deoliveira <jdeolive@anonymised.com>

I think you should be fine here Mike. I think jody is going to be trying a
2.3 release again tonight but this shouldn't conflict.

On Tue, Jan 22, 2013 at 11:44 AM, Mike Pumphrey <mike@anonymised.com> wrote:

This pull request updates /corrects the REST API documentation. I know
that we are in the middle of a release process, so I just wanted to ask
(specifically Andrea) if it's okay if I go ahead and merge it in, or
whether I should wait.

https://github.com/geoserver/**geoserver/pull/111&lt;https://github.com/geoserver/geoserver/pull/111&gt;

Thanks,
Mike Pumphrey
OpenGeo - http://opengeo.org

--
Justin Deoliveira
OpenGeo - http://opengeo.org
Enterprise support for open source geospatial.

------------------------------------------------------------------------------
Master Visual Studio, SharePoint, SQL, ASP.NET, C# 2012, HTML5, CSS,
MVC, Windows 8 Apps, JavaScript and much more. Keep your skills current
with LearnDevNow - 3,200 step-by-step video tutorials by Microsoft
MVPs and experts. ON SALE this month only -- learn more at:
http://p.sf.net/sfu/learnnow-d2d
_______________________________________________
Geoserver-devel mailing list
Geoserver-devel@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/geoserver-devel

5

Mike,

I’m not excellent at figuring out diffs manually, but looking at that commit, I see that the primary difference is the “About” section. Did I miss something else? Please let me know, and I’ll copy the section(s) back in.

We are lucky, I used a different commit only for docs.

Looking at the diffs you’ll note a new set of files here:
doc/en/user/source/restconfig/representations/*.txt

And some additions (regarding ‘about’) to the file:
doc/en/user/source/restconfig/rest-config-api.rst

That’s it.
Cheers,
Carlo

Thanks,
Mike Pumphrey
OpenGeo - http://opengeo.org

On 1/24/2013 6:49 AM, carlo cancellieri wrote:

Hi Mike,
I think we have missed (cutted off) some pieces of documentation during
this “Improved / corrected REST documentation (see GEOS-5595)” refactoring
(regarding the about/version about/manifest improvements):
please take a look to:
on branch 2.2.x - the commit “619156c0e2a0946b58ea0e3877dfda806417300d”
“adding documentation”
on branch master - the commit ‘54eebfb03058538e34c47e05f08f2450d76a347e’
“adding documentation”

To marge missing part of the documentation.
Cheers,
Carlo

2013/1/23 Justin Deoliveira <jdeolive@anonymised.com>

I think you should be fine here Mike. I think jody is going to be trying a
2.3 release again tonight but this shouldn’t conflict.

On Tue, Jan 22, 2013 at 11:44 AM, Mike Pumphrey <mike@anonymised.com> wrote:

This pull request updates /corrects the REST API documentation. I know
that we are in the middle of a release process, so I just wanted to ask
(specifically Andrea) if it’s okay if I go ahead and merge it in, or
whether I should wait.

https://github.com/geoserver/**geoserver/pull/111<https://github.com/geoserver/geoserver/pull/111>

Thanks,
Mike Pumphrey
OpenGeo - http://opengeo.org

–
Justin Deoliveira
OpenGeo - http://opengeo.org
Enterprise support for open source geospatial.

Master Visual Studio, SharePoint, SQL, ASP.NET, C# 2012, HTML5, CSS,
MVC, Windows 8 Apps, JavaScript and much more. Keep your skills current
with LearnDevNow - 3,200 step-by-step video tutorials by Microsoft
MVPs and experts. ON SALE this month only – learn more at:
http://p.sf.net/sfu/learnnow-d2d

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

–

==
Our support, Your Success! Visit http://opensdi.geo-solutions.it for more information.

Dott. Carlo Cancellieri
@cancellieric
Software Engineer

GeoSolutions S.A.S.
Via Poggio alle Viti 1187
55054 Massarosa (LU)
Italy
phone: +39 0584 962313
mobile: +39 3371094494
fax: +39 0584 1660272

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

6

Thanks. I will add back in the About content.

After some conversation a while back, I made the decision to remove the representation files from the docs as part of this update. Reasons being that they are an administrative hassle to keep correct (there were dozens of them, and many of them were wrong / out-of-date), and I felt like they were redundant when you could just execute the request and see. (Similar reasoning would be why we don't include copies of the capabilities documents in the docs.) So unless you strongly disagree, I'd like to leave the representation files out, and just port the About content. I'll let you know when I've done this.

Thanks,
Mike Pumphrey
OpenGeo - http://opengeo.org

On 1/25/2013 1:34 AM, carlo cancellieri wrote:

Mike,

I'm not excellent at figuring out diffs manually, but looking at that

commit, I see that the primary difference is the "About" section. Did I
miss something else? Please let me know, and I'll copy the section(s) back
in.

We are lucky, I used a different commit only for docs.

Looking at the diffs you'll note a new set of files here:
doc/en/user/source/restconfig/representations/*.txt

And some additions (regarding 'about') to the file:
doc/en/user/source/restconfig/rest-config-api.rst

That's it.
Cheers,
Carlo

Thanks,
Mike Pumphrey
OpenGeo - http://opengeo.org

On 1/24/2013 6:49 AM, carlo cancellieri wrote:

Hi Mike,
  I think we have missed (cutted off) some pieces of documentation during
this "Improved / corrected REST documentation (see GEOS-5595)" refactoring
(regarding the about/version about/manifest improvements):
please take a look to:
on branch 2.2.x - the commit "**619156c0e2a0946b58ea0e3877dfda**
806417300d"
  "adding documentation"
on branch master - the commit '**54eebfb03058538e34c47e05f08f24**
50d76a347e'
"adding documentation"

To marge missing part of the documentation.
Cheers,
Carlo

2013/1/23 Justin Deoliveira <jdeolive@anonymised.com>

I think you should be fine here Mike. I think jody is going to be trying

a
2.3 release again tonight but this shouldn't conflict.

On Tue, Jan 22, 2013 at 11:44 AM, Mike Pumphrey <mike@anonymised.com>
wrote:

This pull request updates /corrects the REST API documentation. I know

that we are in the middle of a release process, so I just wanted to ask
(specifically Andrea) if it's okay if I go ahead and merge it in, or
whether I should wait.

https://github.com/geoserver/****geoserver/pull/111&lt;https://github.com/geoserver/**geoserver/pull/111&gt;
<https://**github.com/geoserver/**geoserver/pull/111<https://github.com/geoserver/geoserver/pull/111>
>

Thanks,
Mike Pumphrey
OpenGeo - http://opengeo.org

--
Justin Deoliveira
OpenGeo - http://opengeo.org
Enterprise support for open source geospatial.

------------------------------**------------------------------**
------------------
Master Visual Studio, SharePoint, SQL, ASP.NET, C# 2012, HTML5, CSS,
MVC, Windows 8 Apps, JavaScript and much more. Keep your skills current
with LearnDevNow - 3,200 step-by-step video tutorials by Microsoft
MVPs and experts. ON SALE this month only -- learn more at:
http://p.sf.net/sfu/learnnow-**d2d <http://p.sf.net/sfu/learnnow-d2d&gt;
______________________________**_________________
Geoserver-devel mailing list
Geoserver-devel@anonymised.com**sourceforge.net<Geoserver-devel@lists.sourceforge.net>
https://lists.sourceforge.net/**lists/listinfo/geoserver-devel&lt;https://lists.sourceforge.net/lists/listinfo/geoserver-devel&gt;

7

Also, what version does this about/manifest functionality work against? I've got 2.2.4 installed, and I don't seem to have that endpoint at all. Commands like this:

http://localhost:8080/geoserver/rest/about/manifest.xml?key=GeoServerModule&value=extension

don't respond with anything other than the generic rest interface. Is this a 2.3.x feature or did this happen after 2.2.4?

There's a good chance I just don't follow what's going on. But as long as I was (re-)adding documentation, I figured I'd test it out. Thanks.

Thanks,
Mike Pumphrey
OpenGeo - http://opengeo.org

On 1/25/2013 1:34 AM, carlo cancellieri wrote:

Mike,

I'm not excellent at figuring out diffs manually, but looking at that

commit, I see that the primary difference is the "About" section. Did I
miss something else? Please let me know, and I'll copy the section(s) back
in.

We are lucky, I used a different commit only for docs.

Looking at the diffs you'll note a new set of files here:
doc/en/user/source/restconfig/representations/*.txt

And some additions (regarding 'about') to the file:
doc/en/user/source/restconfig/rest-config-api.rst

That's it.
Cheers,
Carlo

Thanks,
Mike Pumphrey
OpenGeo - http://opengeo.org

On 1/24/2013 6:49 AM, carlo cancellieri wrote:

Hi Mike,
  I think we have missed (cutted off) some pieces of documentation during
this "Improved / corrected REST documentation (see GEOS-5595)" refactoring
(regarding the about/version about/manifest improvements):
please take a look to:
on branch 2.2.x - the commit "**619156c0e2a0946b58ea0e3877dfda**
806417300d"
  "adding documentation"
on branch master - the commit '**54eebfb03058538e34c47e05f08f24**
50d76a347e'
"adding documentation"

To marge missing part of the documentation.
Cheers,
Carlo

2013/1/23 Justin Deoliveira <jdeolive@anonymised.com>

I think you should be fine here Mike. I think jody is going to be trying

a
2.3 release again tonight but this shouldn't conflict.

On Tue, Jan 22, 2013 at 11:44 AM, Mike Pumphrey <mike@anonymised.com>
wrote:

This pull request updates /corrects the REST API documentation. I know

that we are in the middle of a release process, so I just wanted to ask
(specifically Andrea) if it's okay if I go ahead and merge it in, or
whether I should wait.

https://github.com/geoserver/****geoserver/pull/111&lt;https://github.com/geoserver/**geoserver/pull/111&gt;
<https://**github.com/geoserver/**geoserver/pull/111<https://github.com/geoserver/geoserver/pull/111>
>

Thanks,
Mike Pumphrey
OpenGeo - http://opengeo.org

--
Justin Deoliveira
OpenGeo - http://opengeo.org
Enterprise support for open source geospatial.

------------------------------**------------------------------**
------------------
Master Visual Studio, SharePoint, SQL, ASP.NET, C# 2012, HTML5, CSS,
MVC, Windows 8 Apps, JavaScript and much more. Keep your skills current
with LearnDevNow - 3,200 step-by-step video tutorials by Microsoft
MVPs and experts. ON SALE this month only -- learn more at:
http://p.sf.net/sfu/learnnow-**d2d <http://p.sf.net/sfu/learnnow-d2d&gt;
______________________________**_________________
Geoserver-devel mailing list
Geoserver-devel@anonymised.com**sourceforge.net<Geoserver-devel@lists.sourceforge.net>
https://lists.sourceforge.net/**lists/listinfo/geoserver-devel&lt;https://lists.sourceforge.net/lists/listinfo/geoserver-devel&gt;

8

Mike,
I agree with you. Note that I also added some cURL examples.
Carlo

2013/1/25 Mike Pumphrey <mike@anonymised.com…1501…>

Thanks. I will add back in the About content.

After some conversation a while back, I made the decision to remove the representation files from the docs as part of this update. Reasons being that they are an administrative hassle to keep correct (there were dozens of them, and many of them were wrong / out-of-date), and I felt like they were redundant when you could just execute the request and see. (Similar reasoning would be why we don’t include copies of the capabilities documents in the docs.) So unless you strongly disagree, I’d like to leave the representation files out, and just port the About content. I’ll let you know when I’ve done this.

Thanks,
Mike Pumphrey
OpenGeo - http://opengeo.org

On 1/25/2013 1:34 AM, carlo cancellieri wrote:

Mike,

I’m not excellent at figuring out diffs manually, but looking at that

commit, I see that the primary difference is the “About” section. Did I
miss something else? Please let me know, and I’ll copy the section(s) back
in.

We are lucky, I used a different commit only for docs.

Looking at the diffs you’ll note a new set of files here:
doc/en/user/source/restconfig/representations/*.txt

And some additions (regarding ‘about’) to the file:
doc/en/user/source/restconfig/rest-config-api.rst

That’s it.
Cheers,
Carlo

Thanks,
Mike Pumphrey
OpenGeo - http://opengeo.org

On 1/24/2013 6:49 AM, carlo cancellieri wrote:

Hi Mike,
I think we have missed (cutted off) some pieces of documentation during
this “Improved / corrected REST documentation (see GEOS-5595)” refactoring
(regarding the about/version about/manifest improvements):
please take a look to:

on branch 2.2.x - the commit “619156c0e2a0946b58ea0e3877dfda
806417300d”
“adding documentation”
on branch master - the commit '54eebfb03058538e34c47e05f08f24

50d76a347e’
“adding documentation”

To marge missing part of the documentation.
Cheers,
Carlo

2013/1/23 Justin Deoliveira <jdeolive@anonymised.com>

I think you should be fine here Mike. I think jody is going to be trying

a
2.3 release again tonight but this shouldn’t conflict.

On Tue, Jan 22, 2013 at 11:44 AM, Mike Pumphrey <mike@anonymised.com>
wrote:

This pull request updates /corrects the REST API documentation. I know

that we are in the middle of a release process, so I just wanted to ask
(specifically Andrea) if it’s okay if I go ahead and merge it in, or
whether I should wait.

https://github.com/geoserver/****geoserver/pull/111<https://github.com/geoserver/**geoserver/pull/111>
<https://**github.com/geoserver/**geoserver/pull/111<https://github.com/geoserver/geoserver/pull/111>

Thanks,
Mike Pumphrey
OpenGeo - http://opengeo.org

–
Justin Deoliveira
OpenGeo - http://opengeo.org
Enterprise support for open source geospatial.

------------------------------------------------------------

Master Visual Studio, SharePoint, SQL, ASP.NET, C# 2012, HTML5, CSS,
MVC, Windows 8 Apps, JavaScript and much more. Keep your skills current
with LearnDevNow - 3,200 step-by-step video tutorials by Microsoft
MVPs and experts. ON SALE this month only – learn more at:

http://p.sf.net/sfu/learnnow-**d2d <http://p.sf.net/sfu/learnnow-d2d>
_____________**
Geoserver-devel mailing list
Geoserver-devel@anonymised.com**sourceforge.net<Geoserver-devel@lists.sourceforge.net>
https://lists.sourceforge.net/**lists/listinfo/geoserver-devel<https://lists.sourceforge.net/lists/listinfo/geoserver-devel>

–

==
Our support, Your Success! Visit http://opensdi.geo-solutions.it for more information.

Dott. Carlo Cancellieri
@cancellieric
Software Engineer

GeoSolutions S.A.S.
Via Poggio alle Viti 1187
55054 Massarosa (LU)
Italy
phone: +39 0584 962313
mobile: +39 3371094494
fax: +39 0584 1660272

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

9

Hi Mike,
see inline.

I have a few additional questions, but they may be answered when I actually try out the software, but I can’t seem to find where it is. Some questions that come to mind:

  • When entering rest/about/manifest.xml?.., what happens when the key value pair is omitted? The docs don’t say.

The default format is [.html] so when you point to rest/about/manifest you get the same result as per rest/about/manifest.html. You’ll get a list of all the manifest files (with properties) of all the jars loaded by the classloader.

  • Where is the manifest.properties file placed?

It is located into the main jar of the geoserver core. If you want to change (override) default settings you have to place a copy of that file (with your changes) into the GeoServer Data dir (root).

  • There are two different endpoints in this section, about/manifest, and about/version. How are they related? What would I call both of them together? “About” seems a bit non-specific.

When you ask to geoserver (via web gui) for the about page you simply get the versions of the main used components.
Something like:

  • 2.2-SNAPSHOT
  • 8d37359c56b8cb07d560d600fe1cd76db7236619
  • 25-Jan-2013 02:50
  • 8-SNAPSHOT (rev d64d6a20e83ed60dc6e5ffea564a0c38e88ed4d2)

This is more or less the same of what you get using about/version.
The about/manifest[.format] instead is a more detailed list of version (with all the loaded libraries) which can be used for reports or to check configuration programmatically (for example in Continuous Integration).
I added the filter capabilities to be able to filter by core, extensions, communities and customized jars (in the way I show you in the examples).

It might seem a little slow and laborious, but I’ve found that this kind of back-and-forth really helps to make clear, quality documentation. (I’m documentation lead at OpenGeo.) If you have any questions, please let me know. I appreciate your help!

I know, documentation really important for software, so no problem Mike, nice to meet you :slight_smile:

Also, what version does this about/manifest functionality work against? I’ve got 2.2.4 installed, and I don’t seem to have that endpoint at all. Commands like this:
http://localhost:8080/geoserver/rest/about/manifest.xml?key=GeoServerModule&value=extension
don’t respond with anything other than the generic rest interface. Is this a 2.3.x feature or did this happen after 2.2.4?

It will be available since 2.2.5 and 2.3.0

Thank you,
Carlo

There’s a good chance I just don’t follow what’s going on. But as long as I was (re-)adding documentation, I figured I’d test it out. Thanks.

Thanks,
Mike Pumphrey
OpenGeo - http://opengeo.org

On 1/25/2013 1:34 AM, carlo cancellieri wrote:

Mike,

I’m not excellent at figuring out diffs manually, but looking at that

commit, I see that the primary difference is the “About” section. Did I
miss something else? Please let me know, and I’ll copy the section(s) back
in.

We are lucky, I used a different commit only for docs.

Looking at the diffs you’ll note a new set of files here:
doc/en/user/source/restconfig/representations/*.txt

And some additions (regarding ‘about’) to the file:
doc/en/user/source/restconfig/rest-config-api.rst

That’s it.
Cheers,
Carlo

Thanks,
Mike Pumphrey
OpenGeo - http://opengeo.org

On 1/24/2013 6:49 AM, carlo cancellieri wrote:

Hi Mike,
I think we have missed (cutted off) some pieces of documentation during
this “Improved / corrected REST documentation (see GEOS-5595)” refactoring
(regarding the about/version about/manifest improvements):
please take a look to:
on branch 2.2.x - the commit “619156c0e2a0946b58ea0e3877dfda
806417300d”
“adding documentation”
on branch master - the commit ‘54eebfb03058538e34c47e05f08f24
50d76a347e’
“adding documentation”

To marge missing part of the documentation.
Cheers,
Carlo

2013/1/23 Justin Deoliveira <jdeolive@anonymised.com>

I think you should be fine here Mike. I think jody is going to be trying

a
2.3 release again tonight but this shouldn’t conflict.

On Tue, Jan 22, 2013 at 11:44 AM, Mike Pumphrey <mike@anonymised.com>
wrote:

This pull request updates /corrects the REST API documentation. I know

that we are in the middle of a release process, so I just wanted to ask
(specifically Andrea) if it’s okay if I go ahead and merge it in, or
whether I should wait.

https://github.com/geoserver/****geoserver/pull/111<https://github.com/geoserver/**geoserver/pull/111>
<https://**github.com/geoserver/**geoserver/pull/111<https://github.com/geoserver/geoserver/pull/111>

Thanks,
Mike Pumphrey
OpenGeo - http://opengeo.org

–
Justin Deoliveira
OpenGeo - http://opengeo.org
Enterprise support for open source geospatial.

------------------------------------------------------------

Master Visual Studio, SharePoint, SQL, ASP.NET, C# 2012, HTML5, CSS,
MVC, Windows 8 Apps, JavaScript and much more. Keep your skills current
with LearnDevNow - 3,200 step-by-step video tutorials by Microsoft
MVPs and experts. ON SALE this month only – learn more at:
http://p.sf.net/sfu/learnnow-**d2d <http://p.sf.net/sfu/learnnow-d2d>
_____________**
Geoserver-devel mailing list
Geoserver-devel@anonymised.com**sourceforge.net<Geoserver-devel@lists.sourceforge.net>
https://lists.sourceforge.net/**lists/listinfo/geoserver-devel<https://lists.sourceforge.net/lists/listinfo/geoserver-devel>

–

==
Our support, Your Success! Visit http://opensdi.geo-solutions.it for more information.

Dott. Carlo Cancellieri
@cancellieric
Software Engineer

GeoSolutions S.A.S.
Via Poggio alle Viti 1187
55054 Massarosa (LU)
Italy
phone: +39 0584 962313
mobile: +39 3371094494
fax: +39 0584 1660272

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

10

Great, I think I have all my questions answered now. Please see https://github.com/geoserver/geoserver/pull/126. If no changes are necessary, please accept and port to master as well (or I can do that). Thanks!

Thanks,
Mike Pumphrey
OpenGeo - http://opengeo.org

On 1/29/2013 2:26 AM, carlo cancellieri wrote:

Hi Mike,
  see inline.

I have a few additional questions, but they may be answered when I actually

try out the software, but I can't seem to find where it is. Some questions
that come to mind:

* When entering rest/about/manifest.xml?..., what happens when the key
value pair is omitted? The docs don't say.

The default format is [.html] so when you point to rest/about/manifest you
get the same result as per rest/about/manifest.html. You'll get a list of
all the manifest files (with properties) of all the jars loaded by the
classloader.

* Where is the manifest.properties file placed?

It is located into the main jar of the geoserver core. If you want to
change (override) default settings you have to place a copy of that file
(with your changes) into the GeoServer Data dir (root).

* There are two different endpoints in this section, about/manifest, and
about/version. How are they related? What would I call both of them
together? "About" seems a bit non-specific.

When you ask to geoserver (via web gui) for the about page you simply get
the versions of the main used components.
Something like:
-----------------------------------------------------------

    - Version2.2-SNAPSHOT
    - Git Revision8d37359c56b8cb07d560d600fe1cd76db7236619
    - Build Date25-Jan-2013 02:50
    - GeoTools Version8-SNAPSHOT (rev
    d64d6a20e83ed60dc6e5ffea564a0c38e88ed4d2)
    - -----------------------------------------------------------

This is more or less the same of what you get using about/version.
The about/manifest[.format] instead is a more detailed list of version
(with all the loaded libraries) which can be used for reports or to check
configuration programmatically (for example in Continuous Integration).
I added the filter capabilities to be able to filter by core, extensions,
communities and customized jars (in the way I show you in the examples).

It might seem a little slow and laborious, but I've found that this kind
of back-and-forth really helps to make clear, quality documentation. (I'm
documentation lead at OpenGeo.) If you have any questions, please let me
know. I appreciate your help!

I know, documentation really important for software, so no problem Mike,
nice to meet you :slight_smile:

Also, what version does this about/manifest functionality work against?

I've got 2.2.4 installed, and I don't seem to have that endpoint at all.
Commands like this:
http://localhost:8080/**geoserver/rest/about/manifest.**
xml?key=GeoServerModule&value=**extension<http://localhost:8080/geoserver/rest/about/manifest.xml?key=GeoServerModule&value=extension&gt;
don't respond with anything other than the generic rest interface. Is
this a 2.3.x feature or did this happen after 2.2.4?

It will be available since 2.2.5 and 2.3.0

Thank you,
Carlo

There's a good chance I just don't follow what's going on. But as long as
I was (re-)adding documentation, I figured I'd test it out. Thanks.

Thanks,
Mike Pumphrey
OpenGeo - http://opengeo.org

On 1/25/2013 1:34 AM, carlo cancellieri wrote:

Mike,

I'm not excellent at figuring out diffs manually, but looking at that

commit, I see that the primary difference is the "About" section. Did I
miss something else? Please let me know, and I'll copy the section(s)
back
in.

We are lucky, I used a different commit only for docs.

Looking at the diffs you'll note a new set of files here:
doc/en/user/source/restconfig/**representations/*.txt

And some additions (regarding 'about') to the file:
doc/en/user/source/restconfig/**rest-config-api.rst

That's it.
Cheers,
Carlo

Thanks,
Mike Pumphrey
OpenGeo - http://opengeo.org

On 1/24/2013 6:49 AM, carlo cancellieri wrote:

Hi Mike,

  I think we have missed (cutted off) some pieces of documentation
during
this "Improved / corrected REST documentation (see GEOS-5595)"
refactoring
(regarding the about/version about/manifest improvements):
please take a look to:
on branch 2.2.x - the commit "****619156c0e2a0946b58ea0e3877dfda****
806417300d"
  "adding documentation"
on branch master - the commit '****54eebfb03058538e34c47e05f08f24****
50d76a347e'
"adding documentation"

To marge missing part of the documentation.
Cheers,
Carlo

2013/1/23 Justin Deoliveira <jdeolive@anonymised.com>

I think you should be fine here Mike. I think jody is going to be
trying

a
2.3 release again tonight but this shouldn't conflict.

On Tue, Jan 22, 2013 at 11:44 AM, Mike Pumphrey <mike@anonymised.com>
wrote:

This pull request updates /corrects the REST API documentation. I
know

that we are in the middle of a release process, so I just wanted to
ask
(specifically Andrea) if it's okay if I go ahead and merge it in, or
whether I should wait.

https://github.com/geoserver/******geoserver/pull/111&lt;https://github.com/geoserver/****geoserver/pull/111&gt;
<https://**github.com/geoserver/****geoserver/pull/111<https://github.com/geoserver/**geoserver/pull/111>
>
<https://**github.com/**geoserver/**geoserver/pull/111<http://github.com/geoserver/**geoserver/pull/111&gt;
**<https://github.com/geoserver/**geoserver/pull/111&lt;https://github.com/geoserver/geoserver/pull/111&gt;
>

Thanks,
Mike Pumphrey
OpenGeo - http://opengeo.org

--
Justin Deoliveira
OpenGeo - http://opengeo.org
Enterprise support for open source geospatial.

------------------------------****----------------------------**--**
------------------
Master Visual Studio, SharePoint, SQL, ASP.NET, C# 2012, HTML5, CSS,
MVC, Windows 8 Apps, JavaScript and much more. Keep your skills
current
with LearnDevNow - 3,200 step-by-step video tutorials by Microsoft
MVPs and experts. ON SALE this month only -- learn more at:
http://p.sf.net/sfu/learnnow-****d2d&lt;http://p.sf.net/sfu/learnnow-**d2d&gt;&lt;
http://p.sf.net/sfu/learnnow-**d2d <http://p.sf.net/sfu/learnnow-d2d&gt;
>
______________________________****_________________
Geoserver-devel mailing list
Geoserver-devel@anonymised.com**source**forge.net <http://sourceforge.net><
Geoserver-devel@**lists.sourceforge.net<Geoserver-devel@lists.sourceforge.net>
>
https://lists.sourceforge.net/****lists/listinfo/geoserver-**devel&lt;https://lists.sourceforge.net/**lists/listinfo/geoserver-devel&gt;
<https://lists.**sourceforge.net/lists/**listinfo/geoserver-devel<https://lists.sourceforge.net/lists/listinfo/geoserver-devel>
>

11

Mike,
Ok looks good, but still missing the curl examples, don’t know if you want to include them; if so, take a look here:/en/user/source/restconfig/rest-config-examples/rest-config-examples-curl.rst
https://github.com/ccancellieri/geoserver/commit/d437d1544d389030d2c375b47a837cc71095ef4d

Thank you,
Carlo

2013/1/29 Mike Pumphrey <mike@anonymised.com>

Great, I think I have all my questions answered now. Please see https://github.com/geoserver/geoserver/pull/126. If no changes are necessary, please accept and port to master as well (or I can do that). Thanks!

Thanks,
Mike Pumphrey
OpenGeo - http://opengeo.org

On 1/29/2013 2:26 AM, carlo cancellieri wrote:

Hi Mike,

see inline.

I have a few additional questions, but they may be answered when I actually

try out the software, but I can’t seem to find where it is. Some questions
that come to mind:

  • When entering rest/about/manifest.xml?.., what happens when the key
    value pair is omitted? The docs don’t say.

The default format is [.html] so when you point to rest/about/manifest you
get the same result as per rest/about/manifest.html. You’ll get a list of
all the manifest files (with properties) of all the jars loaded by the
classloader.

  • Where is the manifest.properties file placed?

It is located into the main jar of the geoserver core. If you want to
change (override) default settings you have to place a copy of that file
(with your changes) into the GeoServer Data dir (root).

  • There are two different endpoints in this section, about/manifest, and
    about/version. How are they related? What would I call both of them
    together? “About” seems a bit non-specific.

When you ask to geoserver (via web gui) for the about page you simply get
the versions of the main used components.
Something like:

  • Version2.2-SNAPSHOT
  • Git Revision8d37359c56b8cb07d560d600fe1cd76db7236619
  • Build Date25-Jan-2013 02:50
  • GeoTools Version8-SNAPSHOT (rev
    d64d6a20e83ed60dc6e5ffea564a0c38e88ed4d2)

This is more or less the same of what you get using about/version.
The about/manifest[.format] instead is a more detailed list of version
(with all the loaded libraries) which can be used for reports or to check
configuration programmatically (for example in Continuous Integration).
I added the filter capabilities to be able to filter by core, extensions,
communities and customized jars (in the way I show you in the examples).

It might seem a little slow and laborious, but I’ve found that this kind
of back-and-forth really helps to make clear, quality documentation. (I’m
documentation lead at OpenGeo.) If you have any questions, please let me
know. I appreciate your help!

I know, documentation really important for software, so no problem Mike,
nice to meet you :slight_smile:

Also, what version does this about/manifest functionality work against?

I’ve got 2.2.4 installed, and I don’t seem to have that endpoint at all.
Commands like this:

http://localhost:8080/geoserver/rest/about/manifest.
xml?key=GeoServerModule&value=**extension<http://localhost:8080/geoserver/rest/about/manifest.xml?key=GeoServerModule&value=extension>

don’t respond with anything other than the generic rest interface. Is
this a 2.3.x feature or did this happen after 2.2.4?

It will be available since 2.2.5 and 2.3.0

Thank you,
Carlo

There’s a good chance I just don’t follow what’s going on. But as long as
I was (re-)adding documentation, I figured I’d test it out. Thanks.

Thanks,
Mike Pumphrey
OpenGeo - http://opengeo.org

On 1/25/2013 1:34 AM, carlo cancellieri wrote:

Mike,

I’m not excellent at figuring out diffs manually, but looking at that

commit, I see that the primary difference is the “About” section. Did I
miss something else? Please let me know, and I’ll copy the section(s)
back
in.

We are lucky, I used a different commit only for docs.

Looking at the diffs you’ll note a new set of files here:

doc/en/user/source/restconfig/**representations/*.txt

And some additions (regarding ‘about’) to the file:

doc/en/user/source/restconfig/**rest-config-api.rst

That’s it.
Cheers,
Carlo

Thanks,
Mike Pumphrey
OpenGeo - http://opengeo.org

On 1/24/2013 6:49 AM, carlo cancellieri wrote:

Hi Mike,

I think we have missed (cutted off) some pieces of documentation
during
this “Improved / corrected REST documentation (see GEOS-5595)”
refactoring
(regarding the about/version about/manifest improvements):
please take a look to:

on branch 2.2.x - the commit “619156c0e2a0946b58ea0e3877dfda
806417300d”
“adding documentation”
on branch master - the commit '54eebfb03058538e34c47e05f08f24

50d76a347e’
“adding documentation”

To marge missing part of the documentation.
Cheers,
Carlo

2013/1/23 Justin Deoliveira <jdeolive@anonymised.com>

I think you should be fine here Mike. I think jody is going to be
trying

a
2.3 release again tonight but this shouldn’t conflict.

On Tue, Jan 22, 2013 at 11:44 AM, Mike Pumphrey <mike@anonymised.com>
wrote:

This pull request updates /corrects the REST API documentation. I
know

that we are in the middle of a release process, so I just wanted to
ask
(specifically Andrea) if it’s okay if I go ahead and merge it in, or
whether I should wait.

https://github.com/geoserver/******geoserver/pull/111<https://github.com/geoserver/****geoserver/pull/111>
<https://**github.com/geoserver/****geoserver/pull/111<https://github.com/geoserver/**geoserver/pull/111>

<https://**github.com/**geoserver/**geoserver/pull/111<http://github.com/geoserver/**geoserver/pull/111>
**<https://github.com/geoserver/**geoserver/pull/111<https://github.com/geoserver/geoserver/pull/111>

Thanks,
Mike Pumphrey
OpenGeo - http://opengeo.org

–
Justin Deoliveira
OpenGeo - http://opengeo.org
Enterprise support for open source geospatial.

------------------------------****----------------------------–

Master Visual Studio, SharePoint, SQL, ASP.NET, C# 2012, HTML5, CSS,
MVC, Windows 8 Apps, JavaScript and much more. Keep your skills
current
with LearnDevNow - 3,200 step-by-step video tutorials by Microsoft
MVPs and experts. ON SALE this month only – learn more at:

http://p.sf.net/sfu/learnnow-****d2d<http://p.sf.net/sfu/learnnow-**d2d><
http://p.sf.net/sfu/learnnow-**d2d <http://p.sf.net/sfu/learnnow-d2d>

_____________****
Geoserver-devel mailing list
Geoserver-devel@anonymised.comsourceforge.net <http://sourceforge.net><
Geoserver-devel@**lists.sourceforge.net<Geoserver-devel@anonymised.comrge.net>

https://lists.sourceforge.net/****lists/listinfo/geoserver-**devel<https://lists.sourceforge.net/**lists/listinfo/geoserver-devel>
<https://lists.**sourceforge.net/lists/**listinfo/geoserver-devel<https://lists.sourceforge.net/lists/listinfo/geoserver-devel>

–

==
Our support, Your Success! Visit http://opensdi.geo-solutions.it for more information.

Dott. Carlo Cancellieri
@cancellieric
Software Engineer

GeoSolutions S.A.S.
Via Poggio alle Viti 1187
55054 Massarosa (LU)
Italy
phone: +39 0584 962313
mobile: +39 3371094494
fax: +39 0584 1660272

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

12

Whoops, that's right, you did say that.

Okay, I took those examples, did some copyediting on them and fixed the Sphinx errors, and added them to the pull request. If it looks good to you, I'll commit on 2.2.x, master, and the newly-created 2.3.x.

Thanks,
Mike Pumphrey
OpenGeo - http://opengeo.org

On 1/30/2013 3:26 AM, carlo cancellieri wrote:

Mike,
Ok looks good, but still missing the curl examples, don't know if you want
to include them; if so, take a look here:
/en/user/source/restconfig/rest-config-examples/rest-config-examples-curl.rst
https://github.com/ccancellieri/geoserver/commit/d437d1544d389030d2c375b47a837cc71095ef4d

Thank you,
Carlo

2013/1/29 Mike Pumphrey <mike@anonymised.com>

Great, I think I have all my questions answered now. Please see
https://github.com/geoserver/**geoserver/pull/126&lt;https://github.com/geoserver/geoserver/pull/126&gt;\.
If no changes are necessary, please accept and port to master as well (or I
can do that). Thanks!

Thanks,
Mike Pumphrey
OpenGeo - http://opengeo.org

On 1/29/2013 2:26 AM, carlo cancellieri wrote:

Hi Mike,

  see inline.

I have a few additional questions, but they may be answered when I
actually

try out the software, but I can't seem to find where it is. Some
questions
that come to mind:

* When entering rest/about/manifest.xml?..., what happens when the key
value pair is omitted? The docs don't say.

The default format is [.html] so when you point to rest/about/manifest you
get the same result as per rest/about/manifest.html. You'll get a list of
all the manifest files (with properties) of all the jars loaded by the
classloader.

* Where is the manifest.properties file placed?

It is located into the main jar of the geoserver core. If you want to
change (override) default settings you have to place a copy of that file
(with your changes) into the GeoServer Data dir (root).

* There are two different endpoints in this section, about/manifest, and

about/version. How are they related? What would I call both of them
together? "About" seems a bit non-specific.

When you ask to geoserver (via web gui) for the about page you simply get
the versions of the main used components.
Something like:
------------------------------**-----------------------------

    - Version2.2-SNAPSHOT
    - Git Revision8d37359c56b8cb07d560d6**00fe1cd76db7236619
    - Build Date25-Jan-2013 02:50
    - GeoTools Version8-SNAPSHOT (rev
    d64d6a20e83ed60dc6e5ffea564a0c**38e88ed4d2)
    - ------------------------------**-----------------------------

This is more or less the same of what you get using about/version.
The about/manifest[.format] instead is a more detailed list of version
(with all the loaded libraries) which can be used for reports or to check
configuration programmatically (for example in Continuous Integration).
I added the filter capabilities to be able to filter by core, extensions,
communities and customized jars (in the way I show you in the examples).

It might seem a little slow and laborious, but I've found that this kind

of back-and-forth really helps to make clear, quality documentation. (I'm
documentation lead at OpenGeo.) If you have any questions, please let me
know. I appreciate your help!

I know, documentation really important for software, so no problem Mike,
nice to meet you :slight_smile:

  Also, what version does this about/manifest functionality work against?

I've got 2.2.4 installed, and I don't seem to have that endpoint at all.
Commands like this:
http://localhost:8080/****geoserver/rest/about/manifest.****&lt;http://localhost:8080/**geoserver/rest/about/manifest.**&gt;
xml?key=GeoServerModule&value=****extension<http://localhost:**
8080/geoserver/rest/about/**manifest.xml?key=**GeoServerModule&value=**
extension<http://localhost:8080/geoserver/rest/about/manifest.xml?key=GeoServerModule&value=extension&gt;
>

don't respond with anything other than the generic rest interface. Is
this a 2.3.x feature or did this happen after 2.2.4?

It will be available since 2.2.5 and 2.3.0

Thank you,
Carlo

There's a good chance I just don't follow what's going on. But as long

as
I was (re-)adding documentation, I figured I'd test it out. Thanks.

Thanks,
Mike Pumphrey
OpenGeo - http://opengeo.org

On 1/25/2013 1:34 AM, carlo cancellieri wrote:

Mike,

I'm not excellent at figuring out diffs manually, but looking at that

commit, I see that the primary difference is the "About" section. Did

I
miss something else? Please let me know, and I'll copy the section(s)
back
in.

We are lucky, I used a different commit only for docs.

Looking at the diffs you'll note a new set of files here:
doc/en/user/source/restconfig/****representations/*.txt

And some additions (regarding 'about') to the file:
doc/en/user/source/restconfig/****rest-config-api.rst

That's it.
Cheers,
Carlo

Thanks,
Mike Pumphrey
OpenGeo - http://opengeo.org

On 1/24/2013 6:49 AM, carlo cancellieri wrote:

Hi Mike,

  I think we have missed (cutted off) some pieces of documentation
during
this "Improved / corrected REST documentation (see GEOS-5595)"
refactoring
(regarding the about/version about/manifest improvements):
please take a look to:
on branch 2.2.x - the commit "******619156c0e2a0946b58ea0e3877dfda**
****
806417300d"
  "adding documentation"
on branch master - the commit '******54eebfb03058538e34c47e05f08f24*
*****

50d76a347e'
"adding documentation"

To marge missing part of the documentation.
Cheers,
Carlo

2013/1/23 Justin Deoliveira <jdeolive@anonymised.com>

I think you should be fine here Mike. I think jody is going to be
trying

a

2.3 release again tonight but this shouldn't conflict.

On Tue, Jan 22, 2013 at 11:44 AM, Mike Pumphrey <mike@anonymised.com>
wrote:

This pull request updates /corrects the REST API documentation. I
know

that we are in the middle of a release process, so I just wanted to

ask
(specifically Andrea) if it's okay if I go ahead and merge it in,
or
whether I should wait.

https://github.com/geoserver/********geoserver/pull/111&lt;https://github.com/geoserver/******geoserver/pull/111&gt;
<https:**//github.com/geoserver/******geoserver/pull/111<https://github.com/geoserver/****geoserver/pull/111&gt;
>
<https://**github.com/**geoserver/****geoserver/pull/**111<http://github.com/geoserver/****geoserver/pull/111&gt;
<https://github.com/**geoserver/**geoserver/pull/111&lt;https://github.com/geoserver/**geoserver/pull/111&gt;
**>
>
<https://**github.com/****geoserver/**geoserver/pull/111<http://github.com/**geoserver/**geoserver/pull/111&gt;
**<http://github.com/geoserver/****geoserver/pull/111&lt;http://github.com/geoserver/**geoserver/pull/111&gt;
>
**<https://github.com/**geoserver/**geoserver/pull/111&lt;https://github.com/geoserver/**geoserver/pull/111&gt;
**<https://github.com/geoserver/**geoserver/pull/111&lt;https://github.com/geoserver/geoserver/pull/111&gt;
>

>

Thanks,
Mike Pumphrey
OpenGeo - http://opengeo.org

--

Justin Deoliveira
OpenGeo - http://opengeo.org
Enterprise support for open source geospatial.

------------------------------******--------------------------**
--**--**

------------------
Master Visual Studio, SharePoint, SQL, ASP.NET, C# 2012, HTML5,
CSS,
MVC, Windows 8 Apps, JavaScript and much more. Keep your skills
current
with LearnDevNow - 3,200 step-by-step video tutorials by Microsoft
MVPs and experts. ON SALE this month only -- learn more at:
http://p.sf.net/sfu/learnnow-******d2d&lt;http://p.sf.net/sfu/learnnow-****d2d&gt;
<http://p.sf.net/sfu/**learnnow-**d2d&lt;http://p.sf.net/sfu/learnnow-**d2d&gt;
><
http://p.sf.net/sfu/learnnow-****d2d&lt;http://p.sf.net/sfu/learnnow-**d2d&gt;&lt;
http://p.sf.net/sfu/learnnow-**d2d&lt;http://p.sf.net/sfu/learnnow-d2d&gt;
>
______________________________******_________________
Geoserver-devel mailing list
Geoserver-devel@anonymised.com****source**forge.net <http://sourceforge.net
><
Geoserver-devel@**lists.**sourceforge.net<http://lists.sourceforge.net>
<Geoserver-**devel@lists.sourceforge.net<Geoserver-devel@lists.sourceforge.net>
>
https://lists.sourceforge.net/******lists/listinfo/geoserver-***
*devel<https://lists.sourceforge.net/****lists/listinfo/geoserver-**devel&gt;
<https://lists.**sourceforge.net/**lists/**listinfo/geoserver-devel<https://lists.sourceforge.net/**lists/listinfo/geoserver-devel>
>
<https://lists.**sourceforge.**net/lists/**listinfo/**
geoserver-devel<http://sourceforge.net/lists/**listinfo/geoserver-devel&gt;
<https://lists.**sourceforge.net/lists/**listinfo/geoserver-devel<https://lists.sourceforge.net/lists/listinfo/geoserver-devel>
>