OpenAPITools / OpenAPITools/openapi-generator-cli
[Feature Request] Add authentication options for the repository configuration of the openapitools.json
まだ誰も着手していません。
- 主要言語
- TypeScript
- スター
- 2k
- フォーク
- 208
- 平均マージ
- 7時間 12分
- マージ済み PR(30日)
- 6
説明
Currently it is possible to specify downloadUrl and queryUrl in the repository configuration block if a private repository should be used:
{
"$schema": "./node_modules/@openapitools/openapi-generator-cli/config.schema.json",
"spaces": 2,
"generator-cli": {
"version": "5.1.1",
"storageDir": "./openapitools-download",
"repository": {
"queryUrl": "https://artifactory.mycorp.com/maven-central/select?q=g:${group.id}+AND+a:${artifact.id}&core=gav&start=0&rows=200",
"downloadUrl": "https://artifactory.mycorp.com/maven-central/${groupId}/${artifactId}/${versionName}/${artifactId}-${versionName}.jar"
}
}
}
Unfortunately the artifact-storage of my organization requires login credentials and I can thus not use this option. It would be great if something like this could be added:
{
"generator-cli": {
"repository": {
"queryUrl": "https://artifactory.mycorp.com/maven-central/select?q=g:${group.id}+AND+a:${artifact.id}&core=gav&start=0&rows=200",
"downloadUrl": "https://artifactory.mycorp.com/maven-central/${groupId}/${artifactId}/${versionName}/${artifactId}-${versionName}.jar",
"username":"",
"password":"",
}
}
}
On a general note:
I think the documentation of these configuration options could be more extensive. I learned about the repository block via a comment on an issue as it is not in the README...
コントリビューションガイド
このリポジトリのコントリビューションガイドは索引されていません
はじめの一歩
- issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
- 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
- リポジトリをフォークし、ブランチを切って変更します。
- issue 番号を参照したプルリクエストを送ります。
調査の方向性
apps/generator-cli/src/README.md と apps/generator-cli/src/config.schema.json から始め、文書化および検証されているリポジトリオプションを理解します。パッケージのエントリポイントからリポジトリ設定の処理を追い、次に認証情報を安全に提供する方法を定義し、認証済みのクエリおよびダウンロードリクエストをサポートし、両方の操作がプライベートリポジトリで機能する場合の設定と使用方法を文書化します。
索引モデルが issue の本文から書いたものです。
評価
- 技術スタック
- typescript
- 領域
- authentication, cli, documentation
- issue の種類
- 機能追加
- 難易度
- 4/5
- 見積もり時間
- 3〜5日
- 活発さ
- 停滞
- 明瞭さ
- おおむね明確
- 初心者へのやさしさ
- 38/100