Hacktoberfest 2026 : les issues que les mainteneurs ont marquées pour octobre, ouvertes et accessibles aux débutants. Parcourir les issues Hacktoberfest

Supporting of one separate 'required' option for query parameters

Ouverte
  • Quelque chose ne va pas ?
#2,347 2 commentaires 2 réactions 0 personnes assignées Voir sur GitHub

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
30/100
Type d'issue
Fonctionnalité
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
openapi
Domaine
api

Piste de recherche

Commencez par examiner le YAML proposé dans l’issue et les règles d’OpenAPI concernant les Parameter Objects réutilisables, les paramètres d’opération et la propriété required. Aucun fichier du dépôt ni test n’étant indiqué, localisez d’abord les sections de la spécification et les discussions associées. Le travail sera considéré comme terminé lorsqu’un modèle convenu pour la gestion séparée du caractère obligatoire ainsi que les mises à jour correspondantes de la spécification ou de la validation seront disponibles.

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

Description

param serialization re-use: globals/defaults re-use: traits/merges

Hi!
For example, there are several paths that include similar parameters, but with different required options: in some paths parameters are required, in others they are optional.

If we can specify the required option separately, we can reuse parameter descriptions. Like this:

/api/v1/rootname:
    get:
      summary: 'Path example'
      parameters:
        - $ref: '#/components/parameters/queryFiltersDateFrom'
        - $ref: '#/components/parameters/queryFiltersDateTo'
        - $ref: '#/components/parameters/queryGroups'
        - $ref: '#/components/parameters/queryOrderByColumn'
        - $ref: '#/components/parameters/queryOrderByDirection'
      required:
        - 'filters[date_from]'
        - 'filters[date_to]'
        - 'groups'
        - 'order_by_column'
        - 'order_by_direction'
Langage dominant
Markdown
Étoiles
31.3k
Forks
9.2k
Merge moyen
2 j 3 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 OAI/OpenAPI-Specification

Toutes les issues de OAI/OpenAPI-Specification

Issues similaires

Plus d'issues Backend & API Design

Recevez les nouvelles issues par e-mail

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