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

URLField makes Browsable API hides endpoints from openapi schema view #7354

Closed
5 of 6 tasks
fao89 opened this issue May 29, 2020 · 1 comment
Closed
5 of 6 tasks

URLField makes Browsable API hides endpoints from openapi schema view #7354

fao89 opened this issue May 29, 2020 · 1 comment

Comments

@fao89
Copy link

fao89 commented May 29, 2020

Checklist

  • I have verified that that issue exists against the master branch of Django REST framework.
  • I have searched for similar issues in both open and closed tickets and cannot find a duplicate.
  • This is not a usage question. (Those should be directed to the discussion group instead.)
  • This cannot be dealt with as a third party library. (We prefer new functionality to be in the form of third party libraries where possible.)
  • I have reduced the issue to the simplest possible case.
  • I have included a failing test as a pull request. (If you are unable to do so we can still accept the issue.)

Steps to reproduce

Have an openapi schema view, with some view using URLField

Expected behavior

See all endpoints on the browsable API

Actual behavior

Endpoints are missing due to HTML comment on regex patterns.

Workflow

Autoschema when mapping URLFields: https://github.com/encode/django-rest-framework/blob/master/rest_framework/schemas/openapi.py#L545-L581 gets the regex pattern from URLValidator which contains <! commenting the HTML from the Browsable API, hiding the following endpoints

@carltongibson
Copy link
Collaborator

This is probably #7204. There's an open ticket there to work out exactly how we should map the URL from a URLValidator. Would be great if you wanted to have a think about that.

@auvipy auvipy closed this as not planned Won't fix, can't repro, duplicate, stale Jan 12, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

No branches or pull requests

3 participants