kb-API Project PR - READY

[alshapton]

What does this implement/fix? Explain your changes.

• ADD: Added kbAPI as a Docker container so it can run as a service inside a container
• ADD: View by ID function
• ADD: View by name function
• ADD: View by title function
• ADD: Created INTERNALS.md
• ADD: Initial Security model
• ADD: Initial Search API
• ADD: Completed add API.
• ADD: Initial cut of Update API
• ADD: export API
• ADD: delete API
• ADD: erase API
• ADD: version API
• ADD : view API
• ADD: HTTP Status 405 for "Method never Allowed" for "edit" API ~ADD: HTTP Status 405 for not yet implemented methods (in the interim period)~
• ADD: Features of Template API as detailed here
• ADD: completed search API
• ADD: Ingest API
• DEV: Updated documentation
• DEV: Correcting MIME types
• DEV: Separated out the CLI Docker container so it can run concurrently with the server component
• DEV: Updated the README-SERVER.md
• DEV: Restructured and rationalised JSON responses
• DEV: Included POSTMAN collection for examples
• DEV: Rationalised and cleaned code and more and more
• DEV: /get/ and /view/ are synonyms
• BUG: Corrected small bug in ADD
• BUG: Corrected occasional incorrect HTTP response issue in add

Does this close any currently open issues?

No, however, it does address items in the kbAPI project as specified above.

Any relevant logs, error output, etc?

None

Any other comments?

Updating the architecture of the code as per this comment

Where has this been tested?

Operating System: MacOS Catalina 10.15.7

Platform: Python 3.8.5 Docker 19.03.13 Docker-compose 1.27.4 Flask 1.1.2

[gnebbia]

OK cool! I think we still need to really separate the action functionality from the command functionality as possible... I mean, I expect the add command to be really small, since it should take advantage of the add functionality. I don't know if my explanation is clear... I mean, it would be cool to have most of the add functionality in the add action, since that's the core logic, while the add command should be really small and just calling the add action and probably some checks for the command line flags, nothing more.