Add a doc explaining available Data Types in OCSF
floydtree opened this issue · 5 comments
Currently, the only way to view all the supported data types in OCSF is via a local instance of the ocsf_server. Instead, we should provide an easy access to it by creating a .md file accessible in the repo.
A simple .md file should suffice.
Once created, link this file in the contribution guideline file - line# 66
The data types are part of the schema. Using a separate file requires to maintain two definitions in two different places, thus they may divert in the future. Instead we should create a public ocsf_server and keep schema and related docs together.
If we are creating a public ocsf server and making it available before the public release, then great. If not, then I would argue we should maintain an easily accessible file in the repo. Also, how often do you suspect we'll change the data types?
Hopefully, not that often if not at all.
Appendix A in the white paper has the data types as listed in the browser. Also, Appendix C includes the CONTRIBUTING.md text (with some small modifications for the document format etc.). Do we need a separate doc? I can extract the Appendix A into a separate doc if that is what is wanted.
Now that we have a public server running, I think we can link to the data types section in the browser itself. I'll update the contribution guide with the links and close out this issue