Hot Reload the OpenApi Document #1870
Conversation
class
|
This will also hot reload only the runtimeconfig section in the openapi doc? If rest.enabled changes from true to false, will the openapi doc no longer be available? |
| @@ -0,0 +1,69 @@ | |||
| // Copyright (c) Microsoft Corporation. | |||
There was a problem hiding this comment.
why is this class being shown as newly added, this was already a part of your last PR that got merged.
| @@ -79,10 +79,10 @@ public void ConfigureServices(IServiceCollection services) | |||
| null); | |||
| IFileSystem fileSystem = new FileSystem(); | |||
| FileSystemRuntimeConfigLoader configLoader = new(fileSystem, configFileName, connectionString); | |||
| services.AddSingleton<IOpenApiDocumentor, OpenApiDocumentor>(); | |||
There was a problem hiding this comment.
Add a check to make sure we do this only when Rest is enabled. ref: https://github.com/Azure/data-api-builder/pull/1872/files
| response = await client.SendAsync(request); | ||
| Assert.IsTrue(response.StatusCode is HttpStatusCode.OK); | ||
| // overwrites the changes we made when hot reloading | ||
| fileSystem.File.WriteAllText(configFilePath, config.ToJson()); |
There was a problem hiding this comment.
what is the use of this last line in testing?
| @@ -166,8 +167,9 @@ public void CreateDocument() | |||
| private OpenApiPaths BuildPaths() | |||
| { | |||
| OpenApiPaths pathsCollection = new(); | |||
| RuntimeConfig config = _configProvider.GetConfig(); | |||
There was a problem hiding this comment.
should we pass the config here from CreateDocument() ? is there a possibility the config that is sourced in CreateDocument() is different than the config sourced in BuildPaths()?
Why make this change?
Part of the ongoing work for #67
this closes #1869
This change will reload the open api docs during a hot reload scenario.
What is this change?
Update the documentor class to get a new runtimeconfig rather than storing one internally. Then add a documentor to the runtimconfig provider, and pass it into the config file watcher. We then can call the create document function when we are hot reloading.
How was this tested?
Testing is still needed. Will keep as draft until tested.
Sample Request(s)