Update AssignmentCalendar and Rubric docs for cleaner OpenAPI doc generation#2593
Open
battis wants to merge 3 commits intoinstructure:masterfrom
Open
Update AssignmentCalendar and Rubric docs for cleaner OpenAPI doc generation#2593battis wants to merge 3 commits intoinstructure:masterfrom
battis wants to merge 3 commits intoinstructure:masterfrom
Conversation
Generate parseable OpenAPI docs using new AccountCalendar model, rather than an arbitrary string
True, the result is generated by RubricImport, but the OpenAPI Model is named Rubric. Update should result in more parseable OpenAPI docs.
It is referenced in the Outcome model, but does not exist locally, which breaks documentation links and hinders parsing. It is already duplicated from RubricsApiController in AssignmentsApiController, and this improves consistency. (In an ideal world, we would be able to non-local models so RubricRating would only be defined once in RubricsApiController.)
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
I have an extensive list of places where the Canvas LMS API documentation includes text or values that that don't parse into clean OpenAPI specifications. Not a huge deal, but if the OpenAPI spec were cleaner, it would be easier to automate building a more complete, capable client. So this is my first test pass at tweaking the documentation.
I have tweaked three specific things:
AccountCalendarListto describe this result and updated the documentation.Test Plan: