Add an OpenAPI/AsyncAPI ecosystem profile

Đang mở
  • Có gì không ổn?
#87 0 bình luận 0 reaction 0 người được giao Xem trên GitHub

Maintainer thường phản hồi trong vòng 1 ngày

Chưa có ai nhận issue này.

Đánh giá

Độ khó
4/5
Thời gian dự kiến
3-5 ngày
Mức phù hợp với người mới
55/100
Loại issue
Tính năng
Độ rõ ràng
Đặc tả rõ ràng
Mức độ hoạt động
Sôi nổi
Công nghệ
github-actions, json, openapi, python, yaml
Lĩnh vực
api, testing, tooling

Hướng nghiên cứu

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.

Do mô hình lập chỉ mục viết ra từ nội dung của issue.

Mô tả

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.
Ngôn ngữ chính
Python
Star
4
Fork
1
Merge trung bình
10 giờ 41 phút
Pull request đã merge (30 ngày)
79

Chuẩn bị môi trường

Dự án này không cung cấp dev container, Dockerfile hay hướng dẫn đóng góp, nên bạn cần tự thiết lập môi trường: hãy bắt đầu từ README và xem hướng dẫn đóng góp lần đầu của chúng tôi để biết các bước chung.

Bắt đầu từ đâu

  1. Đọc hết issue, rồi đọc hướng dẫn đóng góp của dự án.
  2. Bình luận trên issue rằng bạn sẽ nhận — tránh hai người làm cùng một việc.
  3. Fork repository và làm thay đổi trên một nhánh.
  4. Mở pull request có tham chiếu số hiệu của issue.

Issue khác của cpp-best-practices/project_validator

Tất cả issue của cpp-best-practices/project_validator

Issue tương tự

Thêm issue về Python

Nhận issue mới trong hộp thư của bạn

Bản tóm tắt ngắn những issue GitHub phù hợp với người mới.