Skip to content

Commit 30c1c63

Browse files
authored
chore: docusaurus plugin version update (#890)
* chore: docusaurus plugin version update * chore: docusaurus generation
1 parent c56fea0 commit 30c1c63

File tree

341 files changed

+927
-714
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

341 files changed

+927
-714
lines changed

.github/workflows/ci_check_pr.yaml

Lines changed: 18 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -110,10 +110,10 @@ jobs:
110110
env:
111111
POSTGRES_PASSWORD: "docker"
112112
POSTGRES_DB: "config"
113-
redis:
113+
redis:
114114
image: public.ecr.aws/docker/library/redis:8
115-
ports:
116-
- 6379:6379
115+
ports:
116+
- 6379:6379
117117

118118
steps:
119119
- name: Checkout repository
@@ -161,17 +161,17 @@ jobs:
161161
- name: Set up JDK
162162
uses: actions/setup-java@v4
163163
with:
164-
java-version: '17'
165-
distribution: 'temurin'
164+
java-version: "17"
165+
distribution: "temurin"
166166

167167
- name: Setup Gradle
168168
uses: gradle/actions/setup-gradle@v3
169169

170170
- name: Setup Haskell environment (GHC and Cabal)
171171
uses: haskell-actions/setup@v2
172172
with:
173-
ghc-version: '9.6.7' # Specify the GHC version (e.g., '9.2' or 'latest')
174-
cabal-version: '3.16' # Specify the Cabal version (e.g., '3.8' or 'latest')
173+
ghc-version: "9.6.7" # Specify the GHC version (e.g., '9.2' or 'latest')
174+
cabal-version: "3.16" # Specify the Cabal version (e.g., '3.8' or 'latest')
175175

176176
- name: Update Cabal package database
177177
run: cabal update
@@ -271,10 +271,10 @@ jobs:
271271
env:
272272
POSTGRES_PASSWORD: "docker"
273273
POSTGRES_DB: "config"
274-
redis:
274+
redis:
275275
image: public.ecr.aws/docker/library/redis:8
276-
ports:
277-
- 6379:6379
276+
ports:
277+
- 6379:6379
278278

279279
steps:
280280
- name: Checkout repository
@@ -377,13 +377,15 @@ jobs:
377377
make uniffi-bindings
378378
379379
- name: Ensure no file changed
380-
run: git diff --exit-code
380+
run: |
381+
git add .
382+
git diff --staged --exit-code
381383
382384
- name: Show git diff on failure
383385
if: failure()
384386
run: |
385387
echo "❌ The following files were modified:"
386-
git diff --name-only
388+
git diff --staged --name-only
387389
exit 1
388390
389391
smithy-sdk-generation-check:
@@ -414,20 +416,21 @@ jobs:
414416
415417
- name: Ensure no unwanted file changes
416418
run: |
417-
git diff --exit-code -- \
419+
git add .
420+
git diff --staged --exit-code -- \
418421
. \
419422
':(exclude)**/*.api.mdx' \
420423
':(exclude)clients/java/sdk/src/main/java/io/juspay/superposition/client/SuperpositionAsyncClientImpl.java' \
421424
':(exclude)clients/java/sdk/src/main/java/io/juspay/superposition/client/SuperpositionAsyncClient.java' \
422425
':(exclude)clients/java/sdk/src/main/java/io/juspay/superposition/client/SuperpositionClient.java' \
423426
':(exclude)clients/java/sdk/src/main/java/io/juspay/superposition/client/SuperpositionClientImpl.java'
424-
git diff -I '^api:' --exit-code -- '**/*.api.mdx'
427+
git diff --staged -I '^api:' --exit-code -- '**/*.api.mdx'
425428
426429
- name: Show git diff on failure
427430
if: failure()
428431
run: |
429432
echo "❌ The following files were modified:"
430-
git diff --name-only
433+
git diff --staged --name-only
431434
exit 1
432435
433436
# on failure, create a commit of the modified files for easier debugging
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"parameters":[{"name":"id","in":"path","schema":{"type":"string"},"required":true},{"name":"x-org-id","in":"header","schema":{"type":"string"},"required":true},{"name":"x-workspace","in":"header","schema":{"type":"string"},"required":true}]}
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","description":"Input structure for adding members to an experiment group.","properties":{"change_reason":{"type":"string","description":"Reason for adding these members."},"member_experiment_ids":{"type":"array","items":{"type":"string"},"description":"List of experiment IDs to add/remove to this group."}},"required":["change_reason","member_experiment_ids"],"title":"AddMembersToGroupRequestContent"}}},"required":true}}
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"responses":{"200":{"description":"AddMembersToGroup 200 response","content":{"application/json":{"schema":{"type":"object","description":"Standard response structure for an experiment group.","properties":{"id":{"type":"string"},"context_hash":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"change_reason":{"type":"string"},"context":{"type":"object","additionalProperties":{},"description":"Represents conditional criteria used for context matching. Keys define dimension names and values specify the criteria that must be met.","title":"Condition"},"traffic_percentage":{"type":"number","maximum":100,"minimum":0},"member_experiment_ids":{"type":"array","items":{"type":"string"}},"created_at":{"type":"string","format":"date-time"},"created_by":{"type":"string"},"last_modified_at":{"type":"string","format":"date-time"},"last_modified_by":{"type":"string"},"buckets":{"type":"array","items":{"type":"object","properties":{"experiment_id":{"type":"string"},"variant_id":{"type":"string"}},"required":["experiment_id","variant_id"],"title":"Bucket"}},"group_type":{"type":"string","enum":["USER_CREATED","SYSTEM_GENERATED"],"title":"GroupType"}},"required":["buckets","change_reason","context","context_hash","created_at","created_by","description","group_type","id","last_modified_at","last_modified_by","member_experiment_ids","name","traffic_percentage"],"title":"AddMembersToGroupResponseContent"}}}},"404":{"description":"ResourceNotFound 404 response"},"500":{"description":"InternalServerError 500 response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"title":"InternalServerErrorResponseContent"}}}}}}

docs/docs/api/add-members-to-group.api.mdx

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes";
1818
import OperationTabs from "@theme/OperationTabs";
1919
import TabItem from "@theme/TabItem";
2020
import Heading from "@theme/Heading";
21+
import Translate from "@docusaurus/Translate";
2122

2223
<Heading
2324
as={"h1"}
@@ -42,27 +43,24 @@ Adds members to an existing experiment group.
4243
id={"request"}
4344
as={"h2"}
4445
className={"openapi-tabs__heading"}
45-
children={"Request"}
4646
>
47+
<Translate id="theme.openapi.request.title">Request</Translate>
4748
</Heading>
4849

4950
<ParamsDetails
50-
parameters={[{"name":"id","in":"path","schema":{"type":"string"},"required":true},{"name":"x-org-id","in":"header","schema":{"type":"string"},"required":true},{"name":"x-workspace","in":"header","schema":{"type":"string"},"required":true}]}
51+
{...require("./add-members-to-group.ParamsDetails.json")}
5152
>
5253

5354
</ParamsDetails>
5455

5556
<RequestSchema
56-
title={"Body"}
57-
body={{"content":{"application/json":{"schema":{"type":"object","description":"Input structure for adding members to an experiment group.","properties":{"change_reason":{"type":"string","description":"Reason for adding these members."},"member_experiment_ids":{"type":"array","items":{"type":"string"},"description":"List of experiment IDs to add/remove to this group."}},"required":["change_reason","member_experiment_ids"],"title":"AddMembersToGroupRequestContent"}}},"required":true}}
57+
{...require("./add-members-to-group.RequestSchema.json")}
5858
>
5959

6060
</RequestSchema>
6161

6262
<StatusCodes
63-
id={undefined}
64-
label={undefined}
65-
responses={{"200":{"description":"AddMembersToGroup 200 response","content":{"application/json":{"schema":{"type":"object","description":"Standard response structure for an experiment group.","properties":{"id":{"type":"string"},"context_hash":{"type":"string"},"name":{"type":"string"},"description":{"type":"string"},"change_reason":{"type":"string"},"context":{"type":"object","additionalProperties":{},"description":"Represents conditional criteria used for context matching. Keys define dimension names and values specify the criteria that must be met.","title":"Condition"},"traffic_percentage":{"type":"number","maximum":100,"minimum":0},"member_experiment_ids":{"type":"array","items":{"type":"string"}},"created_at":{"type":"string","format":"date-time"},"created_by":{"type":"string"},"last_modified_at":{"type":"string","format":"date-time"},"last_modified_by":{"type":"string"},"buckets":{"type":"array","items":{"type":"object","properties":{"experiment_id":{"type":"string"},"variant_id":{"type":"string"}},"required":["experiment_id","variant_id"],"title":"Bucket"}},"group_type":{"type":"string","enum":["USER_CREATED","SYSTEM_GENERATED"],"title":"GroupType"}},"required":["buckets","change_reason","context","context_hash","created_at","created_by","description","group_type","id","last_modified_at","last_modified_by","member_experiment_ids","name","traffic_percentage"],"title":"AddMembersToGroupResponseContent"}}}},"404":{"description":"ResourceNotFound 404 response"},"500":{"description":"InternalServerError 500 response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"title":"InternalServerErrorResponseContent"}}}}}}
63+
{...require("./add-members-to-group.StatusCodes.json")}
6664
>
6765

6866
</StatusCodes>
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"parameters":[{"name":"x-org-id","in":"header","schema":{"type":"string"},"required":true},{"name":"x-workspace","in":"header","schema":{"type":"string"},"required":true}]}
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"title":"Body","body":{"content":{"application/json":{"schema":{"type":"object","properties":{"context":{"type":"object","additionalProperties":{},"description":"Represents conditional criteria used for context matching. Keys define dimension names and values specify the criteria that must be met.","title":"Condition"},"identifier":{"type":"string"}},"required":["context","identifier"],"title":"ApplicableVariantsRequestContent"}}},"required":true}}
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"responses":{"200":{"description":"ApplicableVariants 200 response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"variant_type":{"type":"string","enum":["CONTROL","EXPERIMENTAL"],"title":"VariantType"},"context_id":{"type":"string"},"override_id":{"type":"string"},"overrides":{"type":"object","additionalProperties":{},"description":"Configuration overrides that replace default values when context conditions are met. Keys represent configuration keys and values are the override data.","title":"Overrides"}},"required":["id","overrides","variant_type"],"title":"Variant"}}},"required":["data"],"title":"ApplicableVariantsResponseContent"}}}},"500":{"description":"InternalServerError 500 response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"title":"InternalServerErrorResponseContent"}}}}}}

