arbitrary JSON pattern/anti-pattern

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

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
5/5
Tempo stimato
Più di una settimana
Idoneità per principianti
30/100
Tipo di issue
Documentazione
Chiarezza
Abbastanza chiara
Stato di attività
Ferma
Stack tecnologico
json
Ambito
api, documentation

Direzione di ricerca

Non vengono indicati file o test. Inizia individuando i riferimenti a Graph.Json nel repository, quindi verifica se la sua sostituzione con Edm.Untyped influisce sul payload o sui meccanismi interni di AGS. Il lavoro è completato quando le indicazioni limitano chiaramente Edm.Untyped ai payload esterni di cui non si conosce la struttura e risolvono la decisione sulla sostituzione.

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

Descrizione

Context
Graph.Json is used to model properties or payload of which the shape is unknown.
This makes it really difficult for clients to do anything useful with it.
The vast majority of use is from Excel, and this is historical because they are generating their REST API and CSDL from the object model in the product.

Decision
Graph.Json should not be used anymore, and we'll investigate to replace it by Edm.Untyped instead which is part of Odata. (need to check whether this impact the payload, or internal mechanics of AGS)
Edm.Untyped should ONLY be used in the scenario where the payload/property value comes from outside of the workload and its shape varies/is unknown. (a good example is the SharePoint Pages APIs, webparts can be defined by 3rd parties, and the shape of the webpart properties is unknown by API publishers)

Lingua principale
Nessun dato sulla lingua
Stelle
23.3k
Fork
2.7k
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Guida per i contributori

Apri la guida per i contributori

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 microsoft/api-guidelines

Tutte le issue di microsoft/api-guidelines

Issue simili

Altre issue su Backend & API Design

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.