From ba692917403d1f427f589f67c48a294423cf200b Mon Sep 17 00:00:00 2001 From: Bruno Alla Date: Mon, 31 Mar 2025 15:24:34 +0100 Subject: [PATCH] Deployed ffadde93 with MkDocs version: 1.6.0 --- api-guide/fields/index.html | 2 +- api-guide/throttling/index.html | 2 +- api-guide/validators/index.html | 2 +- community/contributing/index.html | 17 --- community/project-management/index.html | 1 - community/third-party-packages/index.html | 4 +- search/search_index.json | 2 +- sitemap.xml | 140 +++++++++++----------- sitemap.xml.gz | Bin 771 -> 771 bytes 9 files changed, 76 insertions(+), 94 deletions(-) diff --git a/api-guide/fields/index.html b/api-guide/fields/index.html index 6e32af684..8575506d9 100644 --- a/api-guide/fields/index.html +++ b/api-guide/fields/index.html @@ -1020,7 +1020,7 @@ Django's regular validators documentation.

-

Note: HiddenField() does not appear in partial=True serializer (when making PATCH request). This behavior might change in future, follow updates on github discussion.

+

Note: HiddenField() does not appear in partial=True serializer (when making PATCH request).

ModelField

A generic field that can be tied to any arbitrary model field. The ModelField class delegates the task of serialization/deserialization to its associated model field. This field can be used to create serializer fields for custom model fields, without having to create a new custom serializer field.

diff --git a/api-guide/throttling/index.html b/api-guide/throttling/index.html index e8d9c4d61..a647a6344 100644 --- a/api-guide/throttling/index.html +++ b/api-guide/throttling/index.html @@ -569,7 +569,7 @@ class CustomAnonRateThrottle(AnonRateThrottle):

You'll need to remember to also set your custom throttle class in the 'DEFAULT_THROTTLE_CLASSES' settings key, or using the throttle_classes view attribute.

A note on concurrency

The built-in throttle implementations are open to race conditions, so under high concurrency they may allow a few extra requests through.

-

If your project relies on guaranteeing the number of requests during concurrent requests, you will need to implement your own throttle class. See issue #5181 for more details.

+

If your project relies on guaranteeing the number of requests during concurrent requests, you will need to implement your own throttle class.

API Reference

AnonRateThrottle

diff --git a/api-guide/validators/index.html b/api-guide/validators/index.html index fb0b2c3ec..bea487dfe 100644 --- a/api-guide/validators/index.html +++ b/api-guide/validators/index.html @@ -639,7 +639,7 @@ class ExampleSerializer(serializers.Serializer):

Note: The UniqueFor<Range>Validator classes impose an implicit constraint that the fields they are applied to are always treated as required. Fields with default values are an exception to this as they always supply a value even when omitted from user input.

-

Note: HiddenField() does not appear in partial=True serializer (when making PATCH request). This behavior might change in future, follow updates on github discussion.

+

Note: HiddenField() does not appear in partial=True serializer (when making PATCH request).

Advanced field defaults

Validators that are applied across multiple fields in the serializer can sometimes require a field input that should not be provided by the API client, but that is available as input to the validator. diff --git a/community/contributing/index.html b/community/contributing/index.html index d6af0ec62..a70cb908d 100644 --- a/community/contributing/index.html +++ b/community/contributing/index.html @@ -435,10 +435,6 @@ -

  • - Triaging issues -
    • -
  • Development @@ -495,7 +491,6 @@

    The world can only really be changed one piece at a time. The art is picking that piece.

    — Tim Berners-Lee

    -

    There are many ways you can contribute to Django REST framework. We'd like it to be a community-led project, so please get involved and help shape the future of the project.

    Note

    At this point in its lifespan we consider Django REST framework to be feature-complete. We focus on pull requests that track the continued development of Django versions, and generally do not accept new features or code formatting changes.

    @@ -510,22 +505,10 @@

    Be mindful in the language you choose. As an example, in an environment that is heavily male-dominated, posts that start 'Hey guys,' can come across as unintentionally exclusive. It's just as easy, and more inclusive to use gender neutral language in those situations.

    The Django code of conduct gives a fuller set of guidelines for participating in community forums.

    Issues

    -

    Our contribution process is that the GitHub discussions page should generally be your starting point. Please only raise an issue or pull request if you've been recommended to do so after discussion.

    -

    Some tips on good potential issue reporting:

    • Django REST framework is considered feature-complete. Please do not file requests to change behavior, unless it is required for security reasons or to maintain compatibility with upcoming Django or Python versions.
      • -
    • Search the GitHub project page for related items, and make sure you're running the latest version of REST framework before reporting an issue.
    • Feature requests will typically be closed with a recommendation that they be implemented outside the core REST framework library (e.g. as third-party libraries). This approach allows us to keep down the maintenance overhead of REST framework, so that the focus can be on continued stability and great documentation.
    -

    Triaging issues

    -

    Getting involved in triaging incoming issues is a good way to start contributing. Every single ticket that comes into the ticket tracker needs to be reviewed in order to determine what the next steps should be. Anyone can help out with this, you just need to be willing to

    -
      -
    • Read through the ticket - does it make sense, is it missing any context that would help explain it better?
      • -
    • Is the ticket reported in the correct place, would it be better suited as a discussion on the discussion group?
      • -
    • If the ticket is a bug report, can you reproduce it? Are you able to write a failing test case that demonstrates the issue and that can be submitted as a pull request?
      • -
    • If the ticket is a feature request, could the feature request instead be implemented as a third party package?
      • -
    • If a ticket hasn't had much activity and addresses something you need, then comment on the ticket and try to find out what's needed to get it moving again.
      • -

    Development

    To start developing on Django REST framework, first create a Fork from the Django REST Framework repo on GitHub.

    diff --git a/community/project-management/index.html b/community/project-management/index.html index b52a6549f..0ffe7de0b 100644 --- a/community/project-management/index.html +++ b/community/project-management/index.html @@ -483,7 +483,6 @@
  • Code changes should come in the form of a pull request - do not push directly to master.
  • Maintainers should typically not merge their own pull requests.
  • Each issue/pull request should have exactly one label once triaged.
    • -
  • Search for un-triaged issues with is:open no:label.

    • Release process

    diff --git a/community/third-party-packages/index.html b/community/third-party-packages/index.html index 502ddcf5a..414318c34 100644 --- a/community/third-party-packages/index.html +++ b/community/third-party-packages/index.html @@ -471,13 +471,13 @@

    Adding to the Django REST framework grid

    We suggest adding your package to the REST Framework grid on Django Packages.

    Adding to the Django REST framework docs

    -

    Create a Pull Request or Issue on GitHub, and we'll add a link to it from the main REST framework documentation. You can add your package under Third party packages of the API Guide section that best applies, like Authentication or Permissions. You can also link your package under the Third Party Packages section.

    +

    Create a Pull Request on GitHub, and we'll add a link to it from the main REST framework documentation. You can add your package under Third party packages of the API Guide section that best applies, like Authentication or Permissions. You can also link your package under the Third Party Packages section.

    Announce on the discussion group.

    You can also let others know about your package through the discussion group.

    Existing Third Party Packages

    Django REST Framework has a growing community of developers, packages, and resources.

    Check out a grid detailing all the packages and ecosystem around Django REST Framework at Django Packages.

    -

    To submit new content, open an issue or create a pull request.

    +

    To submit new content, create a pull request.

    Async Support