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

feat(agora): add OpenAPI description and docs site #2766

Merged
merged 5 commits into from
Aug 21, 2024
Merged

feat(agora): add OpenAPI description and docs site #2766

merged 5 commits into from
Aug 21, 2024

Conversation

tschaffter
Copy link
Member

@tschaffter tschaffter commented Aug 20, 2024 •
edited
Loading

Fixed #2765

Changelogs

  • Add the project agora-api-description
  • Add the project agora-api-docs

Note

Port numbers will be changed in the future. For now they are using the same values as MODEL-AD.

Preview

Build the OpenAPI description:

nx build agora-api-description

Build the Docker image of the docs site:

nx build-image agora-api-docs

Start the docs site:

nx serve-detach agora-api-docs

Navigate to localhost:8010 in your browser:

image

@tschaffter tschaffter self-assigned this Aug 20, 2024
@tschaffter tschaffter marked this pull request as ready for review August 20, 2024 23:50
@tschaffter tschaffter requested a review from a team as a code owner August 20, 2024 23:50
sagely1
sagely1 approved these changes Aug 21, 2024
View reviewed changes
Copy link
Contributor

@sagely1 sagely1 left a comment

Choose a reason for hiding this comment

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

Looks great!
Agora REST API docs show up on localhost:8010 as expected!

@tschaffter tschaffter merged commit 0313887 into Sage-Bionetworks:main Aug 21, 2024
8 of 9 checks passed
@tschaffter tschaffter deleted the agora/add-api-description branch August 21, 2024 01:20
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@sagely1 sagely1 sagely1 approved these changes

Assignees

@tschaffter tschaffter

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.

[Story] Add OpenAPI description project to Agora
2 participants
@tschaffter @sagely1