Hacktoberfest 2026：メンテナが10月に向けて印を付けた、オープンで初心者向けの issue。 Hacktoberfest の issue を見る

Proposal: Create new repo for openapi tests, similar to json schema test suite

オープン
  • 何か問題がありますか？
#3,486 コメント 3 件 リアクション 0 件 担当者 0 名 GitHub で見る

メンテナーはふだん 1 日以内に返信

まだ誰も着手していません。

評価

難易度
5/5
見積もり時間
1週間以上
初心者へのやさしさ
25/100
issue の種類
機能追加
明瞭さ
説明が足りない
活発さ
停滞
領域
api, testing

調査の方向性

まず、OAI/OpenAPI-Specification/tests/v3.1 にある既存のテストと JSON Schema Test Suite を確認し、参照されている int64 の作業も含めます。実装前に、リポジトリ構造、サポート対象の OpenAPI バージョン、テスト形式、適合性の期待事項を定義します。提案の未解決の疑問が解消され、新しいテストリポジトリについて範囲を定めた計画が存在すれば完了です。

索引モデルが issue の本文から書いたものです。

説明

Housekeeping

This issue is a proposal that a new repo be created that stores tests of openapi payloads, request, responses, and documents. These tests will help implementation verify that they have built features correctly.

There is existing prior work here that applies to json schema only in the json schema test suite: https://github.com/json-schema-org/JSON-Schema-Test-Suite

Need for this solution:

  • there are few tests here: https://github.com/OAI/OpenAPI-Specification/tree/main/tests/v3.1 and they do not provide full coverage for openapi features, they do not describe what is acceptable and unacceptable for openapi-only schema formats, they may not be well known in the community, they do not have coverage tests for different versions of the openapi spec
  • what is allowed for int32/int64/float/double is not explicitly defined in the spec or the format registry (for example is X.0 allowed in for int32?). Implementers need this info when building.
  • I attempted to add int64 tests into the json schema test suite and was told that that repo is not the right place for that test, because the format is openapi-specific and is not listed in the json schema spec.

Benefits:

  • tooling providers could have a verifiable way of proving that their implementation is conforming to the requirements
  • long term this should reduce the number of what is the correct way to implement x feature questions on this repo because you can point them to the existing test
  • including these tests in a separate repo will allow implmenters to include that repo as a subpackage and easily test against it. (I currently do this with the json schema test suite here)
  • General json schema 2020-12 tests should not be included here because they already exist in the json schema test suite. Refer users to that suite also. This reduces the maintenance workload.

Proposal Short Term:

I would be happy to add additional test for int32/float/double/int formats
@karenetheridge mentioned that she could contribute tests from https://github.com/karenetheridge/OpenAPI-Modern/tree/master/t

Open Questions:

  • How thorough should these tests be?
    • My proposal is to incrementally add coverage bit by bit starting with easiest tests, which may be component schema formats.
  • Are you okay using the json schema test suite format for the schema test files?
  • What openapi versions will have tests?
  • Do these tests mean that the tooling MUST/MAY/verb implement these features? (How does json schema handle this Julian Berman?)
主要言語
Markdown
スター
31.2k
フォーク
9.2k
平均マージ
2日 9時間
マージ済み PR（30日）
17

環境構築

はじめの一歩

  1. issue を最後まで読み、次にプロジェクトのコントリビューションガイドを読みます。
  2. 着手することを issue にコメントします — 二人が同じ作業をするのを防げます。
  3. リポジトリをフォークし、ブランチを切って変更します。
  4. issue 番号を参照したプルリクエストを送ります。

OAI/OpenAPI-Specification のほかの issue

OAI/OpenAPI-Specification の issue をすべて見る

似ている issue

Backend & API Design の issue をもっと見る

新しい issue をメールで受け取る

初心者向けの GitHub issue を短くまとめたダイジェスト。