Proposal: Create new repo for openapi tests, similar to json schema test suite
Les mainteneurs répondent en général sous 1 jour
Personne n'a encore pris cette issue.
Évaluation
- Difficulté
- 5/5
- Temps estimé
- Plus d'une semaine
- Accessibilité débutants
- 25/100
Piste de recherche
Commencez par examiner les tests existants dans OAI/OpenAPI-Specification/tests/v3.1 et la JSON Schema Test Suite, y compris le travail référencé sur int64. Définissez la structure du dépôt, les versions d’OpenAPI prises en charge, le format des tests et les attentes en matière de conformité avant l’implémentation. La tâche est terminée lorsque les questions ouvertes de la proposition sont résolues et qu’un plan délimité existe pour le nouveau dépôt de tests.
Rédigé par le modèle d'indexation à partir du texte de l'issue.
Description
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:
- create a new repo, Openapi Test Suite in the https://github.com/OAI org
- have one folder for each version of the openapi test suite
- move the existing tests into that
- perhaps organize the tests in the same directory structure as the openap spec?
- add tests in components/schemas/format.json which includes the int64 format tests in: https://github.com/json-schema-org/JSON-Schema-Test-Suite/pull/711
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?)
- Langage dominant
- Markdown
- Étoiles
- 31.2k
- Forks
- 9.2k
- Merge moyen
- 2 j 9 h
- PR mergées (30 j)
- 17
Préparer son environnement
- Aucun Dockerfile ni fichier Docker Compose
- Propose un modèle de pull request
- Lire le guide de contribution
Par où commencer
- Lisez l'issue en entier, puis le guide de contribution du projet.
- Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
- Forkez le dépôt et travaillez sur une branche.
- Ouvrez une pull request qui référence le numéro de l'issue.
Autres issues de OAI/OpenAPI-Specification
-
Housekeeping
Difficulté 1/5 Moins d'une heure Accessibilité débutants 45/100
OAI/OpenAPI-Specification#5566 ·
Les mainteneurs répondent en général sous 1 jour
-
Housekeeping
Difficulté 1/5 Moins d'une heure Accessibilité débutants 35/100
OAI/OpenAPI-Specification#5562 · 4 commentaires ·
Les mainteneurs répondent en général sous 1 jour
-
Housekeeping
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 10/100
OAI/OpenAPI-Specification#5556 · 3 commentaires ·
Les mainteneurs répondent en général sous 1 jour
-
v3.2.1 releasePeut-être à nouveau libre @lornajane l’a pris il y a 33 jours, et aucune pull request n’est ouverte. Ouverte
OAI/OpenAPI-Specification#5460 · 11 commentaires · 1 réaction · 1 personne assignée ·
Les mainteneurs répondent en général sous 1 jour
-
param serialization
Difficulté 5/5 Plus d'une semaine Accessibilité débutants 25/100
OAI/OpenAPI-Specification#5366 · 12 commentaires ·
Les mainteneurs répondent en général sous 1 jour
Toutes les issues de OAI/OpenAPI-Specification
Issues similaires
-
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
-
bug
Difficulté 2/5 1-3 heures Accessibilité débutants 72/100
topoteretes/cognee#5773 ·
Les mainteneurs répondent en général sous 1 jour
-
Difficulté 2/5 1-3 heures Accessibilité débutants 70/100
NaturalIntelligence/fast-xml-parser#890 · 1 commentaire ·
Les mainteneurs répondent en général sous 3 jours
-
enhancement
Difficulté 1/5 Moins d'une heure Accessibilité débutants 85/100
FujiNetWIFI/fujinet-lib#122 · 1 commentaire ·
Les mainteneurs répondent en général sous 1 jour
-
effort: low prio: low ready
Difficulté 2/5 1-3 heures Accessibilité débutants 82/100
digitalfabrik/integreat-cms#4616 ·
Les mainteneurs répondent en général sous 5 jours