-
Notifications
You must be signed in to change notification settings - Fork 299
Omit id field from OpenAPI schema attributes #1156
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Thanks for this change. Could you resolve the merge conflict? I am then happy to merge it.
Thanks for working on this. In case others stumble upon this as well and as I mentioned in #1157. OpenAPI schema support will be deprecated soon in DJA (reason being is that DRF has also deprecated it). We will still add small changes like this, we do recommend to use drf-spectecular-json-api though. That library is just getting started, so it would certainly be great to support it.
I'll have to look at migrating to that library at some point. We're currently only using the built-in DJA schema generation at my workplace and we figured that we'd contribute some of the fixes we've had to do during our implementation to upstream as well.
That is great. Very much appreciated your contribution. It would be great if you could take a look at drf-spectecular-json-api as it could certainly need some support.
Description of the Change
Omits the "id" field from
/data/attributesthe OpenAPI schema, as theJSONRendererexplicitly removes it from the attributes.{ "type": "object", "required": ["type", "id"], "additionalProperties": False, "properties": { "type": {"$ref": "#/components/schemas/type"}, "id": {"$ref": "#/components/schemas/id"}, "links": { ... }, "attributes": { "type": "object", "properties": { "id": {"type": "integer", "readOnly": True}, # <- Not real "name": {"type": "string", "maxLength": 100}, }, "required": ["name"], }, "relationships": { ... }, }, }Checklist
CHANGELOG.mdupdated (only for user relevant changes)AUTHORS