From 8dfab883a55798fef1cf8da41b4b9f9ba6b1d734 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cristi=20V=C3=AEjdea?= Date: Sun, 14 Oct 2018 20:43:26 +0300 Subject: [PATCH] Add 1.11.0 changelog --- docs/changelog.rst | 17 +++++++++++++++++ docs/custom_ui.rst | 4 ++++ 2 files changed, 21 insertions(+) diff --git a/docs/changelog.rst b/docs/changelog.rst index e676708..0047049 100644 --- a/docs/changelog.rst +++ b/docs/changelog.rst @@ -3,6 +3,23 @@ Changelog ######### +********** +**1.11.0** +********** + +*Release date: TBD* + +- **ADDED:** ``PERSIST_AUTH``, ``REFETCH_SCHEMA_WITH_AUTH``, ``REFETCH_SCHEMA_ON_LOGOUT`` + settings and related javascript implementation for persisting authentication data to swagger-ui localStorage +- **IMPROVED:** UI-enabled views will now no longer generate the full specification document twice; the HTML part + of the view will only generate a barebones ``Swagger`` object with no ``paths`` and ``definitions`` +- **IMPROVED:** added the ``FETCH_SCHEMA_WITH_QUERY`` setting to enable fetching of the schema document using + query parameters passed to the UI view (:issue:`208`) +- **IMPROVED:** added support for the very common ``x-nullable`` extension (:issue:`217`) +- **IMPROVED:** extensibility of some classes was improved by adding more extension points, together with more blocks + for ``swagger-ui.html``/``redoc.html`` and some JavaScript hooks in ``swagger-ui-init.js`` +- **FIXED:** removed usage of ``inspect.signature`` on python 2.7 (:issue:`222`) + ********** **1.10.2** ********** diff --git a/docs/custom_ui.rst b/docs/custom_ui.rst index 31da547..5e9dc5f 100644 --- a/docs/custom_ui.rst +++ b/docs/custom_ui.rst @@ -7,5 +7,9 @@ The web UI can be customized using the settings available in :ref:`swagger-ui-se You can also extend one of the `drf-yasg/swagger-ui.html`_ or `drf-yasg/redoc.html`_ templates that are used for rendering. See the template source code (linked above) for a complete list of customizable blocks. +The ``swagger-ui`` view has some quite involed JavaScript hooks used for some functionality, which you might also +want to review at `drf-yasg/swagger-ui-init.js`_. + .. _drf-yasg/swagger-ui.html: https://github.com/axnsan12/drf-yasg/blob/master/src/drf_yasg/templates/drf-yasg/swagger-ui.html +.. _drf-yasg/swagger-ui-init.js: https://github.com/axnsan12/drf-yasg/blob/master/src/drf_yasg/static/drf-yasg/swagger-ui-init.js .. _drf-yasg/redoc.html: https://github.com/axnsan12/drf-yasg/blob/master/src/drf_yasg/templates/drf-yasg/redoc.html