OpenAPITools / OpenAPITools/openapi-generator-cli
[Feature Request] Add authentication options for the repository configuration of the openapitools.json
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- TypeScript
- Sterne
- 2k
- Forks
- 208
- Ø Merge
- 7 Std. 12 Min.
- Gemergte PRs (30 T.)
- 6
Beschreibung
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...
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginnen Sie mit apps/generator-cli/src/README.md und apps/generator-cli/src/config.schema.json, um die dokumentierten und validierten Repository-Optionen zu verstehen. Verfolgen Sie die Verarbeitung der Repository-Konfiguration ausgehend von den Paketeinstiegspunkten, und legen Sie anschließend fest, wie Zugangsdaten sicher bereitgestellt werden, unterstützen Sie authentifizierte Abfrage- und Download-Anfragen und dokumentieren Sie die Konfiguration und Verwendung, wenn beide Vorgänge mit einem privaten Repository funktionieren.
Vom Indexierungsmodell aus dem Issue-Text verfasst.
Bewertung
- Tech-Stack
- typescript
- Bereich
- authentication, cli, documentation
- Issue-Typ
- Feature
- Schwierigkeit
- 4/5
- Geschätzter Aufwand
- 3-5 Tage
- Aktivitätsstatus
- Veraltet
- Klarheit
- Größtenteils klar
- Anfängerfreundlichkeit
- 38/100