Skip to content
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

externalDocs for operation schema #681

Closed
Jusstas opened this issue Mar 16, 2022 · 5 comments
Closed

externalDocs for operation schema #681

Jusstas opened this issue Mar 16, 2022 · 5 comments
Labels
enhancement New feature or request fix confirmation pending issue has been fixed and confirmation from issue reporter is pending

Comments

@Jusstas
Copy link
Contributor

Jusstas commented Mar 16, 2022

I have missed the externalDocs field for the operation object. Is there any intended way I can add this for my views? If not, I think there should be an external_docs argument in the extend_scema (and extend_schema_serializer I guess?) decorator for this purpose.

@tfranzel
Copy link
Owner

There is a dedicated setting for this (among most other possible settings):

'EXTERNAL_DOCS': {},

Other settings for the root object can be added with EXTENSIONS_ROOT

@Jusstas
Copy link
Contributor Author

Jusstas commented Mar 16, 2022

As I understand, the EXTERNAL_DOCS setting is only for the root OpenAPI object, but there are also externalDocs fields for operation and schema objects.

@tfranzel
Copy link
Owner

Excellent point! Sry, I missed that you were referring to the operation.

Should be doable, however not sure yet where exactly it is the best fit. operation or schema objects.

@tfranzel tfranzel added the enhancement New feature or request label Mar 16, 2022
@tfranzel tfranzel added the fix confirmation pending issue has been fixed and confirmation from issue reporter is pending label Mar 18, 2022
@tfranzel
Copy link
Owner

That should do it. It is only for the operation for now. Let's wait if someone will ask for the schema object.

@tfranzel
Copy link
Owner

closing this issue for now. feel free to comment if anything is missing or not working and we will follow-up.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request fix confirmation pending issue has been fixed and confirmation from issue reporter is pending
Projects
None yet
Development

No branches or pull requests

2 participants