Update 'Tech Spec'

master
mj-saunders 2022-03-26 18:13:00 +00:00
parent 146ce822aa
commit 3c673eae34
1 changed files with 4 additions and 4 deletions

@ -20,7 +20,7 @@ All the functionality will be implemented as standalone XWiki Module/Plugins tha
* OGB API specification for v1.0 * OGB API specification for v1.0
* A build system that fully builds a working OGB from source code * A build system that fully builds a working OGB from source code
* A simple to install prebuilt set of container images than can be deployed and run in minutes on popular personal and cloud platforms * A simple to install prebuilt set of container images than can be deployed and run in minutes on popular personal and cloud platforms
* A OGB developer community running on the soon to be federated[] [][http://unite.openworlds.info]([]http://unite.openworlds.info[]) * An OGB developer community running on the soon to be federated [http://unite.openworlds.info](http://unite.openworlds.info)
@ -289,7 +289,7 @@ To run a private implementation of OGB, it must be run on an intranet, firewalle
All API will be REST (REpresentational State Transfer). All API will be REST (REpresentational State Transfer).
See Wikipedia:[] [][https://en.wikipedia.org/wiki/Representational\_state\_transfer]([]https://en.wikipedia.org/wiki/Representational\_state\_transfer[]) See Wikipedia: [https://en.wikipedia.org/wiki/Representational\_state\_transfer](https://en.wikipedia.org/wiki/Representational\_state\_transfer)
The following table shows how HTTP methods are intended to be used in HTTP APIs, including RESTful ones. The following table shows how HTTP methods are intended to be used in HTTP APIs, including RESTful ones.
@ -321,7 +321,7 @@ To be designed during project kickoff
## **NFR (Non Functional Requirements)** ## NFR (Non Functional Requirements)
@ -433,6 +433,6 @@ The definitions and naming that we use in this document are not actually the fin
### **Team Members** ### Team Members
Tom, Hamish, Michael, one programmer yet to be employed Tom, Hamish, Michael, one programmer yet to be employed