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.

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

Change root path for API to display an informative landing message/page #199

Closed
alyssadai opened this issue Oct 12, 2023 · 4 comments · Fixed by #286
Closed

Change root path for API to display an informative landing message/page #199

alyssadai opened this issue Oct 12, 2023 · 4 comments · Fixed by #286
Labels
feat:add The first minimal viable change that implements a new functionality. good first issue Good issue for a new contributor. importance:medium We will address this but will delay for higher priority items. PR welcome Issue that is not an internal priority, but external PRs to address it are welcome. released This issue/pull request has been released. type:feature Effort to deliver new features, feature changes & improvements

Comments

@alyssadai
Copy link
Contributor

alyssadai commented Oct 12, 2023

Currently, navigating to the root of the API (/) displays a {"detail": "not found"} message by default.

We want to update our path config in FastAPI to instead show a page that displays a simple welcome message and directs users to visit the API docs for more information should be sufficient, e.g.:

Welcome to the Neurobagel REST API!

Please visit the documentation at /docs to view available API endpoints.

(If /docs part could be made a link to the <base-url>/docs, that would also be cool but is not a necessity.)

@alyssadai alyssadai added feat:add The first minimal viable change that implements a new functionality. type:feature Effort to deliver new features, feature changes & improvements labels Oct 12, 2023
@alyssadai alyssadai added the importance:medium We will address this but will delay for higher priority items. label Oct 12, 2023
Copy link

We want to keep our issues up to date and active. This issue hasn't seen any activity in the last 75 days.
We have applied the _flag:stale label to indicate that this issue should be reviewed again.
When you review, please reread the spec and then apply one of these three options:

  • prioritize: apply the flag:schedule label to suggest moving this issue into the backlog now
  • close: if the issue is no longer relevant, explain why (give others a chance to reply) and then close.
  • archive: sometimes an issue has important information or ideas but we won't work on it soon. In this case
    apply the someday label to show that this won't be prioritized. The stalebot will ignore issues with this
    label in the future. Use sparingly!

@github-actions github-actions bot added the _flag:stale [BOT ONLY] Flag issue that hasn't been updated in a while and needs to be triaged again label Dec 27, 2023
@alyssadai alyssadai added PR welcome Issue that is not an internal priority, but external PRs to address it are welcome. good first issue Good issue for a new contributor. labels Mar 7, 2024
@samadpls
Copy link
Contributor

samadpls commented Mar 7, 2024

Hi @alyssadai , can i work on this task :)

@github-actions github-actions bot removed the _flag:stale [BOT ONLY] Flag issue that hasn't been updated in a while and needs to be triaged again label Mar 8, 2024
@alyssadai
Copy link
Contributor Author

Hi @samadpls, we'd be happy for you to open a PR!

I've updated the issue description with a bit more detail on what we're looking for. Feel free to let me know if further clarification is needed.

@surchs
Copy link
Contributor

surchs commented Apr 11, 2024

🚀 Issue was released in v0.2.0 🚀

@surchs surchs added the released This issue/pull request has been released. label Apr 11, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
feat:add The first minimal viable change that implements a new functionality. good first issue Good issue for a new contributor. importance:medium We will address this but will delay for higher priority items. PR welcome Issue that is not an internal priority, but external PRs to address it are welcome. released This issue/pull request has been released. type:feature Effort to deliver new features, feature changes & improvements
Projects
Archived in project
Development

Successfully merging a pull request may close this issue.

3 participants