hyper63 / hyper63/hyper

default `isLegacyGetEnabled` to false for `Data` and `Cache` api

Aperta
#550 0 commenti 0 reazioni 0 assegnatari Vedi su GitHub
cache data
Lingua principale
TypeScript
Stelle
79
Fork
12
Metriche di merge delle PR
Nessuna PR unita negli ultimi 30g

Descrizione

Related to #531 , this flag is currently defaulted to `true`. We eventually will need to update this flag to default to `false`, in prep for eventually removing the flag.

> This should be a major release of hyper core

```
As a hyper developer
I would like hyper data service and hyper cache service "get" apis to return a hyper response shape, default
So that consumers can start to receive the hyper response shape that will be used, going forward
```

## Scenarios

Default to hyper response shape
```
GIVEN I am a developer
AND I am calling the Data Service "get document" or Cache Service "get value" api
WHEN I do NOT provide the `isLegacyGetEnabled` flag, ie. set `X-HYPER-LEGACY-GET` header
THEN I will receive the hyper response shape
```

Opt-in to legacy shape
```
GIVEN I am a developer
AND I am calling the Data Service "get document" or Cache Service "get value" api
WHEN I DO provide the `isLegacyGetEnabled` flag, ie. set `X-HYPER-LEGACY-GET` header
THEN I will receive the legacy shape (the document or value directly)
```

Guida per i contributori

Apri la guida per i contributori

Direzione di ricerca

Individua le API "get document" di Data Service e "get value" di Cache Service e trova dove vengono gestiti `isLegacyGetEnabled` e l'header `X-HYPER-LEGACY-GET`. Verifica il comportamento predefinito e quello di opt-in esplicito rispetto ai due scenari; l'attività è completata quando i flag omessi restituiscono la forma della risposta hyper, mentre il flag restituisce la forma legacy.

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

Valutazione

Stack tecnologico
typescript
Ambito
api, backend
Tipo di issue
Funzionalità
Difficoltà
3/5
Tempo stimato
1-2 giorni
Stato di attività
Ferma
Chiarezza
Abbastanza chiara
Idoneità per principianti
42/100

Ricevi le nuove issue nella tua casella

Un breve riepilogo di issue GitHub adatte ai principianti.