Update openapi template #323
Conversation
| license : | ||
| name : "Apache 2.0" | ||
| url : "http://www.apache.org/licenses/LICENSE-2.0.html" | ||
|
|
||
| servers : | ||
| - url : "{basePath}/{apiVersion}" |
There was a problem hiding this comment.
The basePath variable is referenced from all swagger annotations.
There was a problem hiding this comment.
@andrescrz Is this inline documentation in Java ? Because it is being rendered correctly in the docs: https://www.comet.com/docs/opik/reference/rest_api/find-experiments
There was a problem hiding this comment.
No, that's actually the source of truth. The whole OpenAPI spec is generated from the swagger annotations in the Java code.
This affects the generated openapi.yaml file which is served in localhost:3003.
I just checked and the missing variables are just ignored and it works well there. But you should clean up the old references.
After that, you just need to double check how the Fern generation is affected and if all is good in the auto-generated code of the SDK.
After those two are ok, you should be good to go.
There was a problem hiding this comment.
I have checked that the Fern SDK code is generated correctly (no diffs in the output code and trace logged correctly), I will go ahead and merge the change
There was a problem hiding this comment.
Great that you tested it and no issues, so fine to moved ahead with this. But I don't think it's right to leave the annotations in the Java code pointing to an deleted variable (basePath). I recommend cleaning those up in a follow up PR. It's a trivial change, just find a replace everywhere plus checking that all good after.
Details
Updates the openapi template used by the backend, this is needed for the docs