Procházet zdrojové kódy

Note breaking changes re: API schema

jeremystretch před 2 roky
rodič
revize
bfd8e012dc
1 změnil soubory, kde provedl 4 přidání a 0 odebrání
  1. 4 0
      docs/release-notes/version-3.5.md

+ 4 - 0
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 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 `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 `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
 ### New Features