Skip to content

docs: Provide meaning of course codes - #437

Open
limlindsayj wants to merge 1 commit into
mainfrom
websoc-docs-course-code-meaning
Open

limlindsayj wants to merge 1 commit into
mainfrom
websoc-docs-course-code-meaning

Conversation

@limlindsayj

Copy link
Copy Markdown
Contributor

Description

Added openapi descriptions to excludeRestrictionCode and restriction.

Related Issue

#418

Motivation and Context

Currently there is no description or context for these in the schema. It is helpful to have a list of what these restriction codes mean in the description, or you would have to look it up yourself in websoc.

How Has This Been Tested?

Screenshots (if appropriate):

Types of changes

  • Bug fix (non-breaking change which fixes an issue)
  • New feature (non-breaking change which adds functionality)
  • Breaking change (fix or feature that would cause existing functionality to change)

Checklist:

  • My code involves a change to the database schema.
  • My code requires a change to the documentation.

@laggycomputer laggycomputer left a comment

Copy link
Copy Markdown
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

  • Not sure why Wrangler is being addled with again (I'm sure something strange happened). Please revert.
  • We're pasting in a somewhat critical string in two different places. Try not to repeat it: use a constant string, shared Zod schema, OpenAPI type reference, or something else.
  • I don't exactly want to be responsible for the ground truth. What are your thoughts on just linking the WebSoc pages which lists these meanings?

This branch was successfully deployed

1 active deployment
staging-437 — 8fc1ff8e Deployed Jun 9, 2026 by limlindsayj via Deploy API to staging #1226
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants