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

api-version should not cause a ChangedParameterOrder error

Ouverte
  • Quelque chose ne va pas ?
#287 1 commentaire 0 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é
3/5
Temps estimé
1-2 jours
Accessibilité débutants
45/100
Type d'issue
Bug
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
csharp
Domaine
api, cli

Piste de recherche

Recherchez dans le dépôt la règle ChangedParameterOrder et la gestion des références de paramètres, puis comparez les listes de paramètres d’origine et mises à jour présentées dans l’issue. Le travail est terminé lorsque le réordonnancement de ApiVersionParameter ne produit plus cette erreur de breaking change, tandis que les autres modifications de l’ordre des paramètres restent détectées ; validez-le avec l’exemple de l’issue et les vérifications pertinentes du projet.

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

Description

I'm working on https://github.com/Azure/azure-rest-api-specs-pr/pull/15631 . I have 57 ChangedParameterOrder breaking change errors. Many are due to ApiVersionParameter changing order. It should be ignored by the ChangedParameterOrder rule.

ChangedParameterOrder

This is the original.

        "operationId": "Locations_CheckQuotaAvailability",
        "parameters": [
          {
            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
          },
          {
            "name": "location",
            "in": "path",
            "required": true,
            "type": "string",
            "description": "Azure region"
          },
          {
            "$ref": "../../../../../common-types/resource-management/v5/types.json#/parameters/ApiVersionParameter"
          }
        ],

To:

        "operationId": "Locations_CheckQuotaAvailability",
        "parameters": [
          {
            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/ApiVersionParameter"
          },
          {
            "$ref": "../../../../../common-types/resource-management/v3/types.json#/parameters/SubscriptionIdParameter"
          },
          {
            "name": "location",
            "in": "path",
            "description": "A location in a subscription",
            "required": true,
            "type": "string",
            "pattern": "^[-\\w\\._]+$"
          }
        ],

If I move the ApiVersionParameter in the original version to be first, the rule does not consider it breaking.

Langage dominant
C#
Étoiles
290
Forks
50
Merge moyen
7 h 8 min
PR mergées (30 j)
11

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 Azure/openapi-diff

Toutes les issues de Azure/openapi-diff

Issues similaires

Plus d'issues C#

Recevez les nouvelles issues par e-mail

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