Merge pull request #1252 from nils-van-zuijlen/patch-2

Update OpenAPI docs links
tfranzel · Jun 24, 2024 · 1dbb6c1 · 1dbb6c1
2 parents ebe958c + f78ec4f
commit 1dbb6c1
Show file tree

Hide file tree

Showing 3 changed files with 6 additions and 6 deletions.
diff --git a/drf_spectacular/extensions.py b/drf_spectacular/extensions.py
@@ -30,7 +30,7 @@ class OpenApiAuthenticationExtension(OpenApiGeneratorExtension['OpenApiAuthentic
     required (AND). If you need alternate variations (OR), return a list of those dicts instead.
 
     ``get_security_definition()`` is expected to return a valid `OpenAPI security scheme object
-    <https://spec.openapis.org/oas/v3.0.3#securitySchemeObject>`_
+    <https://spec.openapis.org/oas/v3.0.3#security-scheme-object>`_
     """
     _registry: List[Type['OpenApiAuthenticationExtension']] = []
 
@@ -60,7 +60,7 @@ class OpenApiSerializerExtension(OpenApiGeneratorExtension['OpenApiSerializerExt
     can be accessed via ``self.target``.
 
     ``map_serializer()`` is expected to return a valid `OpenAPI schema object
-    <https://spec.openapis.org/oas/v3.0.3#schemaObject>`_.
+    <https://spec.openapis.org/oas/v3.0.3#schema-object>`_.
     """
     _registry: List[Type['OpenApiSerializerExtension']] = []
 
@@ -83,7 +83,7 @@ class OpenApiSerializerFieldExtension(OpenApiGeneratorExtension['OpenApiSerializ
     warnings, in which case manual construction is advisable.
 
     ``map_serializer_field()`` is expected to return a valid `OpenAPI schema object
-    <https://spec.openapis.org/oas/v3.0.3#schemaObject>`_.
+    <https://spec.openapis.org/oas/v3.0.3#schema-object>`_.
     """
     _registry: List[Type['OpenApiSerializerFieldExtension']] = []
 
@@ -128,7 +128,7 @@ class OpenApiFilterExtension(OpenApiGeneratorExtension['OpenApiFilterExtension']
 
     ``get_schema_operation_parameters()`` is expected to return either an empty list or a list
     of valid raw `OpenAPI parameter objects
-    <https://spec.openapis.org/oas/v3.0.3#parameterObject>`_.
+    <https://spec.openapis.org/oas/v3.0.3#parameter-object>`_.
     Using ``drf_spectacular.plumbing.build_parameter_type`` is recommended to generate
     the appropriate raw dict objects.
     """

diff --git a/drf_spectacular/plumbing.py b/drf_spectacular/plumbing.py
@@ -1208,7 +1208,7 @@ def sanitize_result_object(result):
 
 
 def sanitize_specification_extensions(extensions):
-    # https://spec.openapis.org/oas/v3.0.3#specificationExtensions
+    # https://spec.openapis.org/oas/v3.0.3#specification-extensions
     output = {}
     for key, value in extensions.items():
         if not re.match(r'^x-', key):

diff --git a/drf_spectacular/settings.py b/drf_spectacular/settings.py
@@ -217,7 +217,7 @@
     'EXTENSIONS_ROOT': {},
 
     # Oauth2 related settings. used for example by django-oauth2-toolkit.
-    # https://spec.openapis.org/oas/v3.0.3#oauthFlowsObject
+    # https://spec.openapis.org/oas/v3.0.3#oauth-flows-object
     'OAUTH2_FLOWS': [],
     'OAUTH2_AUTHORIZATION_URL': None,
     'OAUTH2_TOKEN_URL': None,