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
»
edx-api-doc-tools
Give Doc Feedback
Edit on GitHub
edx-api-doc-tools
¶
Tools for writing and generating API documentation for Open edX REST APIs.
Contents:
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