OpenAPITools / OpenAPITools/openapi-generator-cli
[Feature Request] Add authentication options for the repository configuration of the openapitools.json
Nadie ha tomado este issue todavía.
- Lenguaje dominante
- TypeScript
- Estrellas
- 2k
- Forks
- 208
- Merge medio
- 7 h 12 min
- PR fusionados (30 d)
- 6
Descripción
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...
Guía de contribución
No hay ninguna guía de contribución indexada para este repositorio
Primeros pasos
- Lee el issue completo y luego la guía de contribución del proyecto.
- Comenta en el issue que vas a ocuparte — evita que dos personas hagan lo mismo.
- Haz un fork del repositorio y trabaja en una rama.
- Abre un pull request que haga referencia al número del issue.
Línea de trabajo
Comience por apps/generator-cli/src/README.md y apps/generator-cli/src/config.schema.json para entender las opciones del repositorio documentadas y validadas. Siga el manejo de la configuración del repositorio desde los puntos de entrada de los paquetes; después, defina cómo se proporcionan las credenciales de forma segura, admita solicitudes autenticadas de consulta y descarga, y documente la configuración y el uso cuando ambas operaciones funcionen con un repositorio privado.
Escrito por el modelo de indexación a partir del texto del issue.
Evaluación
- Stack tecnológico
- typescript
- Área
- authentication, cli, documentation
- Tipo de issue
- Nueva funcionalidad
- Dificultad
- 4/5
- Tiempo estimado
- 3-5 días
- Estado de actividad
- Estancado
- Claridad
- Bastante claro
- Aptitud para principiantes
- 38/100