feat!: Removed Badges App
fix: restored badges handlers feat: remove FE code for badges fix: resolved failing tests fix: removed test case for badges app fix: unused import error fix: Response Field Count fix: shareable account response length fix: resolved PR comments fix: revert settings override feat!: Removed Badges App fix: restored badges handlers feat: remove FE code for badges fix: resolved failing tests fix: removed test case for badges app fix: unused import error fix: Response Field Count fix: shareable account response length fix: revert subscription badge
This commit is contained in:
thezaeemaanwar
committed by
Zaeema Anwar
Zaeema Anwar
parent
92731be0dc
commit
0b3e4d73b6
@@ -58,114 +58,6 @@ paths:
|
||||
in: path
|
||||
required: true
|
||||
type: string
|
||||
/badges/v1/assertions/user/{username}/:
|
||||
get:
|
||||
operationId: badges_v1_assertions_user_read
|
||||
summary: '**Use Cases**'
|
||||
description: |-
|
||||
Request a list of assertions for a user, optionally constrained to a course.
|
||||
|
||||
**Example Requests**
|
||||
|
||||
GET /api/badges/v1/assertions/user/{username}/
|
||||
|
||||
**Response Values**
|
||||
|
||||
Body comprised of a list of objects with the following fields:
|
||||
|
||||
* badge_class: The badge class the assertion was awarded for. Represented as an object
|
||||
with the following fields:
|
||||
* slug: The identifier for the badge class
|
||||
* issuing_component: The software component responsible for issuing this badge.
|
||||
* display_name: The display name of the badge.
|
||||
* course_id: The course key of the course this badge is scoped to, or null if it isn't scoped to a course.
|
||||
* description: A description of the award and its significance.
|
||||
* criteria: A description of what is needed to obtain this award.
|
||||
* image_url: A URL to the icon image used to represent this award.
|
||||
* image_url: The baked assertion image derived from the badge_class icon-- contains metadata about the award
|
||||
in its headers.
|
||||
* assertion_url: The URL to the OpenBadges BadgeAssertion object, for verification by compatible tools
|
||||
and software.
|
||||
|
||||
**Params**
|
||||
|
||||
* slug (optional): The identifier for a particular badge class to filter by.
|
||||
* issuing_component (optional): The issuing component for a particular badge class to filter by
|
||||
(requires slug to have been specified, or this will be ignored.) If slug is provided and this is not,
|
||||
assumes the issuing_component should be empty.
|
||||
* course_id (optional): Returns assertions that were awarded as part of a particular course. If slug is
|
||||
provided, and this field is not specified, assumes that the target badge has an empty course_id field.
|
||||
'*' may be used to get all badges with the specified slug, issuing_component combination across all courses.
|
||||
|
||||
**Returns**
|
||||
|
||||
* 200 on success, with a list of Badge Assertion objects.
|
||||
* 403 if a user who does not have permission to masquerade as
|
||||
another user specifies a username other than their own.
|
||||
* 404 if the specified user does not exist
|
||||
|
||||
{
|
||||
"count": 7,
|
||||
"previous": null,
|
||||
"num_pages": 1,
|
||||
"results": [
|
||||
{
|
||||
"badge_class": {
|
||||
"slug": "special_award",
|
||||
"issuing_component": "openedx__course",
|
||||
"display_name": "Very Special Award",
|
||||
"course_id": "course-v1:edX+DemoX+Demo_Course",
|
||||
"description": "Awarded for people who did something incredibly special",
|
||||
"criteria": "Do something incredibly special.",
|
||||
"image": "http://example.com/media/badge_classes/badges/special_xdpqpBv_9FYOZwN.png"
|
||||
},
|
||||
"image_url": "http://badges.example.com/media/issued/cd75b69fc1c979fcc1697c8403da2bdf.png",
|
||||
"assertion_url": "http://badges.example.com/public/assertions/07020647-e772-44dd-98b7-d13d34335ca6"
|
||||
},
|
||||
...
|
||||
]
|
||||
}
|
||||
parameters:
|
||||
- name: page
|
||||
in: query
|
||||
description: A page number within the paginated result set.
|
||||
required: false
|
||||
type: integer
|
||||
- name: page_size
|
||||
in: query
|
||||
description: Number of results to return per page.
|
||||
required: false
|
||||
type: integer
|
||||
responses:
|
||||
'200':
|
||||
description: ''
|
||||
schema:
|
||||
required:
|
||||
- count
|
||||
- results
|
||||
type: object
|
||||
properties:
|
||||
count:
|
||||
type: integer
|
||||
next:
|
||||
type: string
|
||||
format: uri
|
||||
x-nullable: true
|
||||
previous:
|
||||
type: string
|
||||
format: uri
|
||||
x-nullable: true
|
||||
results:
|
||||
type: array
|
||||
items:
|
||||
$ref: '#/definitions/BadgeAssertion'
|
||||
tags:
|
||||
- badges
|
||||
parameters:
|
||||
- name: username
|
||||
in: path
|
||||
required: true
|
||||
type: string
|
||||
/bookmarks/v1/bookmarks/:
|
||||
get:
|
||||
operationId: bookmarks_v1_bookmarks_list
|
||||
@@ -9477,75 +9369,6 @@ paths:
|
||||
required: true
|
||||
type: string
|
||||
definitions:
|
||||
BadgeClass:
|
||||
required:
|
||||
- slug
|
||||
- display_name
|
||||
- description
|
||||
- criteria
|
||||
type: object
|
||||
properties:
|
||||
slug:
|
||||
title: Slug
|
||||
type: string
|
||||
format: slug
|
||||
pattern: ^[-a-zA-Z0-9_]+$
|
||||
maxLength: 255
|
||||
minLength: 1
|
||||
issuing_component:
|
||||
title: Issuing component
|
||||
type: string
|
||||
format: slug
|
||||
pattern: ^[-a-zA-Z0-9_]+$
|
||||
default: ''
|
||||
maxLength: 50
|
||||
display_name:
|
||||
title: Display name
|
||||
type: string
|
||||
maxLength: 255
|
||||
minLength: 1
|
||||
course_id:
|
||||
title: Course id
|
||||
type: string
|
||||
maxLength: 255
|
||||
description:
|
||||
title: Description
|
||||
type: string
|
||||
minLength: 1
|
||||
criteria:
|
||||
title: Criteria
|
||||
type: string
|
||||
minLength: 1
|
||||
image_url:
|
||||
title: Image url
|
||||
type: string
|
||||
readOnly: true
|
||||
format: uri
|
||||
BadgeAssertion:
|
||||
required:
|
||||
- image_url
|
||||
- assertion_url
|
||||
type: object
|
||||
properties:
|
||||
badge_class:
|
||||
$ref: '#/definitions/BadgeClass'
|
||||
image_url:
|
||||
title: Image url
|
||||
type: string
|
||||
format: uri
|
||||
maxLength: 200
|
||||
minLength: 1
|
||||
assertion_url:
|
||||
title: Assertion url
|
||||
type: string
|
||||
format: uri
|
||||
maxLength: 200
|
||||
minLength: 1
|
||||
created:
|
||||
title: Created
|
||||
type: string
|
||||
format: date-time
|
||||
readOnly: true
|
||||
CCXCourse:
|
||||
required:
|
||||
- master_course_id
|
||||
|
||||
@@ -9,7 +9,6 @@ Studio.
|
||||
:maxdepth: 2
|
||||
|
||||
lms/modules
|
||||
lms/djangoapps/badges/modules
|
||||
lms/djangoapps/branding/modules
|
||||
lms/djangoapps/bulk_email/modules
|
||||
lms/djangoapps/courseware/modules
|
||||
|
||||
Reference in New Issue
Block a user