Created by: mkusaka
This PR allows we to write global settings for api clients.
Prior to this, we had to write the following for each api client (tag), which is a bit verbose.
import {
Configuration,
ClientAApi,
ClientBApi,
ClientCApi,
} from "./generated";
// custom config
const config = new Configuration({
credentials: "include",
});
export const clientA = new ClientAApi(config);
export const clientB = new ClientBApi(config);
export const clientC = new ClientCApi(config);
After this change, it can be written simply as follows.
import {
Configuration,
ClientAApi,
ClientBApi,
ClientCApi,
DefaultConfig,
} from "./generated";
// custom config
DefaultConfig.config = new Configuration({
credentials: "include",
});
export const clientA = new ClientAApi();
export const clientB = new ClientBApi();
export const clientC = new ClientCApi();
Also, custom configuration for specific client still configurable.
I think this is not breaking change, so I didn't add any new options to this change.
PR checklist
-
Read the contribution guidelines. -
Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community. -
Run the following to build the project and update samples: ./mvnw clean package ./bin/generate-samples.sh ./bin/utils/export_docs_generators.sh
./bin/generate-samples.sh bin/configs/java*
. For Windows users, please run the script in Git BASH. -
If your PR is targeting a particular programming language, @mention the technical committee members, so they are more likely to review the pull request.
@TiFu (2017/07) @taxpon (2017/07) @sebastianhaas (2017/07) @kenisteward (2017/07) @Vrolijkx (2017/09) @macjohnny (2018/01) @topce (2018/10) @akehir (2019/07) @petejohansonxo (2019/11) @amakhrov (2020/02) @davidgamero (2022/03)