hashicorp / hashicorp/terraform-plugin-codegen-openapi

Consider adjusting collection data sources default name

Aperta
#83 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

enhancement
Lingua principale
Go
Stelle
91
Fork
20
Merge medio
2g 13h
PR unite (30g)
1

Descrizione

Background

After #78 added support for collection data sources (by automatically creating a root SetNested or Set attribute), we decided to automatically set the name of the attribute to be the same as the data source name.

This may not be desired if the data source name has multiple words like aws_secretsmanager_secrets.

Possible solutions

  • Adjust the attribute name to split on underscore and take the last word
  • Add a configuration option to the generator config to allow a custom name:
Example
data_sources:
  petmanager_pets:
    read:
      path: /pet/findByStatus
      method: GET
    schema:
      collection_name: pets 

Guida per i contributori

Nessuna guida per i contributori indicizzata per questo repository

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Direzione di ricerca

Inizia individuando la generazione della sorgente dati della collection e la gestione della configurazione del generatore descritte nell’issue. Confronta i due approcci di denominazione proposti e l’esempio YAML, quindi conferma che il comportamento scelto produca il nome dell’attributo personalizzato previsto per le sorgenti dati composte da più parole.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Valutazione

Stack tecnologico
go, terraform
Ambito
tooling
Tipo di issue
Funzionalità
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
38/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.