KeyError when generating an OpenAPI schema with a read-only field #6534
Description
This issue occurs when using the updated OpenAPI schema generation by @carltongibson (#6532).
Checklist
- I have verified that that issue exists against the
masterbranch 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
Run ./manage.py generateschema on a project with any read-only field in a serializer. The serializer should not have a field called "name".
Expected behavior
Should generate an OpenAPI schema as YAML with the read-only fields excluded from the request parameters.
Actual behavior
Traceback (most recent call last):
File "./manage.py", line 22, in <module>
execute_from_command_line(sys.argv)
File "/home/lucidiot/.virtualenvs/backend/lib/python3.6/site-packages/django/core/management/__init__.py", line 381, in execute_from_command_line
utility.execute()
File "/home/lucidiot/.virtualenvs/backend/lib/python3.6/site-packages/django/core/management/__init__.py", line 375, in execute
self.fetch_command(subcommand).run_from_argv(self.argv)
File "/home/lucidiot/.virtualenvs/backend/lib/python3.6/site-packages/django/core/management/base.py", line 316, in run_from_argv
self.execute(*args, **cmd_options)
File "/home/lucidiot/.virtualenvs/backend/lib/python3.6/site-packages/django/core/management/base.py", line 353, in execute
output = self.handle(*args, **options)
File "/home/lucidiot/Prog/django-rest-framework/rest_framework/management/commands/generateschema.py", line 24, in handle
schema = generator.get_schema(request=None, public=True)
File "/home/lucidiot/Prog/django-rest-framework/rest_framework/schemas/generators.py", line 519, in get_schema
paths = self.get_paths(None if public else request)
File "/home/lucidiot/Prog/django-rest-framework/rest_framework/schemas/generators.py", line 506, in get_paths
operation = view.schema.get_operation(path, method)
File "/home/lucidiot/Prog/django-rest-framework/rest_framework/schemas/inspectors.py", line 524, in get_operation
request_body = self._get_request_body(path, method)
File "/home/lucidiot/Prog/django-rest-framework/rest_framework/schemas/inspectors.py", line 722, in _get_request_body
del content['properties']['name']
KeyError: 'name'
It seems the fix is to change lines 722 and 747 from del content['properties']['name'] to del content['properties'][name].