docs/docs/api/applicable-variants.api.mdx

Lines changed: 5 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@ import StatusCodes from "@theme/StatusCodes";
1818
import OperationTabs from "@theme/OperationTabs";
1919
import TabItem from "@theme/TabItem";
2020
import Heading from "@theme/Heading";
21+
import Translate from "@docusaurus/Translate";
2122

2223
<Heading
2324
as={"h1"}
@@ -42,27 +43,24 @@ Determines which experiment variants are applicable to a given context, used for
4243
id={"request"}
4344
as={"h2"}
4445
className={"openapi-tabs__heading"}
45-
children={"Request"}
4646
>
47+
<Translate id="theme.openapi.request.title">Request</Translate>
4748
</Heading>
4849

4950
<ParamsDetails
50-
parameters={[{"name":"x-org-id","in":"header","schema":{"type":"string"},"required":true},{"name":"x-workspace","in":"header","schema":{"type":"string"},"required":true}]}
51+
{...require("./applicable-variants.ParamsDetails.json")}
5152
>
5253

5354
</ParamsDetails>
5455

5556
<RequestSchema
56-
title={"Body"}
57-
body={{"content":{"application/json":{"schema":{"type":"object","properties":{"context":{"type":"object","additionalProperties":{},"description":"Represents conditional criteria used for context matching. Keys define dimension names and values specify the criteria that must be met.","title":"Condition"},"identifier":{"type":"string"}},"required":["context","identifier"],"title":"ApplicableVariantsRequestContent"}}},"required":true}}
57+
{...require("./applicable-variants.RequestSchema.json")}
5858
>
5959

