-
Notifications
You must be signed in to change notification settings - Fork 81
/
CHANGES
105 lines (74 loc) · 2.62 KB
/
CHANGES
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
=========
Changes
=========
Here you can see the list of changes between each 'sphinxcontrib-openapi'
release.
0.8.4 (2024-02-13)
==================
- Address issue with path excludes.
- Fix namespace ``sphinxcontrib`` to be usable with ``zc.buildout``.
0.8.3 (2023-10-24)
==================
- Address issue with remote spec references.
0.8.2 (2023-10-24)
==================
- Address issues with nullable types in OpenAPI 3.1.
0.8.1 (2023-01-24)
==================
- Add support for OpenAPI 3.1 type arrays.
0.8.0 (2023-01-13)
==================
- Add initial support for OpenAPI 3.1.
- Replace dependency on abandoned ``m2r`` dependency.
- Add support for recursive schemas.
- Add support for Python 3.10, 3.11
0.7.0 (2020-05-07)
==================
- Drop Python 2.7 support because it reached its end-of-life.
- Add support for examples defined in schema.
- Add support for 'anyOf' during example generation based on schema.
- Fix loading $ref in other YAML files.
- Fix freeforom (property-less) obhect schema rendering.
- Respect RFC7807 in example generation.
- Add new experimental OpenAPI v3 renderer.
0.6.0 (2019-12-20)
==================
- Add ``include`` and ``exclude`` options to exclude certain paths out from
rendering.
- Generate samples for ``GET`` requests.
- When rendering by groups, preserve order of groups specified in the spec.
0.5.0 (2019-09-04)
==================
- Fix example generation when a byte string is used in a schema.
- Support CommonMark in spec where applied. ``m2r`` package is required.
- Show "required" marker near required query parameters.
- Show request body properties for OpenAPI v2 specs.
- CLI command to render OpenAPI spec as reStructuredText is added.
0.4.0 (2019-01-17)
==================
- Add OpenAPI 3.x support.
- Drop Python 3.3 support because it reached its end-of-life.
- Add Python 3.7 support.
- Add sample request/response generation from schema for OpenAPI v3.
- Add grouping by OpenAPI tags.
0.3.2 (2017-10-05)
==================
- Do not crash on Python 2.x if non-ASCII character is met.
0.3.1 (2017-05-19)
==================
- Make 'sphinxcontrib-openapi' compatible with Sphinx 1.6.
0.3.0 (2017-01-29)
==================
- Add ``:paths:`` option to ``openapi`` directive that allows to render
only specified endpoints.
- Resolve references inside list objects.
- Handle common ``parameters` specified at the endpoint's root.
0.2.1 (2017-01-10)
==================
- Resolve relative JSON references.
0.2.0 (2016-11-16)
==================
- Resolve JSON references in the spec before attempt to generate a doc.
0.1.0 (2016-10-03)
==================
- First public release.