Usage of HAL

[dmlb2000]

Pacifica Metadata version

0.10.0

Pacifica Core Software versions

1.0

Platform Details

Any

Scenario:

Attempting to use the REST API is not standard...

• Order of attributes in JSON objects should correspond to sort-order of fields in records #76
• Adhere to RESTful Web Services conventions #86
• White-list query parameters #87

If we try and use a specification like http://stateless.co/hal_specification.html we can offload all the implementation details to a library that can standardize on these features. This would be a good 2.0 API change that would resolve the issues above and others not mentioned yet.

Some implementations to consider...

• https://github.com/vertical-knowledge/ripozo
• https://pypi.org/project/Flask-HAL/
• https://pypi.org/project/halogen/

Seems like CherryPy might be lacking in integrations with these standards. Flask seems to have a lot more glue codes written to SQLAlchemy to support the object REST API for the model...