API Spec details

[rdminfinity]

Following up on the conversation on the MVDBMS group about implementing a non-accuterm version of the API Spec per @pschellenbach recommendation.

We would really like to help out with this if possible and start a discussion on the specs that are needed.

[pschellenbach]

Awesome!

Have you looked at the docs here in the repo? Its pretty much a CRUD API, with a few niceties to compile, catalog, etc. There is a Postman example to help debug. The only thing that might be confusing in the example is the Authorization token. This is returned by the login function, and passed to all the other functions. In AccuTerm's implementation, the token encodes the parameters needed to connect to the server through AccuTerm. Which is useful if multiple AccuTerm sessions are connected to different servers. Other implementations are free to use it as needed.

Also, one abstraction we made in the spec is to convert the Pick record structure into a nested Javascript array for attributes, values, sub-values. This way we do not need to do any delimiter handling at the API level. We never properly implemented the mark characters in the extension itself. Currently value & sub-value marks are converted into 0xF8FD and 0xF8FC when unpacking the nested arrays. We were looking at the idea of some sort of ligature API to render the marks using conventional "]" and "" characters with some sort of highlighting to differentiate them.

To aid your development it might be useful to have a copy of AccuTerm to use as a reference.

[itsxallwater]

Adding links to the files Pete mentioned, specifically MV REST File System API.md and MV REST File System.postman_collection.json