Repository navigation
Spell the Server in American English - #122
Merged
Merged
Conversation
Routes, error codes, enum values, JSON fields and schema names follow; the pull request lists them for the 0.2 release note. One migration renames two AccountMerges columns in place. The error-code census now reads every code the Server emits, and refuses a British spelling in a code or in the published contract.
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.
The Server is spelled in American English: code, comments, interface text, and everything it puts on the wire. The owner decided this for the whole product as a 0.2 change, and 0.2 is not compatible with 0.1.
What changes on the wire
This list goes into the 0.2 release note.
POST /activities/{idOrSlug}/enrolment/enrollmentPOST /lti/placements/{id}/roster/enrol/roster/enrollenrolment.closed,enrolment.password,enrolment.requiredenrollment.*theme.colourtheme.colorcancelled(499)canceled?state="cancelled""canceled"synchronisedsynchronizedanonymiseAfter,sourceAnonymisedAtanonymizeAfter,sourceAnonymizedAtEnrolInputDto,LocalisedLogoDto,RosterEnrolmentDto,ThemeColoursDto,ThemeColoursInputDtoServer and Client 0.2 have to be tagged together. Ops follows the moving
0tag, and a 0.2 Server beside a 0.1 Client answers the Client's enrollment with 404.The database
One migration,
americanSpelling, renames two columns ofAccountMergesand their index in place:No data moves. EF scaffolded exactly these three statements, which also shows that nothing else in the schema changed. The enums that were renamed (
Canceled,Synchronized) are stored as integers, so they need nothing. The manager role's seeded description has the new wording on a new installation and keeps its old text where it was already written.The error-code census missed 44 codes
ErrorCodeCensusTestslisted exception classes that do not exist and skippedForbiddenActionExceptionandUpstreamException. It dropped one-word codes, and it never read the codesProblemDetailsExceptionHandleranswers with for exceptions nobody raised. That is whyenrolment.*andcancelledwere never inerror-codes.json.error-codes.jsonholds 235 codes.openapi.jsonfor one: routes, fields and schema names, which the census does not see.Sabotaged: restoring
enrolment.closedin the source fails the drift test and the spelling test.Verified
dotnet build -warnaserror: no warnings.dotnet test: 970 of 970, with the new migration applied to a fresh database.openapi.jsonis byte-identical to what the running container serves:docker compose up, thencurl …/swagger.json, thendiff.scripts/check-american-english.pyin the workspace finds no British spelling outside the applied migrations, which are never edited.Consumers change in their own pull requests: the Client, both Runners' tests, and the Docs. The Runner's CI builds the Server from
main, so this one merges first.