Skip to content

Commit 5bd7182

Browse files
shahednassershahednasser
committed
fixes
1 parent 76f2f30 commit 5bd7182

16 files changed

Lines changed: 156 additions & 408 deletions

‎www/apps/api-reference/specs/admin/components/schemas/AdminTranslationEntitiesResponse.yaml‎

Lines changed: 9 additions & 57 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
type: object
2-
description: SUMMARY
2+
description: The list of translatable entities.
33
x-schemaName: AdminTranslationEntitiesResponse
44
required:
55
- data
@@ -9,81 +9,33 @@ required:
99
properties:
1010
data:
1111
type: array
12-
description: The translation's data.
12+
description: The list of translatable entities.
1313
items:
1414
allOf:
1515
- type: object
16-
description: The datum's data.
17-
- type: object
18-
description: The datum's data.
16+
description: The entity's data.
1917
required:
2018
- id
2119
- translations
2220
properties:
2321
id:
2422
type: string
2523
title: id
26-
description: The datum's ID.
24+
description: The entity's ID.
2725
translations:
2826
type: array
29-
description: The datum's translations.
27+
description: The entity's translations.
3028
items:
31-
type: object
32-
description: The translation's translations.
33-
x-schemaName: AdminTranslation
34-
required:
35-
- id
36-
- reference_id
37-
- reference
38-
- locale_code
39-
- translations
40-
- created_at
41-
- updated_at
42-
- deleted_at
43-
properties:
44-
id:
45-
type: string
46-
title: id
47-
description: The translation's ID.
48-
reference_id:
49-
type: string
50-
title: reference_id
51-
description: The translation's reference id.
52-
reference:
53-
type: string
54-
title: reference
55-
description: The translation's reference.
56-
locale_code:
57-
type: string
58-
title: locale_code
59-
description: The translation's locale code.
60-
translations:
61-
type: object
62-
description: The translation's translations.
63-
created_at:
64-
type: string
65-
format: date-time
66-
title: created_at
67-
description: The translation's created at.
68-
updated_at:
69-
type: string
70-
format: date-time
71-
title: updated_at
72-
description: The translation's updated at.
73-
deleted_at:
74-
type: string
75-
format: date-time
76-
title: deleted_at
77-
description: The translation's deleted at.
29+
$ref: ./AdminTranslation.yaml
7830
count:
7931
type: number
8032
title: count
81-
description: The translation's count.
33+
description: The total number of translatable entities.
8234
offset:
8335
type: number
8436
title: offset
85-
description: The translation's offset.
37+
description: The number of items skipped before retrieving the returned items.
8638
limit:
8739
type: number
8840
title: limit
89-
description: The translation's limit.
41+
description: The maximum number of items returned in the response.

‎www/apps/api-reference/specs/admin/components/schemas/StoreCart.yaml‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -211,5 +211,5 @@ properties:
211211
completed_at:
212212
type: string
213213
title: completed_at
214-
description: The cart's completed at.
214+
description: The date the cart was completed.
215215
format: date-time

‎www/apps/api-reference/specs/admin/openapi.full.yaml‎

