Azure / Azure/azure-openapi-validator
Ability to build ARM summary report
- Langage dominant
- TypeScript
- Étoiles
- 53
- Forks
- 57
- Merge moyen
- 1 j 23 h
- PR mergées (30 j)
- 2
Description
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
Guide de contribution
Ouvrir le guide de contribution
Piste de recherche
Commencez par suivre la sortie du linter et les implémentations des règles, puis examinez comment les chemins et les opérations Swagger sont parcourus. Le travail est terminé lorsque le résumé demandé par RT, avec les nombres de règles, est produit et que suffisamment de contexte RT ou namespace ainsi que des messages de règles validées sont ajoutés pour prendre en charge la revue de l’API.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Évaluation
- Stack technique
- typescript
- Domaine
- api, tooling
- Type d'issue
- Fonctionnalité
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Activité
- À l'abandon
- Clarté
- À clarifier
- Accessibilité débutants
- 25/100