BEDS-97/add-flag-mock-data

frontend/.env-example

@@ -1,15 +1,16 @@
-NUXT_PUBLIC_API_CLIENT: ""
-NUXT_PUBLIC_LEGACY_API_CLIENT: ""
-NUXT_PRIVATE_API_SERVER: ""
-NUXT_PRIVATE_LEGACY_API_SERVER: ""
-NUXT_PUBLIC_API_KEY: ""
-NUXT_PUBLIC_DOMAIN: ""
-NUXT_PUBLIC_STRIPE_BASE_URL: ""
-NUXT_PUBLIC_LOG_IP: ""
-NUXT_PUBLIC_SHOW_IN_DEVELOPMENT: ""
-NUXT_PUBLIC_V1_DOMAIN: ""
-NUXT_PUBLIC_LOG_FILE: ""
-NUXT_PUBLIC_CHAIN_ID_BY_DEFAULT: ""
-NUXT_PUBLIC_MAINTENANCE_TS: "1717700652"
-NUXT_PUBLIC_DEPLOYMENT_TYPE: "development"
-PRIVATE_SSR_SECRET: ""
+NUXT_IS_API_MOCKED=
+NUXT_PRIVATE_API_SERVER=
+NUXT_PRIVATE_LEGACY_API_SERVER=
+NUXT_PUBLIC_API_CLIENT=
+NUXT_PUBLIC_API_KEY=
+NUXT_PUBLIC_CHAIN_ID_BY_DEFAULT=
+NUXT_PUBLIC_DEPLOYMENT_TYPE=development
+NUXT_PUBLIC_DOMAIN=
+NUXT_PUBLIC_LEGACY_API_CLIENT=
+NUXT_PUBLIC_LOG_FILE=
+NUXT_PUBLIC_LOG_IP=
+NUXT_PUBLIC_MAINTENANCE_TS=1717700652
+NUXT_PUBLIC_SHOW_IN_DEVELOPMENT=
+NUXT_PUBLIC_STRIPE_BASE_URL=
+NUXT_PUBLIC_V1_DOMAIN=
+PRIVATE_SSR_SECRET=

frontend/README.md

@@ -122,6 +122,14 @@ bun run preview
 
 Check out the [deployment documentation](https://nuxt.com/docs/getting-started/deployment) for more information.
 
+## Get mocked api data
+
+If your `user` was added to the `ADMIN` or `DEV` group by the `api team`, you can get
+`mocked data` from the `api` for certain `endpoints` by adding `?is_mocked=true` as a 
+`query parameter`.
+
+You can `turn on` mocked data `globally` for all `configured enpoints` by setting `NUXT_PUBLIC_IS_API_MOCKED=true`.
+
 ## Descision Record
 
 We documented our decisions in the [decisions](decisions.md) file.

frontend/composables/useCustomFetch.ts

@@ -85,6 +85,7 @@ export function useCustomFetch() {
     options.query = {
       ...options.query,
       ...query,
+      is_mocked: true,
     }
     options.credentials = 'include'
     const method = options.method || map.method || 'GET'

frontend/nuxt.config.ts

@@ -89,6 +89,7 @@ export default defineNuxtConfig({
       deploymentType: process.env.PUBLIC_DEPLOYMENT_TYPE,
       domain: process.env.PUBLIC_DOMAIN,
       gitVersion,
+      isApiMocked: '',
       legacyApiClient: process.env.PUBLIC_LEGACY_API_CLIENT,
       logFile: '',
       logIp: '',

frontend/types/datatable.ts

@@ -4,7 +4,7 @@ export type SortOrder = -1 | 0 | 1 | null | undefined
 
 export type TableQueryParams = {
   cursor?: Cursor,
-  isMocked?: boolean,
+  is_mocked?: boolean,
   limit?: number,
   order?: ColumnOrder,
   search?: string,