Azure / Azure/azure-openapi-validator

Ability to build ARM summary report

Aperta
#421 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
Lingua principale
TypeScript
Stelle
53
Fork
57
Merge medio
1g 23h
PR unite (30g)
2

Descrizione

To build confidence in the linter automation we need a summary report in the following format that can be the starting place for API reviewers to review the PRs.

For each RT

RPC category | #rules | #applicable | #success | #fail
-- | -- | -- | -- | --
RPC-V1-PUT | 22 | 22 | 20 | 2
RPC-V1-PATCH | 11 | 0 | 0 | 0
  |   |   |   |  

we need to investigate how to fix below issues:
1. the linter output message should include the RT and/or Namespace field , so we may need to update some rules implementation to relate the swagger paths with the rule
3. Linter should output message for each passed linter rule execution (currently there is no message for passed rules)
then we can generate a result base on the linter output message
4. some rules are implemented as only finding the violations of swagger greedily, so they don't have chance to visit all the swagger paths/operations and these rules need to be re-implemented

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Inizia tracciando l’output del linter e le implementazioni delle regole, quindi esamina come vengono visitati i percorsi e le operazioni Swagger. Il lavoro è completato quando viene prodotto il riepilogo richiesto per RT con i conteggi delle regole e vengono aggiunti un contesto RT o namespace sufficiente e i messaggi delle regole superate per supportare la revisione dell’API.

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

Valutazione

Stack tecnologico
typescript
Ambito
api, tooling
Tipo di issue
Funzionalità
Difficoltà
5/5
Tempo stimato
Più di una settimana
Stato di attività
Ferma
Chiarezza
Da chiarire
Idoneità per principianti
25/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.