How to change the name of the OpenAPI saved document

[paulomorgado]

When using something like

builder.Services.AddOpenApi("weather", options =>
{
    options.OpenApiVersion = OpenApiSpecVersion.OpenApi3_0;
});

and using

<PropertyGroup>
   <OpenApiDocumentsDirectory>../contracts</OpenApiDocumentsDirectory>
</PropertyGroup>

The file seems to be saved as <assembly name>_<document name>.json, but I would like it to be something like <document name>.openapi.json.

Is that possible without having to rename the file after generation?

[paulomorgado]

Found this

Generate OpenAPI documents - Modify the output file name

<PropertyGroup>
  <OpenApiGenerateDocumentsOptions>
    --file-name my-open-api
  </OpenApiGenerateDocumentsOptions>
</PropertyGroup>

But it only changes the base name.

[vst121]

This is not a bug or misconfiguration. It’s a deliberate limitation of the OpenAPI generation tooling. If you need a different final name, a post-build rename step is still required.

[paulomorgado]

This is not a bug or misconfiguration. It’s a deliberate limitation of the OpenAPI generation tooling. If you need a different final name, a post-build rename step is still required.

If it is deliberate, what is the reason behind that?

[vst121]

As I know, it’s designed that way to ensure consistency, correctness, and safety across all generated code.
The limitation exists to avoid subtle bugs, ensure safe code generation, and make regeneration predictable. It’s less about restricting users and more about keeping the generator reliable.

[paulomorgado]

As I know, it’s designed that way to ensure consistency, correctness, and safety across all generated code. The limitation exists to avoid subtle bugs, ensure safe code generation, and make regeneration predictable. It’s less about restricting users and more about keeping the generator reliable.

I'm sorry, @vst121, but I see no reason there.

Is this an official answer?