Skip to content

GNIP 18 GeoNode API

jj0hns0n edited this page Jan 9, 2012 · 1 revision

GNIP 18 - GeoNode API

Overview

It is proposed to develop a formal API for GeoNode sites that will be used both internally by a GeoNode and available for external applications to make use of.

It should endpoints include the following:

  • CRUD for Data
  • CRUD for Maps
  • CRUD for Profiles
  • CRUD for Additional Modules (i.e. social features)
  • Search
  • Changing Permissions
  • much more

Proposed By

Jeffrey Johnson

Assigned to Release

TBD

State

For Review and Comment

Motivation

GeoNode currently has a sort of ad-hoc API endpoints that it uses internally to render the site and perform other tasks. This 'api' has not been developed or documented in any kind of a formal way and as such is not easily useable by external applications. Many GeoNode users have expressed an interest in having a formalized API that could be used to develop things like a plugin for desktop GIS programs like ArcMap or qGIS and for other purposes.

Proposal

The following is proposed:

  • Review and document the current 'ad-hoc' api.
  • Document functionality that is not currently in the Ad Hoc api and that would be needed in a formal API
  • Develop a specification for the new formal GeoNode API and review this with relevant stakeholders
  • Refactor the ad-hoc API to follow the newly developed specification
  • Develop new api endpoints as required
  • Review and refactor as necessary

Issues

TODO: Many

Testing

Developing unit and integration tests for each endpoint must be a key part of work under this proposal. Coverage should be improved.

Alternatives

Do nothing. GeoNode's current Ad Hoc API works as is for the functionality it needs to provide.

Feedback

Voting

Clone this wiki locally