collective.opendata 1.0a2

A generic implementation of the Open Data Protocol for Plone.

collective.opendata

Content

• collective.opendata

  • Introduction

  • Features

  • Creation

  • Translations

  • Contribute

  • Support

  • License

  • Mostly Harmless

• Contributors

• Changelog

  • 1.0a2 (2015-08-26)

  • 1.0a1 (2015-08-07)

Introduction

A generic implementation of a pluggable open data package for Plone.

The Plone Open Data API.

Features

This package have by default two (02) open data pluggable as the following:

CMS

A plugin for information about the CMS used in this portal.

• site_info: Information about a portal.

This plugin generate a JSON format from the base API URL: http://localhost:8080/Plone/apidata/cms

[{
    "uri": "http://localhost:8080/Plone/apidata/cms/site_info",
    "description": "Information about a portal",
    "entity": "site_info"
}]

A JSON format for Information site, like this:

{
  "software": "collective.opendata",
  "description": "",
  "software_version": "0.1",
  "title": "Site"
}

Content Metadata

A plugin for content information.

• News Item: Dublin Core info for News Item.

• Image: Dublin Core info for Image.

• File: Dublin Core info for File.

• Folder: Dublin Core info for Folder.

• Document: Dublin Core info for Document.

• Event: Dublin Core info for Event.

This plugin generate a JSON format from the base API URL: http://localhost:8080/Plone/apidata/content

[
  {
    "uri": "http://localhost:8080/Plone/apidata/content/News Item",
    "description": "Dublin Core info for News Item",
    "entity": "News Item"
  },
  {
    "uri": "http://localhost:8080/Plone/apidata/content/Image",
    "description": "Dublin Core info for Image",
    "entity": "Image"
  },
  {
    "uri": "http://localhost:8080/Plone/apidata/content/File",
    "description": "Dublin Core info for File",
    "entity": "File"
  },
  {
    "uri": "http://localhost:8080/Plone/apidata/content/Folder",
    "description": "Dublin Core info for Folder",
    "entity": "Folder"
  },
  {
    "uri": "http://localhost:8080/Plone/apidata/content/Document",
    "description": "Dublin Core info for Document",
    "entity": "Document"
  },
  {
    "uri": "http://localhost:8080/Plone/apidata/content/Event",
    "description": "Dublin Core info for Event",
    "entity": "Event"
  }
]

A JSON format for Folder content type, like this:

[
  {
    "title": "News",
    "identifier": "http://localhost:8080/Plone/news",
    "uid": "07997a0ee8f14414bfcf8c146cc865f2",
    "uri": "http://localhost:8080/Plone/apidata/content/Folder/07997a0ee8f14414bfcf8c146cc865f2"
  },
  {
    "title": "Events",
    "identifier": "http://localhost:8080/Plone/events",
    "uid": "bf5aafa2c7224eb5935d174c1a9a43ff",
    "uri": "http://localhost:8080/Plone/apidata/content/Folder/bf5aafa2c7224eb5935d174c1a9a43ff"
  },
  {
    "title": "Users",
    "identifier": "http://localhost:8080/Plone/Members",
    "uid": "761536d101414a47bc0e5494f51d97f1",
    "uri": "http://localhost:8080/Plone/apidata/content/Folder/761536d101414a47bc0e5494f51d97f1"
  }
]

Creation

This product was created by the PloneGov-BR community in a sprint at Interlegis:

http://www.softwarelivre.gov.br/plone

Special thanks to Érico Andrei!

Translations

This product has been translated into

• Portuguese (thanks, Jean Ferri)

• Spanish (thanks, Leonardo J. Caballero G.)

Contribute

• Issue Tracker: http://github.com/plonegovbr/collective.opendata/issues

• Source Code: http://github.com/plonegovbr/collective.opendata

• Website: http://plone.org.br

Support

If you are having issues, please let us know, submit a ticket with the report http://github.com/plonegovbr/collective.opendata/issues

License

The project is licensed under the GNU General Public License v2 (GPLv2).

---

Mostly Harmless

Contributors

• Augusto Herrmann

• Cintia Cinquini

• Érico Andrei

• Jean Ferri

• Héctor Velarde

• Leonardo Caballero

• Nitai Bezerra

Changelog

1.0a2 (2015-08-26)

• Rename pt translation to pt_BR [jeanferri]

• Fix translations [jeanferri]

• Workaround to avoid scape msgid on /apidata/content description [jeanferri]

• Fix a bug with content types were the name have spaces [jeanferri]

• Improve dublin core support for content metadata. [jeanferri]

• Reformat API documentation page. [jeanferri]

1.0a1 (2015-08-07)

• Add Portuguese translation. [jeanferri]

• Fix content type from Page to Document. [jeanferri]

• Prepare for release on pypi. [jeanferri]

• Updated README file with usefull information about this package. [macagua]

• Added Spanish translation. [macagua]

• Added i18n support. [macagua]

• Initial release. [ericof]