Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

Document the things #97

Open
A1Liu opened this issue Jan 24, 2022 · 2 comments
Open

Document the things #97

A1Liu opened this issue Jan 24, 2022 · 2 comments
Milestone
code health

Comments

@A1Liu
Copy link
Collaborator

A1Liu commented Jan 24, 2022 •
edited

I added more endpoints, but DIDN'T DOCUMENT ANY OF THEM. Also I keep forgetting to document stuff generally tbh.

  • Courses endpoint has a full query parameter to get stuff like description
  • There's a "current semester" endpoint which, as one would guess, gets the current semester

Note: this is for improving the generated OpenApi documentation, NOT for documenting code. That's a separate task.
@A1Liu A1Liu added this to the code health milestone Oct 11, 2022
@A1Liu
Copy link
Collaborator Author

A1Liu commented Oct 18, 2022

NOTE: Now that Schedge is using Javalin 5, the OpenAPI plugin requires accessor methods to work.

@A1Liu A1Liu modified the milestones: code health, v2 Nov 14, 2022
@A1Liu
Copy link
Collaborator Author

A1Liu commented Nov 21, 2022

  • Nullability using @NotNull
  • Examples using OpenApiExample

@A1Liu A1Liu modified the milestones: v2, code health Jan 16, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees
No one assigned
Labels
None yet
Projects
None yet
Milestone
code health
Development

No branches or pull requests
1 participant
@A1Liu