Skip to content

Incomplete instructions on FAQ #480

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

Closed
theoamonteiro opened this issue Mar 8, 2020 · 1 comment
Closed

Incomplete instructions on FAQ #480

theoamonteiro opened this issue Mar 8, 2020 · 1 comment
Labels
enhancement New feature or request

Comments

@theoamonteiro
Copy link

Describe the bug
I tried to follow the recommendations on "What is a proper way to set up Swagger UI to use provided spec.yml?". But my "APPLICATION FAILED TO START" because of a missing bean. The log recommended me to "defining a bean of type 'org.springdoc.core.SpringDocConfigProperties' in your configuration.".

To Reproduce
Steps to reproduce the behavior:

  • spring-boot: 2.2.5.RELEASE
  • org.springdoc:springdoc-openapi-ui:1.2.33

Follow the instructions on FAQ. The application is going to fail to start.

Screenshots
None

Expected behavior
The application should start and use the provided specs

Additional context
To fix is easy enough following the recommendation spring boot printed on the logs and also provide a bean:

@Bean
public SpringDocConfigProperties springDocConfigProperties() {
	return new SpringDocConfigProperties();
}

This should be on the FAQ.

@bnasslahsen
Copy link
Collaborator

@theoamonteiro,

In fact, you have found a regression.
The FAQ is correct and will be fixed for the next release: v1.2.34

bnasslahsen pushed a commit that referenced this issue Mar 8, 2020
@bnasslahsen bnasslahsen added the enhancement New feature or request label Jan 10, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request
Projects
None yet
Development

No branches or pull requests

2 participants