Set OpenApiServers object in document

[captainsafia]

Closes #56188 by setting servers property in local development based on metadata in IServerAddressFeature.

[captainsafia]

I've temporarily reverted readOnly support from this PR in reaction to some questions about how we might evolve readOnly in OpenAPI v3.1.

In OpenAPI v3.0, when readOnly is applied on a property that is in the required list, it's requiredness will only be validated for response types.

If the property is marked as readOnly being true and is in the required list, the required will take effect on the response only.

In OpenAPI v3.1, we rely on JSON schema rules which don't enable similar validation on readOnly. We'll need to revisit how we want to bake in this behavior into the implementation at a later time.

[captainsafia]

/azp run

[azure-pipelines]

Azure Pipelines successfully started running 3 pipeline(s).

[BrennanConroy]

What's restricting this to development mode? Is it safe to include the server address(es) in a document that users can query?

Update the PR description so the readonly issue isn't closed 😄

[captainsafia]

What's restricting this to development mode? Is it safe to include the server address(es) in a document that users can query?

Added an explicit check for the host environment here. This should achieve the desired goal of only settings the servers attribute for local scenarios where you might want to use something like Swagger UI or Postman to do E2E testing.

[BrennanConroy]

nit: I didn't notice a test with multiple addresses?

[captainsafia]

nit: I didn't notice a test with multiple addresses?

Just added one.

[heedfull]

Is there a way to get your servers to show when the environment is Production?
I need the servers so that the workaround below for running behind a reverse proxy works.

scalar/scalar#4381 (comment)

[martincostello]

One way you can do it is using my OpenAPI extensions library, which includes a document transformer that adds the servers to the document for Production via an opt-in setting.

If you don't want to use that, then you'll need to implement your own document transformer to do it.