Wiki Spaces

Documentation
Projects
Resources

Get Help from Others

Q&A: Ask OpenMRS
Discussion: OpenMRS Talk
Real-Time: IRC Chat | Slack

Documentation

Page tree

Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: corrected the incorrect url to the live documentation

...

  1. Model getGETModel(Representation)                                                                                                                                                                                                                                                                                                A resource that supports GET operations such as 'getAll', 'getByUniqueId', and 'search'' should override this method.                                                                                                                                     
  2. Model getCREATEModel(Representation)                                                                                                                                                                                                                                                                                        A resource that supports CREATE operations should override this method.
  3. Model getUPDATEModel(Representation)                                                                                                                                                                                                                                                                                        A resource that supports UPDATE operations should override this method.

...

You do not need to override these methods. However, if not, then their proper definitions won't appear in OpenMRS Swagger specification. Thus the resource won't show up in the live documentation here either.  (while the live demo swagger documentation can be found inside the advanced system adminstration section of the reference application on the demo server) either.

So it's recommended that you override these.

How to find which properties to be documented?

 getGETModelgetGETModel(Representation), getCREATEModel(Representation), and getUPDATEModel(Representation) methods correspond to getGetRepresentation(), getCreatableProperties(), and getUpdatableProperties() methods respectively. So they can be used as reference when documenting resources.

...