aboutsummaryrefslogtreecommitdiff
path: root/dev-python/drf-spectacular/metadata.xml
diff options
context:
space:
mode:
Diffstat (limited to 'dev-python/drf-spectacular/metadata.xml')
-rw-r--r--dev-python/drf-spectacular/metadata.xml53
1 files changed, 53 insertions, 0 deletions
diff --git a/dev-python/drf-spectacular/metadata.xml b/dev-python/drf-spectacular/metadata.xml
new file mode 100644
index 0000000..685b4bc
--- /dev/null
+++ b/dev-python/drf-spectacular/metadata.xml
@@ -0,0 +1,53 @@
+<?xml version="1.0" encoding="UTF-8"?>
+<!DOCTYPE pkgmetadata SYSTEM "https://www.gentoo.org/dtd/metadata.dtd">
+<pkgmetadata>
+ <maintainer type="person">
+ <name>Julien Roy</name>
+ <email>julien@jroy.ca</email>
+ </maintainer>
+ <longdescription>
+This project has 3 goals:
+
+ Extract as much schema information from DRF as possible.
+ Provide flexibility to make the schema usable in the real world (not only toy examples).
+ Generate a schema that works well with the most popular client generators.
+
+The code is a heavily modified fork of the DRF OpenAPI generator, which is/was lacking all of the below listed features.
+
+Features
+
+ Serializers modelled as components. (arbitrary nesting and recursion supported)
+
+ @extend_schema decorator for customization of APIView, Viewsets, function-based views, and @action
+ additional parameters
+ request/response serializer override (with status codes)
+ polymorphic responses either manually with PolymorphicProxySerializer helper or via rest_polymorphic's PolymorphicSerializer)
+ ... and more customization options
+
+ Authentication support (DRF natives included, easily extendable)
+ Custom serializer class support (easily extendable)
+ SerializerMethodField() type via type hinting or @extend_schema_field
+ i18n support
+ Tags extraction
+ Request/response/parameter examples
+ Description extraction from docstrings
+ Vendor specification extensions (x-*) in info, operations, parameters, components, and security schemes
+ Sane fallbacks
+ Sane operation_id naming (based on path)
+ Schema serving with SpectacularAPIView (Redoc and Swagger-UI views are also available)
+ Optional input/output serializer component split
+ Callback operations
+ OpenAPI 3.1 support (via setting OAS_VERSION)
+ </longdescription>
+ <upstream>
+ <maintainer>
+ <name>T. Franzel</name>
+ <email>tfranzel@gmail.com</email>
+ </maintainer>
+ <bugs-to>https://github.com/tfranzel/drf-spectacular/issues</bugs-to>
+ <changelog>https://github.com/tfranzel/drf-spectacular/releases</changelog>
+ <doc>https://drf-spectacular.readthedocs.io/</doc>
+ <remote-id type="github">tfranzel/drf-spectacular</remote-id>
+ <remote-id type="pypi">drf-spectacular</remote-id>
+ </upstream>
+</pkgmetadata>