From 1ad7df976bfff2ed96aee565392421bb5bf66fb3 Mon Sep 17 00:00:00 2001 From: Kyle McFarland Date: Mon, 22 Oct 2018 07:08:36 -0600 Subject: Add NEWS.md describing the project updates --- NEWS.md | 57 +++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 57 insertions(+) create mode 100644 NEWS.md (limited to 'NEWS.md') diff --git a/NEWS.md b/NEWS.md new file mode 100644 index 0000000..91f8fb5 --- /dev/null +++ b/NEWS.md @@ -0,0 +1,57 @@ +# NEWS + +## New in version 0.2 (git) + +NOTE: Version 0.2 updates the database schema, make sure to run: + +$ `python manage.py migrate` + +or manually specify the newest migration for the procurement system with: + +$ `python manage.py migrate 0002_add_representative` + +To update the database. + +### Admin Interface + +You may now create multiple representatives for each supplier either in the +Suppliers admin panel for each Supplier or in the new Representatives +admin panel, currently only name and email are stored for each representative +but more information can be added in future commits. + +### User Interface + +The Component Search results now display multiple representatives for each +supplier as additional lines below the supplier's first representative. + +An extra View Suppliers page has been added that allows you to view the +details for a given Supplier, which currently just lists the representatives' +contact information and a list of parts the supplier provides. + +### API + +`supplier.representative_name` and `supplier.representative_email` have been +removed from the API and replaced by a list of objects +`supplier.representatives` which each contain name and email attributes. + +3 new endpoints have been added: + +* `api/supplier`: returns a list of all supplier objects in the system +* `api/supplier/`: returns just the supplier with the given id +* `api/supplier//components`: returns a slightly different supplier + object that contains a list of components they supply (the returned + component objects don't contain recursive objects to all of the + suppliers that provide them, just contains a list of their ids) + +### Database + +A Representative model has been added to allow for suppliers to have multiple +representatives, it just uses a ForeignKey relationship with a Supplier to +associate them. Currently it just contains name and email fields but more can +be added. + +### Bug Fixes/Internal + +* `class="active"` is now set on the active page in the navigation menu, + previously it wasn't due to the case of the page_name + -- cgit v1.1