You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.

issue_template.md 2.3 KiB

7 years ago
7 years ago
12345678910111213141516171819202122232425262728293031323334353637383940414243444546474849505152535455565758596061626364656667
  1. <!---
  2. Thanks for filing an issue 😄 ! Before you submit, please read the following:
  3. Search open/closed issues before submitting since someone might have asked the same thing before!
  4. Issues on GitHub are only related to problems of Swagger-UI itself. We'll try to offer support
  5. here for your use case, but we can't offer help with projects that use Swagger-UI indirectly,
  6. like Springfox or swagger-node.
  7. Likewise, we can't accept features or bugs in the Swagger/OpenAPI specifications themselves,
  8. or anything that violates the specifications.
  9. -->
  10. <!--- Provide a general summary of the issue in the title above -->
  11. <!---
  12. If you aren't sure what Swagger-UI version, see this guide: https://github.com/swagger-api/swagger-ui/blob/master/docs/version-detection.md
  13. --->
  14. | Q | A
  15. | ------------------------------- | -------
  16. | Bug or feature request? |
  17. | Which Swagger/OpenAPI version? |
  18. | Which Swagger-UI version? |
  19. | How did you install Swagger-UI? |
  20. | Which browser & version? |
  21. | Which operating system? |
  22. ### Demonstration API definition
  23. <!--- If you're describing a bug, please provide an API definition that reproduces your problem -->
  24. <!--- If you have link to a demo repo please link that! -->
  25. <!--- If your spec is large, please put it into a Gist (https://gist.github.com) instead of pasting it here. -->
  26. ```yaml
  27. your: "API definition goes here"
  28. ```
  29. ### Configuration (browser query string, constructor, config.yaml)
  30. <!--- If describing a bug, tell us what your configuration looks like -->
  31. ```js
  32. {
  33. "your": { "constructorConfig": "here" }
  34. }
  35. ```
  36. `?yourQueryStringConfig=here`
  37. ### Expected Behavior
  38. <!--- If you're describing a bug, tell us what should happen -->
  39. <!--- If you're suggesting a change/improvement, tell us how it should work -->
  40. ### Current Behavior
  41. <!--- If describing a bug, tell us what happens instead of the expected behavior -->
  42. <!--- If suggesting a change/improvement, explain the difference from current behavior -->
  43. ### Possible Solution
  44. <!--- Not obligatory, but suggest a fix/reason for the bug, -->
  45. <!--- or ideas how to implement the addition or change -->
  46. ### Context
  47. <!--- How has this issue affected you? What are you trying to accomplish? -->
  48. <!--- Providing context helps us come up with a solution that is most useful in the real world -->