Bug 227344 - [NEW PORT] www/py-drf-yasg: Yet Another Swagger Generator
Summary: [NEW PORT] www/py-drf-yasg: Yet Another Swagger Generator
Status: Closed FIXED
Alias: None
Product: Ports & Packages
Classification: Unclassified
Component: Individual Port(s) (show other bugs)
Version: Latest
Hardware: Any Any
: --- Affects Only Me
Assignee: Kurt Jaeger
URL: https://pypi.python.org/pypi/drf-yasg
Keywords:
Depends on: 227121 227319
Blocks: 227416
  Show dependency tree / graph
 
Reported: 2018-04-07 13:44 UTC by Kai Knoblich
Modified: 2018-05-21 16:25 UTC (History)
4 users (show)

See Also:
feld: maintainer-feedback?

Attachments
py-drf-yasg.shar (3.21 KB, text/plain)
2018-04-07 13:44 UTC, Kai Knoblich 		no flags Details
View All Add an attachment (proposed patch, testcase, etc.)

Note You need to log in before you can comment on or make changes to this bug.
Description Kai Knoblich freebsd_committer freebsd_triage 2018-04-07 13:44:20 UTC 
Created attachment 192308 [details]
py-drf-yasg.shar

Hello,

attached is the shar file for the Python package py-drf-yasg, that generates real Swagger/OpenAPI 2.0 specifications from a Django Rest Framework API.

Features:

- full support for nested serializers and schemas
- response schemas and descriptions
- model definitions compatible with codegen tools
- customization hooks at all points in the spec generation process
- JSON and YAML format for spec
- bundles latest version of swagger-ui and redoc for viewing the generated
  documentation
- schema view is cacheable out of the box
- generated Swagger schema can be automatically validated by
  swagger-spec-validator or flex
- supports Django REST Framework API versioning with URLPathVersioning and
  NamespaceVersioning (other DRF or custom versioning schemes are not currently
  supported)


QA:
~~~
- poudriere (11.1-RELEASE amd64 + i386) for each py27 and py36 flavor -> OK
- portlint -> OK


Note:
~~~~~
Before this package can be commited, two dependencies must be resolved first:

- update devel/py-ruamel.yaml to 0.15.37 (see also PR #227121: https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=227121)
- add www/py-djangorestframework (v3.8.1) to the ports tree (see also PR #227319: https://bugs.freebsd.org/bugzilla/show_bug.cgi?id=227319)
Comment 1 Mark Felder freebsd_committer freebsd_triage 2018-04-16 15:02:57 UTC 
maintainer approved
Comment 2 Mark Felder freebsd_committer freebsd_triage 2018-04-16 15:03:18 UTC 
sorry, opened wrong bug report.
Comment 3 Kurt Jaeger freebsd_committer freebsd_triage 2018-04-17 20:18:45 UTC 
Committed, thanks!
Comment 4 commit-hook freebsd_committer freebsd_triage 2018-04-17 20:18:53 UTC 
A commit references this bug:

Author: pi
Date: Tue Apr 17 20:18:06 UTC 2018
New revision: 467653
URL: https://svnweb.freebsd.org/changeset/ports/467653

Log:
  New port: www/py-drf-yasg

  Generate real Swagger/OpenAPI 2.0 specifications from a Django Rest
  Framework API.

  Features:

  - full support for nested serializers and schemas
  - response schemas and descriptions
  - model definitions compatible with codegen tools
  - customization hooks at all points in the spec generation process
  - JSON and YAML format for spec
  - bundles latest version of swagger-ui and redoc for viewing the generated
    documentation
  - schema view is cacheable out of the box
  - generated Swagger schema can be automatically validated by
    swagger-spec-validator or flex
  - supports Django REST Framework API versioning with URLPathVersioning
    and NamespaceVersioning (other DRF or custom versioning schemes are
    not currently supported)

  WWW: https://github.com/axnsan12/drf-yasg

  PR:		227344
  Submitted by:	Kai <freebsd_ports@k-worx.org>

Changes:
  head/www/Makefile
  head/www/py-drf-yasg/
  head/www/py-drf-yasg/Makefile
  head/www/py-drf-yasg/distinfo
  head/www/py-drf-yasg/pkg-descr
Comment 5 Martin Wilke freebsd_committer freebsd_triage 2018-05-21 16:25:21 UTC 
Landed in ports.