[API] Endpoint: Snapshot [global] [GET - 200]

[JFQueralt]

The current v1.0 implementation does not allow to centrally manage the global and module-specific application variables.
It also doesn't allow to extract the necessary information to render different DSLs on demand.

For full context on this issue, check its related Epic #64

💡 Proposed solution

Implement an API that will provide with the following services as described below.

Endpoint documentation

Find all details on Usage, Parameters, Consumers and Responses here:
https://theiofoundation.stoplight.io/docs/projectlockdown/API/Reference/Project-Lockdown.v1.json/paths/~1Snapshots~1%7BSnapshotUID%7D~1%7BModule%7D~1%7BDateStart%7D~1%7BDateEnd%7D~1%7BDSLUID%7D/get

Definition of Done

• Response Codes: 200
• Deployed to production server (manually done until [CI] create deployment pipeline for API code #314)
• Requests are cached to limit impact on servers/database
• Response is provided in JSON format, but has option to add other formats in the future
• Basic unit tests on the code

📚 Resources

Project documentation

• General Project considerations: Project Wiki
• Project Architecture: Project Wiki
• Getting Started with PLD APIs: Project Wiki
• Data Lifecycle: Project Wiki

API Technical documentation

• API reference (includes mock server): Stoplight
• JSON Models reference (schemas): Stoplight

Note: For full documentation reference and proposed tools please check the corresponding Epic.

[jeff-knurek]

While the Documentation is being updated to be more streamline, and the frontend had already created a mock api response to use the data, here is the example of what the response content should look like:
https://github.com/TheIOFoundation/ProjectLockdown/blob/master/MAP/public/data/snapshot.json