Skip to content

docs: split responses usage guide into sub-pages #4919

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
Brohammad wants to merge 6 commits into from
Closed

docs: split responses usage guide into sub-pages #4919

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
ab0625a
docs: split responses usage guide into sub-pages
Brohammad Jul 13, 2026
561a72f
Merge branch 'main' into docs/split-responses-section
Brohammad Jul 13, 2026
a2cb867
docs: preserve legacy responses page URL
Brohammad Jul 13, 2026
f5e0d2e
docs: simplify legacy responses redirect stub
Brohammad Jul 13, 2026
1cf8479
Merge branch 'main' into docs/split-responses-section
Brohammad Jul 14, 2026
b828252
Merge branch 'main' into docs/split-responses-section
Brohammad Jul 15, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/onboarding/fastapi.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -411,7 +411,7 @@ and ``headers=`` when the values depend on the request.

.. seealso::

* :ref:`Responses - Setting Response Cookies <usage/responses:setting response cookies>`
* :ref:`Responses - Setting Response Cookies <usage/responses/headers_and_cookies:Setting Response Cookies>`


Serialization
Expand Down
6 changes: 3 additions & 3 deletions docs/onboarding/flask.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -418,8 +418,8 @@ and ``headers=`` when the values depend on the request.

.. seealso::

* :ref:`Responses - Setting Response Headers <usage/responses:setting response headers>`
* :ref:`Responses - Setting Response Cookies <usage/responses:setting response cookies>`
* :ref:`Responses - Setting Response Headers <usage/responses/headers_and_cookies:Setting Response Headers>`
* :ref:`Responses - Setting Response Cookies <usage/responses/headers_and_cookies:Setting Response Cookies>`


Serialization
Expand Down Expand Up @@ -463,7 +463,7 @@ defaults.


.. seealso::
:ref:`usage/responses:media type`
:ref:`usage/responses/media_types_and_status_codes:Media Type`



Expand Down
8 changes: 4 additions & 4 deletions docs/release-notes/2.x-changelog.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2040,7 +2040,7 @@
return ServerSentEvent(my_generator())

.. seealso::
:ref:`Server Sent Events <usage/responses:Server Sent Event Responses>`
:ref:`Server Sent Events <usage/responses/special_responses:Server Sent Event Responses>`


.. change:: SQLAlchemy repository: allow specifying ``id_attribute`` per method
Expand Down Expand Up @@ -3655,7 +3655,7 @@
HTTP header, offering basic content negotiation.

.. seealso::
:ref:`usage/responses:Content Negotiation`
:ref:`usage/responses/returning_responses:Content Negotiation`

.. change:: Enhanced WebSockets support
:type: feature
Expand Down Expand Up @@ -4159,8 +4159,8 @@
:breaking:
:pr: 1209

:ref:`response headers <usage/responses:Setting Response Headers>` and
:ref:`response cookies <usage/responses:Setting Response Cookies>` now have the
:ref:`response headers <usage/responses/headers_and_cookies:Setting Response Headers>` and
:ref:`response cookies <usage/responses/headers_and_cookies:Setting Response Cookies>` now have the
same interface, along with the ``headers`` and ``cookies`` keyword arguments to
``starlite.response.Response``. They each allow to pass either a
`:class:`Mapping[str, str] <typing.Mapping>`, e.g. a dictionary, or a :class:`Sequence <typing.Sequence>` of
Expand Down
10 changes: 5 additions & 5 deletions docs/usage/applications.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -251,19 +251,19 @@ Parameters that support layering are:
* :ref:`after_request <after_request>`
* :ref:`after_response <after_response>`
* :ref:`before_request <before_request>`
* :ref:`cache_control <usage/responses:cache control>`
* :ref:`cache_control <usage/responses/headers_and_cookies:Cache Control>`
* :doc:`dependencies </usage/dependency-injection>`
* :doc:`dto </usage/dto/0-basic-use>`
* :ref:`etag <usage/responses:etag>`
* :ref:`etag <usage/responses/headers_and_cookies:ETag>`
* :doc:`exception_handlers </usage/exceptions>`
* :doc:`guards </usage/security/guards>`
* :ref:`include_in_schema <usage/openapi/schema_generation:configuring schema generation on a route handler>`
* :doc:`middleware </usage/middleware/index>`
* :ref:`opt <handler_opts>`
* :ref:`request_class <usage/requests:custom request>`
* :ref:`response_class <usage/responses:custom responses>`
* :ref:`response_cookies <usage/responses:setting response cookies>`
* :ref:`response_headers <usage/responses:setting response headers>`
* :ref:`response_class <usage/responses/special_responses:Custom Responses>`
* :ref:`response_cookies <usage/responses/headers_and_cookies:Setting Response Cookies>`
* :ref:`response_headers <usage/responses/headers_and_cookies:Setting Response Headers>`
* :doc:`return_dto </usage/dto/0-basic-use>`
* ``security``
* ``tags``
Expand Down
2 changes: 1 addition & 1 deletion docs/usage/index.rst
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,7 @@ Usage
applications
routing/index
requests
responses/index
Comment thread
Brohammad marked this conversation as resolved.
caching
channels
cli
Expand All @@ -24,7 +25,6 @@ Usage
middleware/index
openapi/index
plugins/index
responses
security/index
static-files
custom-types
Expand Down
Loading