6060
</RequestSchema>
6161

6262
<StatusCodes
63-
id={undefined}
64-
label={undefined}
65-
responses={{"200":{"description":"ApplicableVariants 200 response","content":{"application/json":{"schema":{"type":"object","properties":{"data":{"type":"array","items":{"type":"object","properties":{"id":{"type":"string"},"variant_type":{"type":"string","enum":["CONTROL","EXPERIMENTAL"],"title":"VariantType"},"context_id":{"type":"string"},"override_id":{"type":"string"},"overrides":{"type":"object","additionalProperties":{},"description":"Configuration overrides that replace default values when context conditions are met. Keys represent configuration keys and values are the override data.","title":"Overrides"}},"required":["id","overrides","variant_type"],"title":"Variant"}}},"required":["data"],"title":"ApplicableVariantsResponseContent"}}}},"500":{"description":"InternalServerError 500 response","content":{"application/json":{"schema":{"type":"object","properties":{"message":{"type":"string"}},"title":"InternalServerErrorResponseContent"}}}}}}
63+
{...require("./applicable-variants.StatusCodes.json")}
6664
>
6765

6866
</StatusCodes>
Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
{"parameters":[{"name":"x-config-tags","in":"header","schema":{"type":"string"}},{"name":"x-org-id","in":"header","schema":{"type":"string"},"required":true},{"name":"x-workspace","in":"header","schema":{"type":"string"},"required":true}]}

0 commit comments

Comments
 (0)