Add an OpenAPI/AsyncAPI ecosystem profile

Offen
  • Stimmt etwas nicht?
#87 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Maintainer antworten meist innerhalb von 1 Tag

Dieses Issue hat noch niemand übernommen.

Bewertung

Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Anfängerfreundlichkeit
55/100
Issue-Typ
Feature
Klarheit
Klar beschrieben
Aktivitätsstatus
Aktiv
Tech-Stack
github-actions, json, openapi, python, yaml
Bereich
api, testing, tooling

Rechercherichtung

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.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Beschreibung

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.
Vorherrschende Sprache
Python
Sterne
4
Forks
1
Ø Merge
10 Std. 41 Min.
Gemergte PRs (30 T.)
79

Entwicklungsumgebung

Dieses Projekt bietet weder Dev-Container noch Dockerfile noch Beitragsleitfaden – die Einrichtung liegt bei Ihnen. Beginnen Sie mit der README; die allgemeinen Schritte stehen in unserem Leitfaden für den ersten Beitrag.

Erste Schritte

  1. Lesen Sie das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreiben Sie ins Issue, dass Sie es übernehmen — das erspart doppelte Arbeit.
  3. Forken Sie das Repository und arbeiten Sie in einem Branch.
  4. Öffnen Sie einen Pull Request, der die Issue-Nummer nennt.

Mehr aus cpp-best-practices/project_validator

Alle Issues in cpp-best-practices/project_validator

Ähnliche Issues

Weitere Issues zu Python

Neue Issues direkt in Ihr Postfach

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