edx-api-doc-tools
Adding edx-api-doc-tools to your project
Writing API documentation
Documenting methods directly with @schema
Documenting inherited methods with @schema_for
Excluding API endpoints from documentation
edx_api_doc_tools module
Development
Install dependencies
Testing
Change Log
Unreleased
1.5.0 — 2021-07-19
1.4.3 — 2021-07-15
1.4.2 — 2021-01-08
1.4.1 — 2020-11-20
1.4.0 — 2020-10-05
1.3.2 — 2020-09-23
1.3.1 — 2020-05-29
1.3.0 — 2020-04-30
1.2.0 — 2020-03-20
1.1.0 — 2020-03-20
1.0.3 — 2020-01-31
1.0.2 — 2020-01-17
edx-api-doc-tools
Table of Contents
»
Index
Give Doc Feedback
Edit on GitHub
Index
A
|
D
|
E
|
G
|
I
|
M
|
P
|
Q
|
S
A
ApiSchemaGenerator (class in edx_api_doc_tools)
D
determine_path_prefix() (edx_api_doc_tools.ApiSchemaGenerator method)
E
edx_api_doc_tools
module
exclude_schema() (in module edx_api_doc_tools)
exclude_schema_for() (in module edx_api_doc_tools)
exclude_schema_for_all() (in module edx_api_doc_tools)
G
get_docs_cache_timeout() (in module edx_api_doc_tools)
get_docs_urls() (in module edx_api_doc_tools)
get_endpoints() (edx_api_doc_tools.ApiSchemaGenerator method)
I
is_schema_request() (in module edx_api_doc_tools)
M
make_api_info() (in module edx_api_doc_tools)
make_docs_data_view() (in module edx_api_doc_tools)
make_docs_ui_view() (in module edx_api_doc_tools)
make_docs_urls() (in module edx_api_doc_tools)
module
edx_api_doc_tools
P
parameter() (in module edx_api_doc_tools)
ParameterLocation (class in edx_api_doc_tools)
path_parameter() (in module edx_api_doc_tools)
Q
query_parameter() (in module edx_api_doc_tools)
S
schema() (in module edx_api_doc_tools)
schema_for() (in module edx_api_doc_tools)
string_parameter() (in module edx_api_doc_tools)