#761 Document how Dogtag is using REST
Closed: migrated by dmoluguw. Opened by awnuk.

Document how Dogtag is using REST by providing:

  • elected file naming convention connecting resources, services, etc
  • description of used annotations
  • elected conventions of data marshaling
  • description of data flow and services
  • description of request dispatching
  • lots of samples illustrating elected conventions and methods

This will speed up adoption of Dogtag's REST interface.


[06/04/2014] - Moving to Milestone 10.2.3 due to schedule restrictions.

Current documentation: http://pki.fedoraproject.org/wiki/RESTEasy

proposed Milestone: 10.2.3 - Per Dogtag 10.2.3 meeting of 09/25/2014

Per Dogtag 10.2.X meeting of 01/14/2015: Milestone 10.2 Backlog

Metadata Update from @awnuk:
- Issue set to the milestone: 10.3.1

There are two documents involved:
- REST API documentation: This doc should be auto generated from the code (like javadoc). The doc should be included in the distribution.
- REST programming guide: This doc should be written as wiki pages. This should include the items mentioned in the original ticket description. RHBZ #1137037 depends on this.

Metadata Update from @edewata:
- Custom field feature adjusted to ''
- Custom field proposedmilestone adjusted to FUTURE
- Custom field proposedpriority adjusted to ''
- Custom field reviewer adjusted to ''
- Custom field version adjusted to ''
- Issue status updated to: Open (was: Closed)

Metadata Update from @mharmsen:
- Custom field rhbz reset (from 0)
- Custom field type adjusted to task (was: enhancement)

Metadata Update from @mharmsen:
- Issue set to the milestone: 1.0 TASKS (was: 10.3.1)

Dogtag PKI is moving from Pagure issues to GitHub issues. This means that existing or new
issues will be reported and tracked through Dogtag PKI's GitHub Issue tracker.

This issue has been cloned to GitHub and is available here:
https://github.com/dogtagpki/pki/issues/1328

If you want to receive further updates on the issue, please navigate to the
GitHub issue and click on Subscribe button.

Thank you for understanding, and we apologize for any inconvenience.

Metadata Update from @dmoluguw:
- Issue close_status updated to: migrated
- Issue status updated to: Closed (was: Open)

Metadata