From bfd8e012dc8a8c2e3412c86931aa30ac6d018931 Mon Sep 17 00:00:00 2001 From: jeremystretch Date: Thu, 30 Mar 2023 14:36:02 -0400 Subject: [PATCH] Note breaking changes re: API schema --- docs/release-notes/version-3.5.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/docs/release-notes/version-3.5.md b/docs/release-notes/version-3.5.md index 2558b49f0..ddbc7a075 100644 --- a/docs/release-notes/version-3.5.md +++ b/docs/release-notes/version-3.5.md @@ -7,6 +7,10 @@ * The JobResult model has been moved from the `extras` app to `core` and renamed to Job. Accordingly, its REST API endpoint has been moved from `/api/extras/job-results/` to `/api/core/jobs/`. * The `obj_type` field on the Job model (previously JobResult) has been renamed to `object_type` for consistency with other models. * The `JOBRESULT_RETENTION` configuration parameter has been renamed to `JOB_RETENTION`. +* The REST API schema is now generated using the OpenAPI 3.0 spec +* The URLs for the REST API schema documentation have changed: + * `/api/docs/` is now `/api/schema/swagger-ui/` + * `/api/redoc/` is now `/api/schema/redoc/` ### New Features