Add an OpenAPI/AsyncAPI ecosystem profile

Aperta
  • Qualcosa non va?
#87 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 1 giorno

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
55/100
Tipo di issue
Funzionalità
Chiarezza
Specificata chiaramente
Stato di attività
Attiva
Stack tecnologico
github-actions, json, openapi, python, yaml
Ambito
api, testing, tooling

Direzione di ricerca

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.

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

Descrizione

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.
Lingua principale
Python
Stelle
4
Fork
1
Merge medio
10h 41m
PR unite (30g)
79

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di cpp-best-practices/project_validator

Tutte le issue di cpp-best-practices/project_validator

Issue simili

Altre issue su Python

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.