Correct Course Catalog API Documentation

Description

The documentation for the Course Catalog API list the wrong data types. Update it to use the correct ones.

Original Request
Hey - Got this question from Degreed

_________________________________________________________________

Hi Mike, after spending some time writing code against the API, here are some things we ran into and some questions as well.
路 Some of the fields were documented as returning an array of objects, but would only return a single instance:

  • person.profile_image

  • organization.logo_image

  • course_runs.image

  • course_runs.video

路 I was hoping to see a way to change the number of items that would be returned by the API without having to use a regex/string replacement on the next URL. It takes a while to get all 451 courses when we can only retrieve them in batches of 20. Is there a way we could retrieve them in larger batches? Or in a single call? Or is there a constraint on the system that makes retrieving them in these smaller batches the most performant solution?

路 Is there a chance the titles/descriptions of courses could contain markup? Or is it guaranteed to contain just text?

How do I respond?

Thanks

Mike

Steps to Reproduce

None

Current Behavior

None

Expected Behavior

None

Reason for Variance

None

Release Notes

None

User Impact Summary

None

Assignee

Unassigned

Reporter

MichaelC

Labels

None

Reach

None

Impact

None

Platform Area

None

Customer

None

Partner Manager

None

URL

None

Contributor Name

None

Groups with Read-Only Access

None

Actual Points

None

Category of Work

None

Platform Map Area (Levels 1 & 2)

None

Platform Map Area (Levels 3 & 4)

None

Epic Link

Sprint

None

Priority

CAT-3
Configure