Clarify Permissive-In / Strict-Out Naming Policy in Guidelines

Aperta Adatta ai principianti
#571 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub

Nessuno ha ancora preso questa issue.

Valutazione

Difficoltà
1/5
Tempo stimato
1-3 ore
Idoneità per principianti
68/100
Tipo di issue
Documentazione
Chiarezza
Specificata chiaramente
Stato di attività
Ferma
Ambito
api, documentation

Direzione di ricerca

Apri graph/GuidelinesGraph.md nella sezione Naming e rivedi le indicazioni esistenti su Input/Output Handling. Aggiungi la sezione richiesta Permissive-In / Strict-Out che tratti le varianti accettate, gli output canonici e la documentazione di entrambi; il lavoro è completato quando le indicazioni sono chiare e coerenti con la policy di Naming circostante.

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

Descrizione

Microsoft API Guidelines needs an update to clarify the Permissive-In / Strict-Out naming policy for API request and response.

https://github.com/microsoft/api-guidelines/blob/vNext/graph/GuidelinesGraph.md#naming

Add a section under Naming Conventions Input/Output Handling
Recommend that APIs:

  • Accept a broader range of inputs (e.g., case-insensitive, lenient formats)
  • Emit consistent, canonical outputs (e.g., strict casing, normalized values)

Encourage documentation of canonical forms and accepted variants

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.