Verified Commit e1f6efba authored by Dan Jones's avatar Dan Jones
Browse files

docs: update README and CHANGELOG

parent f0cfca9b
......@@ -7,6 +7,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
## [Unreleased]
### Changed
- Updated README to run tests against JS dependencies
## [v0.2.0] - 2024-02-06
### Added
......@@ -15,9 +19,10 @@ and this project adheres to [Semantic Versioning](http://semver.org/spec/v2.0.0.
- Emergency flag in mission plan schemas
- Added additional battery and fuel fields to platform status for SPINE project
### Changed
### Changed
- Updated README to run tests against JS dependencies
- Refactor schema script to remove invalid definitions object automatically
- Refactor generate_schema_config script to output file on -f flag
## [v0.1.0] - 2023-03-24
......
......@@ -72,12 +72,10 @@ eg
## Run Docs & Save Schema When Updating Message Formats
1. Run the command below and go to `http://127.0.0.1:5000`
```
python3 generate_schema_config.py
python3 generate_schema_config.py -f
```
2. Copy the schema generated `http://127.0.0.1:5000/soar_protocol.json` into the `backbone-message-format/project/<project_name>/swagger.json`
3. In the json copied, remove the key `"definitions"` from the schema and save this.
2. Commit any changes to the `backbone-message-format/project/<project_name>/swagger.json`
## Run Tests
Run both tests below:
......
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment