microsoft / microsoft/OpenAPI.NET.OData

Potential breaking changes in Graph PowerShell SDK due to change/rename of tags

Offen
#605 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Ein zugehöriger Pull Request wurde bereits gemerged.

  • #642 von @timayabi2020 — gemerged
Vorherrschende Sprache
C#
Sterne
240
Forks
70
Ø Merge
7 Std. 59 Min.
Gemergte PRs (30 T.)
13

Beschreibung

The following tags are missing from the latest metadata for PowerShell.
users.Actions
users.Functions
deviceManagement.Functions
deviceManagement.Actions.

This means that if you try to slice the metadata using the above tags, the service will respond with a 404. e.g. https://devxapi-func-prod-eastus.azurewebsites.net/$openapi?tags=^users.Functions$&title=Users.Functions&openapiversion=3&style=Powershell&fileName=powershell_v2&graphVersion=v1.0&singularizeOperationIds=true.

Therefore, some paths that were assigned those tags, currently have new tags and this would potentially introduce breaking changes in the SDK.
Below is an example of before and after for one of the paths.
Before
Image

After
Image

The change will occur in terms of grouping of paths. e.g. Paths that used to appear under Users. Actions module are now appearing under Calendar module.

Beitragsleitfaden

Beitragsleitfaden öffnen

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginne damit, die Tags users und deviceManagement in den verknüpften Metadaten von powershell_v2.yaml mit der im Issue gezeigten $openapi-Slicing-Anfrage zu vergleichen, und untersuche anschließend die generierten Pfadgruppierungen. Als erledigt gilt die Aufgabe, wenn die betroffenen Tags nicht mehr 404 zurückgeben und die betroffenen Pfade eine kompatible PowerShell SDK-Gruppierung beibehalten; prüfe den verknüpften Pull Request #642 auf bereits vorhandene Arbeit.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
csharp, openapi, powershell
Bereich
api, tooling
Issue-Typ
Bug
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.