Add an OpenAPI/AsyncAPI ecosystem profile

Ouverte
  • Quelque chose ne va pas ?
#87 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Les mainteneurs répondent en général sous 1 jour

Personne n'a encore pris cette issue.

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
55/100
Type d'issue
Fonctionnalité
Clarté
Clairement spécifiée
Activité
Active
Stack technique
github-actions, json, openapi, python, yaml
Domaine
api, testing, tooling

Piste de recherche

Read the existing ecosystem profile and contract tests, especially project_validator/ecosystems/ modules, tests/test_go.py, and tests/test_ecosystem_contract.py; inspect fixture layouts in tests/support.py. Implement and register the profile in project_validator/ecosystems/openapi.py, then update fixtures, profile tests, snapshots, and the README “Applies to” column. Done when the well configured fixture passes applicable checks and the bare fixture passes none of this ecosystem’s practices.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

Profile

Recognised by intent (#63): a top-level openapi: or asyncapi: key in a YAML or JSON file. Supplies the schema practices from #85.

Practice Rule for this ecosystem
schema-declared the openapi / asyncapi version is 3.0 or later (3.1 for full JSON Schema), and info.version is set
schema-validation CI lints the description: spectral (.spectral.yaml), redocly lint, vacuum
schema-examples operations have examples, and CI checks them (spectral's oas3-valid-*-example rules) or runs contract tests (schemathesis, dredd)
schema-compatibility CI checks for breaking changes: oasdiff breaking, openapi-diff

Definition of done

  • One profile module, project_validator/ecosystems/openapi.py, registered in BUILT_IN. Nothing in project_validator/checks/ changes: a row marked later belongs to a check that does not exist yet and is recorded on that check's issue.
  • tests/fixtures/well_configured_openapi passes every check that applies to it, and tests/fixtures/bare_openapi passes none of the ecosystem's practices (tests/test_ecosystem_contract.py). Snapshots recorded with UPDATE_SNAPSHOTS=1.
  • A project layout in tests/support.py, profile tests like tests/test_go.py, and the README "Applies to" column (tests/test_documentation.py).
  • A practice with no good evidence for this ecosystem is left out (the check reports SKIP) rather than judged by weak evidence.
Langage dominant
Python
Étoiles
4
Forks
1
Merge moyen
10 h 41 min
PR mergées (30 j)
79

Préparer son environnement

Ce projet ne fournit ni conteneur de développement, ni Dockerfile, ni guide de contribution : l'installation est à votre charge. Commencez par son README, et consultez notre guide de la première contribution pour les étapes générales.

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de cpp-best-practices/project_validator

Toutes les issues de cpp-best-practices/project_validator

Issues similaires

Plus d'issues Python

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.