CHANGELOG.md

Changelog

All notable changes to this project will be documented in this file.

The format is based on Keep a Changelog, and this project adheres to Semantic Versioning.

[1.3.0] - 2022-12-19

Added

• Add Grades model
• Add some incomplete AWS API Gateway/Lambda/Aurora Serverless RDS deployment documentation.
  • Includes configuring AWS API Gateway to do preliminary OAuth2 scope validation.
• Attempt at Jenkins configuration for our local CI/CD. Currently not working.
• Experiment with a non Model-based endpoint. (Incomplete)
• Extende DOT with swappable dependencies for OIDC.

Deprecated

• Remove sphinx documentation, instead using mkdocs.

Changed

• Bump to Django 4.x which requires a new minimum Python version.

Fixed

• oauth: different python versions return a different type for compiled re: use isinstance.

[1.2.0] - 2021-06-25

Added

• Add use of local django-oauth-toolkit as an optional OAuth2/OIDC Authorization Server
• Add OAS schema security objects for oauth-dev.cuit.columbia.edu (local Vagrant PingFederate server)
• Experiment with backstage.io for project/API documentation

Changed

• Reimplement OIDC claims checking for either an external AS or internal DOT 1.5.0 OIDC server
• Change required SLA scope to demo-djt-sla-bronze
• Switch documentation generation from Sphinx to Mkdocs (for backstage.io)
• Update to OAS 3.0 schema generation using DRF 3.12.1 and DJA 4.0.0

[1.1.0] - 2020-11-04

Added

• Automated openapi schema generation

[1.0.1] - 2020-05-14

Fixed

• Properly prevent a non-authenticated user from doing a write

[1.0.0] - 2020-05-14

Added

• Use of OIDC 2.0 Claims for view permission

Changed

• Updated required scopes to include an SLA scope.

[0.2.6] - 2020-05-11

Deprecated

• Use of Microsoft SQL Server.
• (temporarily) removed OAS 3.0 schema document generation

Changed

• Switched to all-python PyMySQL library.

[0.2.5] - 2019-06-27

Added

• Automated OAS 3.0 schema document generation
• Added some model field validators

[0.2.4] - 2018-04-26

Added

• jsonapi_demo_cli command-line demonstration client.
• docker build
• OAS 3.0 schema
• Added Swagger-UI at /openapi per this article

Deprecated

Changed

Fixed

• browseable api for courses raised an exception when related course was none.
• upgrade to Django 2.1.7 due to CVE-2019-6975.
• GET /people/?filter[search]=... 500 error.

[0.2.3] - 2018-12-06

Added

• Added a Person model
• Documentation is now available at https://columbia-it-django-jsonapi-training.readthedocs.io

Changed

• Instructor model is now OneToOne with Person model.

Fixed

• I misunderstood one of the SQL Server errors as complaining about a column name when it wasn't. This is fixed with migration 0007....

[0.2.2] - 2018-12-03

Added

• sphinx RTD configuration:
  • Run tox and then open docs/build/html/index.html in your local browser.
  • MyApp API autodoc.

Deprecated

• No longer need myapp/overridden_migrations (see Fixed).

Changed

• Split outline.md into individual chapter files: See index.md.

Fixed

• created PR for django-pyodbc-azure that elminates need for Microsoft SQL Server workarounds.

[0.2.1] - 2018-11-20

Added

• Workarounds for Microsoft SQL Server
  • TextFields can't be unique. Use Charfield.
  • "name" is a reserved word. Change the db_column so that we can keep using it in our code.
  • Can't change AutoField to BigAutoField.
  • Non-ANSI SQL implementation of NULL UNIQUE See the docs.

[0.2.0] - 2018-11-14

Added

• Instructor Model with ManyToMany relationship to CourseTerm. See docs

[0.1.1] - 2018-11-09

Added

• Document Modifying our DJA Project with CourseTerm fix as the example.

Fixed

• Make CourseTerm.term_identifier unique, char(14) and fix fixtures, etc. to match.

[0.1.0] - 2018-10-31

Added

• Initial release