Azure / Azure/azure-openapi-validator

Ability to build ARM summary report

Offen
#421 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen
Vorherrschende Sprache
TypeScript
Sterne
53
Forks
57
Ø Merge
1 T. 23 Std.
Gemergte PRs (30 T.)
2

Beschreibung

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

Beitragsleitfaden

Beitragsleitfaden öffnen

Rechercherichtung

Beginne damit, die Linter-Ausgabe und die Implementierungen der Regeln nachzuverfolgen, und untersuche anschließend, wie Swagger-Pfade und -Operationen besucht werden. Als abgeschlossen gilt die Erstellung der angeforderten Zusammenfassung pro RT mit Regelanzahlen sowie das Hinzufügen von genügend RT- oder Namespace-Kontext und Meldungen zu bestandenen Regeln, um die API-Überprüfung zu unterstützen.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
typescript
Bereich
api, tooling
Issue-Typ
Feature
Schwierigkeit
5/5
Geschätzter Aufwand
Über eine Woche
Aktivitätsstatus
Veraltet
Klarheit
Muss geklärt werden
Anfängerfreundlichkeit
25/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.