micronaut-projects / micronaut-projects/micronaut-openapi

Config in application.yml has no effect with ksp

Open Beginner friendly
#2,729 2 comments 0 reactions 0 assignees View on GitHub
type: bug
Dominant language
Java
Stars
114
Forks
121
Avg merge
2d 17h
Merged PRs (30d)
25

Description

### Expected Behavior

[The documentation](https://micronaut-projects.github.io/micronaut-openapi/6.20.0/guide/index.html#applicationConfiguration) refers to `application.yml` as being a possible configuration source for Micronaut OpenAPI processing.

Unfortunately this has no effect when using KSP. A warning should be added to the documentation about it.

There should also be an example of the most elegant configuration when using KSP e.g.

```
ksp {
arg("micronaut.openapi.project.dir", projectDir.toString())
arg("micronaut.openapi.property.naming.strategy", "SNAKE_CASE")
}
```

### Actual Behaviour

_No response_

### Steps To Reproduce

_No response_

### Environment Information

_No response_

### Example Application

_No response_

### Version

5.0.0

Contributor guide

No contributing guide indexed for this repository

Research direction

Open the linked applicationConfiguration section in the Micronaut OpenAPI guide and review how configuration sources are documented. Add a warning that application.yml has no effect with KSP, include the shown ksp arg example, and verify the resulting documentation clearly identifies the KSP configuration path.

Written by the indexing model from the issue text.

Assessment

Tech stack
kotlin
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Quiet
Clarity
Mostly clear
Newbie friendliness
68/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.