IBM Validator `examples` Keyword as Disallowed in OpenAPI Schema

Ouverte
  • Quelque chose ne va pas ?
#747 2 commentaires 1 réaction 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
3/5
Temps estimé
1-2 jours
Accessibilité débutants
42/100
Type d'issue
Bug
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
javascript, openapi
Domaine
api, tooling

Piste de recherche

Commencez par exécuter IBM OpenAPI Validator sur le document OpenAPI 3.1.0 de l’issue et examinez la règle ibm-schema-keywords qui signale l’erreur. Vérifiez comment la règle gère le mot-clé examples au niveau du schéma ; le travail est terminé lorsque ce document valide ne signale plus examples comme interdit, sans casser la validation existante des mots-clés.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

Summary

The IBM OpenAPI Validator reports an error for the examples keyword in the OffsetDateTime schema, stating it is a disallowed keyword. However, the examples keyword is valid in OpenAPI 3.1.0, and its usage in the provided schema appears correct.

Details

When validating the following OpenAPI 3.1.0 schema with the IBM OpenAPI Validator, an error is reported:

Validator Error:

Message: Found disallowed keyword: examples
Rule: ibm-schema-keywords
Path: components.schemas.OffsetDateTime.examples
Line: 33

Full OpenAPI Document:

openapi: 3.1.0
components:
  schemas:
    TestEntity:
      type: object
      required:
      - alias
      - number
      properties:
        createdAt:
          anyOf:
          - $ref: "#/components/schemas/OffsetDateTime"
          - type: "null"
        updatedAt:
          anyOf:
          - $ref: "#/components/schemas/OffsetDateTime"
          - type: "null"
        alias:
          type: string
        number:
          type: string
        id:
          type:
          - integer
          - "null"
          format: int64
          maximum: 9223372036854775807
          minimum: 1
    OffsetDateTime:
      type: string
      format: date-time
      examples:
      - 2022-03-10T12:15:50-04:00
paths:
  /api/v1/tax/test:
    post:
      requestBody:
        content:
          application/json:
            schema:
              $ref: "#/components/schemas/TestEntity"
        required: true
      responses:
        "200":
          description: OK
          content:
            application/json:
              schema:
                $ref: "#/components/schemas/TestEntity"
      tags:
      - Test Controller
info:
  title: API
  version: unspecified
Langage dominant
JavaScript
Étoiles
635
Forks
98
Merge moyen
1 j 5 h
PR mergées (30 j)
8

Préparer son environnement

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de IBM/openapi-validator

Toutes les issues de IBM/openapi-validator

Issues similaires

Plus d'issues JavaScript

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.