Lines changed: 30 additions & 68 deletions
Original file line numberDiff line numberDiff line change
@@ -64380,32 +64380,33 @@ paths:
6438064380
/admin/translations/entities:
6438164381
get:
6438264382
operationId: GetTranslationsEntities
64383-
summary: List Translations
64384-
description: Retrieve a list of translations. The translations can be filtered by fields such as `id`. The translations can also be sorted or paginated.
64383+
summary: List Translatable Entities
64384+
description: Retrieve a list of translatable entities. The entities can be filtered by fields such as `id`. The entities can also be sorted or paginated.
6438564385
x-authenticated: true
6438664386
parameters:
6438764387
- name: type
6438864388
in: query
64389-
description: The translation's type.
64389+
description: Filter by a translatable entity type.
6439064390
required: true
6439164391
schema:
6439264392
type: string
6439364393
title: type
64394-
description: The translation's type.
64394+
description: Filter by a translatable entity type.
64395+
example: product
6439564396
- name: id
6439664397
in: query
6439764398
required: false
6439864399
schema:
6439964400
oneOf:
6440064401
- type: string
6440164402
title: id
64402-
description: The translation's ID.
64403+
description: Filter by an entity's ID.
6440364404
- type: array
64404-
description: The translation's ID.
64405+
description: Filter by entity IDs.
6440564406
items:
6440664407
type: string
6440764408
title: id
64408-
description: The id's ID.
64409+
description: An entity's ID.
6440964410
- name: limit
6441064411
in: query
6441164412
description: Limit the number of items returned in the list.
@@ -67764,9 +67765,17 @@ paths:
6776467765
application/json:
6776567766
schema:
6776667767
type: object
67767-
title: identifier
67768-
description: The user's identifier for the selected auth provider. For example, for the `emailpass` auth provider, the value is the user's email.
67769-
example: admin@medusa-test.com
67768+
description: The input data necessary to generate a reset password token.
67769+
required:
67770+
- identifier
67771+
properties:
67772+
identifier:
67773+
type: string
67774+
description: The identifier of the admin user. For example, their email address.
67775+
example: admin@medusa-test.com
67776+
metadata:
67777+
type: object
67778+
description: Optional metadata to include with the reset password token generation request.
6777067779
x-codeSamples:
6777167780
- lang: JavaScript
6777267781
label: JS SDK
@@ -67825,6 +67834,7 @@ paths:
6782567834
entity_id, // The identifier of the user or customer. For example, an email address.
6782667835
actor_type, // The type of actor. For example, "customer", "user", or custom.
6782767836
token, // The generated token.
67837+
metadata, // Optional custom metadata passed from the request.
6782867838
}
6782967839
```
6783067840
description: |-
@@ -81580,7 +81590,7 @@ components:
8158081590
description: The date that the translation was deleted.
8158181591
AdminTranslationEntitiesResponse:
8158281592
type: object
81583-
description: SUMMARY
81593+
description: The list of translatable entities.
8158481594
x-schemaName: AdminTranslationEntitiesResponse
8158581595
required:
8158681596
- data
@@ -81590,84 +81600,36 @@ components:
8159081600
properties:
8159181601
data:
8159281602
type: array
81593-
description: The translation's data.
81603+
description: The list of translatable entities.
8159481604
items:
8159581605
allOf:
8159681606
- type: object
81597-
description: The datum's data.
81598-
- type: object
81599-
description: The datum's data.
81607+
description: The entity's data.
8160081608
required:
8160181609
- id
8160281610
- translations
8160381611
properties:
8160481612
id:
8160581613
type: string
8160681614
title: id
81607-
description: The datum's ID.
81615+
description: The entity's ID.
8160881616
translations:
8160981617
type: array
81610-
description: The datum's translations.
81618+
description: The entity's translations.
8161181619
items:
81612-
type: object
81613-
description: The translation's translations.
81614-
x-schemaName: AdminTranslation
81615-
required:
81616-
- id
81617-
- reference_id
81618-
- reference
81619-
- locale_code
81620-
- translations
81621-
- created_at
81622-
- updated_at
81623-
- deleted_at
81624-
properties:
81625-
id:
81626-
type: string
81627-
title: id
81628-
description: The translation's ID.
81629-
reference_id:
81630-
type: string
81631-
title: reference_id
81632-
description: The translation's reference id.
81633-
reference:
81634-
type: string
81635-
title: reference
81636-
description: The translation's reference.
81637-
locale_code:
81638-
type: string
81639-
title: locale_code
81640-
description: The translation's locale code.
81641-
translations:
81642-
type: object
81643-
description: The translation's translations.
81644-
created_at:
81645-
type: string
81646-
format: date-time
81647-
title: created_at
81648-
description: The translation's created at.
81649-
updated_at:
81650-
type: string
81651-
format: date-time
81652-
title: updated_at
81653-
description: The translation's updated at.
81654-
deleted_at:
81655-
type: string
81656-
format: date-time
81657-
title: deleted_at
81658-
description: The translation's deleted at.
81620+
$ref: '#/components/schemas/AdminTranslation'
8165981621
count:
8166081622
type: number
8166181623
title: count
81662-
description: The translation's count.
81624+
description: The total number of translatable entities.
8166381625
offset:
8166481626
type: number
8166581627
title: offset
81666-
description: The translation's offset.
81628+
description: The number of items skipped before retrieving the returned items.
8166781629
limit:
8166881630
type: number
8166981631
title: limit
81670-
description: The translation's limit.
81632+
description: The maximum number of items returned in the response.
8167181633
AdminTranslationSettingsResponse:
8167281634
type: object
8167381635
description: The translation settings' details.
@@ -90168,7 +90130,7 @@ components:
9016890130
completed_at:
9016990131
type: string
9017090132
title: completed_at
90171-
description: The cart's completed at.
90133+
description: The date the cart was completed.
9017290134
format: date-time
9017390135
StoreCartAddPromotion:
9017490136
type: object

‎www/apps/api-reference/specs/admin/paths/admin_translations_entities.yaml‎

Lines changed: 9 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,34 @@
11
get:
22
operationId: GetTranslationsEntities
3-
summary: List Translations
3+
summary: List Translatable Entities
44
description: >-
5-
Retrieve a list of translations. The translations can be filtered by fields
6-
such as `id`. The translations can also be sorted or paginated.
5+
Retrieve a list of translatable entities. The entities can be filtered by
6+
fields such as `id`. The entities can also be sorted or paginated.
77
x-authenticated: true
88
parameters:
99
- name: type
1010
in: query
11-
description: The translation's type.
11+
description: Filter by a translatable entity type.
1212
required: true
1313
schema:
1414
type: string
1515
title: type
16-
description: The translation's type.
16+
description: Filter by a translatable entity type.
17+
example: product
1718
- name: id
1819
in: query
1920
required: false
2021
schema:
2122
oneOf:
2223
- type: string
2324
title: id
24-
description: The translation's ID.
25+
description: Filter by an entity's ID.
2526
- type: array
26-
description: The translation's ID.
27+
description: Filter by entity IDs.
2728
items:
2829
type: string
2930
title: id
30-
description: The id's ID.
31+
description: An entity's ID.
3132
- name: limit
3233
in: query
3334
description: Limit the number of items returned in the list.

‎www/apps/api-reference/specs/admin/paths/auth_user_{auth_provider}_reset-password.yaml‎

Lines changed: 16 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -38,11 +38,21 @@ post:
3838
application/json:
3939
schema:
4040
type: object
41-
title: identifier
42-
description: >-
43-
The user's identifier for the selected auth provider. For example,
44-
for the `emailpass` auth provider, the value is the user's email.
45-
example: admin@medusa-test.com
41+
description: The input data necessary to generate a reset password token.
42+
required:
43+
- identifier
44+
properties:
45+
identifier:
46+
type: string
47+
description: >-
48+
The identifier of the admin user. For example, their email
49+
address.
50+
example: admin@medusa-test.com
51+
metadata:
52+
type: object
53+
description: >-
54+
Optional metadata to include with the reset password token
55+
generation request.
4656
x-codeSamples:
4757
- lang: JavaScript
4858
label: JS SDK
@@ -79,6 +89,7 @@ post:
7989
entity_id, // The identifier of the user or customer. For example, an email address.
8090
actor_type, // The type of actor. For example, "customer", "user", or custom.
8191
token, // The generated token.
92+
metadata, // Optional custom metadata passed from the request.
8293
}
8394
```
8495
description: >-

0 commit comments

Comments
 (0)