django-rest-framework Represent SafeString as plain string on schema rendering.

Note: Before submitting this pull request, please review our contributing guidelines.

Description

Fix #8428.

Mar 25 '22 01:03 hashlash

I tried running tox -e docs on branch master, and it also failed (with the same error). So the problem shouldn't be from the changes in this PR.

Should we wait for the fix, or can we merge it first?

Mar 25 '22 03:03 hashlash

The source of error: https://github.com/mkdocs/mkdocs/issues/2799

Mar 25 '22 03:03 hashlash

The error should be fixed in #8433.

Mar 27 '22 00:03 hashlash

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

Jun 13 '22 01:06 stale[bot]

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

Aug 13 '22 02:08 stale[bot]

can you add more relevant tests for the changes?

@auvipy I think the test is sufficient. As long as it can render SafeString, I think it's good enough.

Or could you elaborate on what kind of test I should add?

Nov 23 '22 13:11 hashlash

I have requested review from another OpenAPI specialist

Nov 23 '22 13:11 auvipy

Btw, here's the section in PyYAML that discuss about representing custom object: https://pyyaml.org/wiki/PyYAMLDocumentation#constructors-representers-resolvers

Nov 23 '22 14:11 hashlash

Oops, you're right. I just read the discussion #8453, but wasn't aware with the drf-spectacular renderer implementation. Based on the discussion, going forward, the renderer part will also be deprecated from rest_framework?

Nov 23 '22 15:11 hashlash

@hashlash, yes. everything that does not belong to the schema interface itself will be retired and removed eventually.

Nov 23 '22 16:11 tfranzel