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

Documentation route appears to be broken #837

Open
jay-tyler opened this issue Feb 9, 2020 · 4 comments
Open

Documentation route appears to be broken #837

jay-tyler opened this issue Feb 9, 2020 · 4 comments
Labels
bug

Comments

@jay-tyler
Copy link
Contributor

@jay-tyler jay-tyler commented Feb 9, 2020

Noticing on the quick start guide, for the happy_birthday.py example, the localhost:8000/documentation route appears to be broken (returning 404).

Perhaps I'm doing something wrong, but if not, we should fix the bug and/or the documentation. And maybe consider an integration test as part of our test suite to prevent a future regression.

@jay-tyler jay-tyler added the bug label Feb 9, 2020
@jay-tyler
Copy link
Contributor Author

@jay-tyler jay-tyler commented Feb 10, 2020

The simplest fix would be to return status 200 for the /documentation route.

But end users might want some additional functionality. This could include:

  1. Changing the documentation path, e.g. /docs etc
  2. Turning off documentation for status 404
@Pradhvan
Copy link

@Pradhvan Pradhvan commented Feb 24, 2020

@jay-tyler I can pick this up, if you're not already working on this. 😄

@jay-tyler
Copy link
Contributor Author

@jay-tyler jay-tyler commented Feb 25, 2020

@Pradhvan Thanks for the offer! Yes, feel free to.

I brought this up as a potential issue to work on for a PyCascades sprint, but we never quite decided what approach to take. There are a lot of little issues related to this. For instance

  • What if someone want the /documentation route to be something different? e.g. /docs or /api
  • What should we do for non-routes? Right now, any path like /asdfae will return the same stuff that /documentation will. We could consider turning this 404 functionality on/off via configuration.

You're welcome to try to address either of these, although you might want to discuss it here first. But if you simply want to make a change such that /documentation returns a status 200, that would be relatively straightforward and welcome

@Pradhvan
Copy link

@Pradhvan Pradhvan commented Feb 25, 2020

Hey! Since I am new to the whole hug codebase, let me first work my way through the problem of solving /documentation returning status code 200.

While working on the issue if I do come up with the idea of solving the other two mentioned problem would definitely discuss it here.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Linked pull requests

Successfully merging a pull request may close this issue.

None yet
2 participants
You can’t perform that action at this time.