ce8d3211f9
* chore: improving programs rest API docs, type hints reformatting the docstrings so they appear correctly in the openAPI docs. * moving them into the `GET` * some cleanup and simplification of language * removing real data that refers to specific hosts regenerated the open API documentation. also adding type hints to the API and telling `mypy` to check this file. This was primarily because these models are confusing enough in order to verify that the documentation was correct I had to do a lot of jumping through the code. FIXES: APER-3950
69 lines
1.9 KiB
INI
69 lines
1.9 KiB
INI
[mypy]
|
|
follow_imports = silent
|
|
ignore_missing_imports = True
|
|
allow_untyped_globals = True
|
|
plugins =
|
|
mypy_django_plugin.main,
|
|
mypy_drf_plugin.main
|
|
files =
|
|
cms/lib/xblock/upstream_sync.py,
|
|
cms/djangoapps/contentstore/rest_api/v2/views/downstreams.py,
|
|
openedx/core/djangoapps/content/learning_sequences,
|
|
openedx/core/djangoapps/content_staging,
|
|
openedx/core/djangoapps/content_libraries,
|
|
openedx/core/djangoapps/programs/rest_api,
|
|
openedx/core/djangoapps/xblock,
|
|
openedx/core/lib/derived.py,
|
|
openedx/core/types,
|
|
openedx/core/djangoapps/content_tagging,
|
|
xmodule/util/keys.py,
|
|
xmodule/item_bank_block.py
|
|
|
|
[mypy.plugins.django-stubs]
|
|
# content_staging only works with CMS; others work with either, so we run mypy with CMS settings.
|
|
django_settings_module = "cms.envs.test"
|
|
|
|
# Selectively ignore packages known to be lacking type hints
|
|
[mypy-bridgekeeper.*]
|
|
ignore_missing_imports = True
|
|
[mypy-celery.*]
|
|
ignore_missing_imports = True
|
|
[mypy-celery_utils.*]
|
|
ignore_missing_imports = True
|
|
[mypy-completion.*]
|
|
ignore_missing_imports = True
|
|
[mypy-crum.*]
|
|
ignore_missing_imports = True
|
|
[mypy-ddt.*]
|
|
ignore_missing_imports = True
|
|
[mypy-edx_api_doc_tools.*]
|
|
ignore_missing_imports = True
|
|
[mypy-edx_django_utils.*]
|
|
ignore_missing_imports = True
|
|
[mypy-edx_proctoring.*]
|
|
ignore_missing_imports = True
|
|
[mypy-edx_rest_api_client.*]
|
|
ignore_missing_imports = True
|
|
[mypy-edx_rest_framework_extensions.*]
|
|
ignore_missing_imports = True
|
|
[mypy-eventtracking.*]
|
|
ignore_missing_imports = True
|
|
[mypy-fs.*]
|
|
ignore_missing_imports = True
|
|
[mypy-model_utils.*]
|
|
ignore_missing_imports = True
|
|
[mypy-openedx_events.*]
|
|
ignore_missing_imports = True
|
|
[mypy-organizations.*]
|
|
ignore_missing_imports = True
|
|
[mypy-search.*]
|
|
ignore_missing_imports = True
|
|
[mypy-rules.*]
|
|
ignore_missing_imports = True
|
|
[mypy-web_fragments.*]
|
|
ignore_missing_imports = True
|
|
[mypy-webob.*]
|
|
ignore_missing_imports = True
|
|
[mypy-xblock.*]
|
|
ignore_missing_imports = True
|