Comments (4)
Would you like to investigate this and propose a fix?
I'm not sure how soon I'll have time to investigate this further, I'm afraid, but I'll try to look into it at some point.
from apispec.
I'm afraid you're right. Looks like a bug.
Would you like to investigate this and propose a fix?
from apispec.
@lafrech the problem here seems to be that field2nullable
and nested2properties
are operating independently. It looks like for OpenAPI 3.1 they are going to need to interoperate.
For this schema under 3.1 field2nullable
is adding "type": ["null"]
and nested2properties
is independently adding "allOf": [{"$ref": "#/components/schemas/Foo"}]
This approach was probably fine pre 3.1, but now that nullability needs to be included in an anyOf
array we need make one method depend on the result of the other.
This is probably also an issue for pluck2properties
, but there the symptom would be not displaying nullability because the type is always being overwritten.
The solution I'm thinking about is:
- Moving the execution of
field2nullable
to be the last attribute function executed. I think this change alone solves thePluck
case and the case of nested schemas defined inline. - Adding logic under the 3.1 case to translate the
allOf
keyword toanyOf
while adding thenull
type. - We may also want to ensure that
field2nullable
executes after user defined attribute functions to prevent similar issues with those.
from apispec.
fix released in 6.6.1
from apispec.
Related Issues (20)
- marshmallow plugin does not support `marshmallow.fields.Tuple` HOT 1
- What is the correct way to use add_attribute_function in the Marshmallow plugin? HOT 2
- additionalProperties=false is not set when using default Marshmallow schema options HOT 2
- callbacks in operation are not resolved to refs HOT 5
- wrong default value for 'name' in schema2parameters HOT 3
- parameters not being resolved for OAS3 'content' type parameters HOT 2
- Incorrect handling of Union types HOT 2
- Deprecated flag is not configured correctly on query parameter objects
- sdist is missing `tox.ini` HOT 1
- Interest in taking Schema description from Schema.__doc__ docstring
- Incorrectly serialized format when using a range validator on a Decimal Marshmallow field HOT 10
- Document form data and images
- Enum by_value creates OpenAPI property without type HOT 11
- Deprecate __version__ attribute
- Add requestBody component HOT 14
- How to get Schema added to components/parameters? HOT 5
- Thanks for the report! HOT 1
- Security scheme documentation HOT 1
- Document "content" parameters
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from apispec.