Commit d65cddd1 by Peter Desjardins

Adding a test YAML docstring section to see what Swagger will do with it.

parent bf5c1a35
......@@ -187,6 +187,36 @@ class CourseListView(DeveloperErrorViewMixin, ListAPIView):
"start_type": "timestamp"
}
]
---
# YAML
omit_serializer: true
parameters:
- name: mobile
description: If specified, only visible `CourseOverview`
objects that are designated as mobile_available are returned.
required: false
type: string
paramType: query
- name: org
description: If specified, visible `CourseOverview` objects are filtered
such that only those belonging to the organization with the
provided org code (e.g., "HarvardX") are returned.
Case-insensitive.
required: false
type: string
paramType: query
- name: username
description: The username of the specified user whose visible courses we
want to see. The username is not required only if the API is
requested by an Anonymous user.
required: false
type: string
paramType: query
"""
pagination_class = NamespacedPageNumberPagination
......
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment