Skip to content

V2 API Specification#68

Closed
Saoski wants to merge 48 commits into
release/v2-devfrom
dev/v2-api-specification
Closed

V2 API Specification#68
Saoski wants to merge 48 commits into
release/v2-devfrom
dev/v2-api-specification

Conversation

@Saoski

@Saoski Saoski commented May 31, 2025

Copy link
Copy Markdown
Member

Issue

Closes #67

Major Changes:

  • No major changes to code base
  • New Documentation for v1 and v2 APIs

Setup / How to Test:

  • Navigate to quackbox-api-docs\docs-v1\index.html (or the docs v2 folder) and you can view the HTML page (I used the Live Server VS Code extension)

Testing Considerations:

  • We need to verify that the v1 docs match the current implementation.
  • We need to implement v2 routes to match the documentation.
  • How can we display these pages? We should also add links to other versions of the API in the description section of the YAML file.

@Saoski Saoski added this to the V1.1 milestone May 31, 2025
@Saoski Saoski self-assigned this May 31, 2025
@Saoski Saoski added the documentation Improvements or additions to documentation label May 31, 2025
@Saoski Saoski linked an issue May 31, 2025 that may be closed by this pull request
2 tasks

@Matgenius04 Matgenius04 left a comment

Copy link
Copy Markdown
Collaborator

Choose a reason for hiding this comment

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

Overall, the documentation looks good! There are some super minor spelling mistakes I noticed.

I'm thinking of using GitHub Pages to host these, but it's a little bit tricky figuring out how to make everything work together nicely. I think if we're able to unify everything into one /docs folder from the root level directory with all the static assets for documentation, that'd be ideal.

NOTE: I have not actually validated whether the v1 or v2 APIs actually line up with what is described in the documentation.

Comment thread quackbox-api-docs/asyncapi-v1.yaml Outdated
Comment thread quackbox-api-docs/asyncapi-v2.yaml Outdated
Comment thread quackbox-api-docs/asyncapi-v2.yaml Outdated
Comment thread quackbox-api-docs/asyncapi-v2.yaml Outdated
Comment thread quackbox-api-docs/asyncapi-v1.yaml Outdated
Comment thread quackbox-api-docs/asyncapi-v2.yaml Outdated
@Saoski Saoski requested a review from Matgenius04 September 24, 2025 04:46
@Saoski Saoski marked this pull request as draft September 28, 2025 20:59
@Saoski

Saoski commented Sep 28, 2025

Copy link
Copy Markdown
Member Author

Before merging this, we need to host this documentation on GitHub pages.

@Saoski

Saoski commented Oct 19, 2025

Copy link
Copy Markdown
Member Author

I have read over the v1 docs and they seem consistent with the code

@Saoski

Saoski commented Oct 19, 2025

Copy link
Copy Markdown
Member Author

Documentation is on this site: https://rit-coms.github.io/COMS-Console/

@Saoski Saoski marked this pull request as ready for review October 19, 2025 20:53
@Saoski

Saoski commented Oct 19, 2025

Copy link
Copy Markdown
Member Author

I think the v2 routes should be implemented in a separate branch. This PR is ready for review.

Saoski and others added 4 commits October 21, 2025 18:39
Updated workflow to trigger on 'main' and 'release/v2-dev' branches on push.
Removed deployment step for GitHub Pages (This will be moved to another action).
@Saoski Saoski closed this Mar 9, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[Task] Create v2 API specification

2 participants