Missing paths for OpenAPI generation

Aperta
#937 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

I maintainer di solito rispondono entro 2 giorni

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
4/5
Tempo stimato
3-5 giorni
Idoneità per principianti
35/100
Tipo di issue
Bug
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
openapi
Ambito
api, tooling

Direzione di ricerca

Inizia esaminando i percorsi generati in openapi/beta/openapi.yaml e confrontali con le definizioni dell’entità place e con le route previste elencate nell’issue. Esamina la issue 720 correlata di OpenAPI.NET.OData e la pull request 850 sui metadati per l’indagine precedente. Il lavoro è completato quando viene determinato se le annotazioni o il comportamento del generatore sono responsabili e i percorsi mancanti vengono documentati o implementati.

Scritto dal modello di indicizzazione a partire dal testo della issue.

Descrizione

ToTriage
Describe the bug

This is potentially related to the issue described above.

When generating the OpenAPI description for Microsoft Graph Beta the building, desk, floor, room, roomlist, section, workspace routes are not generated for those entitytypes. All are derived type of the abstract place type.

<EntitySet Name="places" EntityType="microsoft.graph.place" />

<EntityType Name="place" BaseType="graph.entity" Abstract="true">
   ....
  <NavigationProperty Name="checkIns" Type="Collection(graph.checkInClaim)" ContainsTarget="true" />
</EntityType>

<EntityType Name="building" BaseType="graph.place">
  ...
  <NavigationProperty Name="map" Type="graph.buildingMap" ContainsTarget="true" />
</EntityType>

<EntityType Name="room" BaseType="graph.place">
  ...
</EntityType>

<EntityType Name="roomList" BaseType="graph.place">
  ...
  <NavigationProperty Name="rooms" Type="Collection(graph.room)" ContainsTarget="true" />
  <NavigationProperty Name="workspaces" Type="Collection(graph.workspace)" ContainsTarget="true" />
</EntityType>

<Function Name="descendants" IsBound="true" IsComposable="true">
  <Parameter Name="bindingParameter" Type="graph.place" />
  <ReturnType Type="Collection(graph.place)" Nullable="false" />
</Function>

Sample of places paths currently supported in our OpenAPI:

/places/{place-id}
/places/{place-id}/checkIns
/places/{place-id}/checkIns/$count
/places/{place-id}/descendants()
/places/{place-id}/graph.room
/places/{place-id}/graph.room/checkIns
/places/{place-id}/graph.room/checkIns/$count
/places/{place-id}/graph.roomList
/places/{place-id}/graph.roomList/checkIns
/places/{place-id}/graph.roomList/rooms

Either we don't currently support this behavior or there are missing annotations used to specify this behavior. This requires investigation.

Expected behavior

Paths that we expect to be in our OpenAPI but are not (same as the list of affected EntityTypes above):

/places/microsoft.graph.building
/places/microsoft.graph.floor
/places/microsoft.graph.desk
/places/room
/places/roomlist
/places/section
/places/workspace
Additional context

https://github.com/microsoftgraph/msgraph-metadata/blob/master/openapi/beta/openapi.yaml to see missing paths.
https://learn.microsoft.com/en-us/graph/api/place-list?view=graph-rest-beta&tabs=http
https://github.com/microsoft/OpenAPI.NET.OData/issues/720
https://github.com/microsoftgraph/msgraph-metadata/pull/850

Lingua principale
XSLT
Stelle
171
Fork
56
Merge medio
1g 11h
PR unite (30g)
9

Preparare l'ambiente

Questo progetto non fornisce container di sviluppo, Dockerfile né guida per i contributori, quindi l'ambiente è a tuo carico: parti dal suo README e consulta la nostra guida al primo contributo per i passaggi generali.

Come iniziare

  1. Leggi tutta la issue e poi la guida ai contributi del progetto.
  2. Commenta sulla issue per dire che te ne occupi tu — evita che due persone facciano lo stesso lavoro.
  3. Fai un fork del repository e lavora su un branch.
  4. Apri una pull request che faccia riferimento al numero della issue.

Altre issue di microsoftgraph/msgraph-metadata

Tutte le issue di microsoftgraph/msgraph-metadata

Issue simili

Altre issue su Backend & API Design

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.