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.

Sign up for GitHub

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

Jump to bottom

Improved the operationIds by implementing a post hook function #3021

Merged
merged 7 commits into from
Jul 23, 2023
Merged

Improved the operationIds by implementing a post hook function #3021

Show file tree
Hide file tree
Changes from 5 commits
Commits
Show all changes
7 commits
Select commit Hold shift + click to select a range
b1079f2
Added POSTPROCESSING HOOK to customise the operationId
varshadr Jul 10, 2023
c8732f3
Updated the spectacular settings to include the POSTPROCESSING HOOK
varshadr Jul 10, 2023
2b90fc1
added a new line at the end of the file to remove lint error
varshadr Jul 10, 2023
a1567fd
removed unused import statement
varshadr Jul 10, 2023
91ce7de
Rename `custom_postprocessing_hook` to `remove_url_prefix_hook`
silentninja Jul 21, 2023
f70b30c
removed unused variable 'generator'and 'public'to fix the lint error
varshadr Jul 23, 2023
836c3f6
Merge branch 'develop' into 3000-improve-operationids-for-the-endpoints
silentninja Jul 23, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
3 changes: 3 additions & 0 deletions config/settings/common_settings.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -192,6 +192,9 @@ def pipe_delim(pipe_string):
'DESCRIPTION': '',
'VERSION': '1.0.0',
'SERVE_INCLUDE_SCHEMA': False,
'POSTPROCESSING_HOOKS': [
'config.settings.openapi.remove_url_prefix_hook',
],
# OTHER SETTINGS
}
FRIENDLY_ERRORS = {
Expand Down
12 changes: 12 additions & 0 deletions config/settings/openapi.py
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
def remove_url_prefix_hook(generator, result, request, public):
# Remove namespace and version url prefix from the operation Id of the generated API schema
for path, path_info in result['paths'].items():
for method, operation in path_info.items():
operation_id = operation.get('operationId')
if operation_id:
if path.startswith('/api/db/v0/'):
operation['operationId'] = operation_id.replace('db_v0_', '')
elif path.startswith('/api/ui/v0/'):
operation['operationId'] = operation_id.replace('ui_v0_', '')

return result