Skip to content

Commit e997813

Browse files
shahednassershahednasser
authored
docs-utils: fix OAS generation of requests that only returns status (#16224)
1 parent 01f31bc commit e997813

51 files changed

Lines changed: 462 additions & 207 deletions

File tree

Some content is hidden

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

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

Lines changed: 14 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23207,6 +23207,13 @@ paths:
2320723207
responses:
2320823208
'200':
2320923209
description: OK
23210+
content:
23211+
text/plain:
23212+
schema:
23213+
type: string
23214+
title: message
23215+
description: The 200 status code's message.
23216+
example: OK
2321023217
'400':
2321123218
$ref: '#/components/responses/400_error'
2321223219
'401':
@@ -71275,6 +71282,13 @@ paths:
7127571282
responses:
7127671283
'201':
7127771284
description: OK
71285+
content:
71286+
text/plain:
71287+
schema:
71288+
type: string
71289+
title: message
71290+
description: The 201 status code's message.
71291+
example: Created
7127871292
'400':
7127971293
$ref: '#/components/responses/400_error'
7128071294
'401':

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

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -22,6 +22,13 @@ post:
2222
responses:
2323
'200':
2424
description: OK
25+
content:
26+
text/plain:
27+
schema:
28+
type: string
29+
title: message
30+
description: The 200 status code's message.
31+
example: OK
2532
'400':
2633
$ref: ../components/responses/400_error.yaml
2734
'401':

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

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,6 +68,13 @@ post:
6868
responses:
6969
'201':
7070
description: OK
71+
content:
72+
text/plain:
73+
schema:
74+
type: string
75+
title: message
76+
description: The 201 status code's message.
77+
example: Created
7178
'400':
7279
$ref: ../components/responses/400_error.yaml
7380
'401':

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

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -636,6 +636,13 @@ paths:
636636
responses:
637637
'201':
638638
description: OK
639+
content:
640+
text/plain:
641+
schema:
642+
type: string
643+
title: message
644+
description: The 201 status code's message.
645+
example: Created
639646
'400':
640647
$ref: '#/components/responses/400_error'
641648
'401':

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

Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -69,6 +69,13 @@ post:
6969
responses:
7070
'201':
7171
description: OK
72+
content:
73+
text/plain:
74+
schema:
75+
type: string
76+
title: message
77+
description: The 201 status code's message.
78+
example: Created
7279
'400':
7380
$ref: ../components/responses/400_error.yaml
7481
'401':

‎www/utils/generated/events-output.json‎

Lines changed: 39 additions & 39 deletions
Original file line numberDiff line numberDiff line change
@@ -1,4 +1,34 @@
11
[
2+
{
3+
"name": "auth.mfa_enabled",
4+
"parentName": "AuthEvents",
5+
"propertyName": "MFA_ENABLED",
6+
"payload": "```ts\n{\n auth_identity_id, // The ID of the auth identity for which the MFA factor was enabled.\n mfa_id, // The ID of the MFA factor that was enabled.\n provider, // The provider of the MFA factor that was enabled.\n}\n```",
7+
"description": "Emitted when an MFA factor is enabled for an auth identity.",
8+
"workflows": [],
9+
"since": "2.15.5",
10+
"deprecated": false
11+
},
12+
{
13+
"name": "auth.mfa_disabled",
14+
"parentName": "AuthEvents",
15+
"propertyName": "MFA_DISABLED",
16+
"payload": "```ts\n{\n auth_identity_id, // The ID of the auth identity for which the MFA factor was disabled.\n mfa_id, // The ID of the MFA factor that was disabled.\n provider, // The provider of the MFA factor that was disabled.\n}\n```",
17+
"description": "Emitted when an MFA factor is disabled for an auth identity.",
18+
"workflows": [],
19+
"since": "2.15.5",
20+
"deprecated": false
21+
},
22+
{
23+
"name": "auth.mfa_recovery_codes_generated",
24+
"parentName": "AuthEvents",
25+
"propertyName": "MFA_RECOVERY_CODES_GENERATED",
26+
"payload": "```ts\n{\n auth_identity_id, // The ID of the auth identity for which the recovery codes were generated.\n count, // (number) The number of recovery codes that were generated.\n}\n```",
27+
"description": "Emitted when recovery codes are generated for an auth identity.",
28+
"workflows": [],
29+
"since": "2.15.5",
30+
"deprecated": false
31+
},
232
{
333
"name": "cart.created",
434
"parentName": "CartWorkflowEvents",
@@ -843,7 +873,7 @@
843873
"batchProductsWorkflow",
844874
"importProductsWorkflow"
845875
],
846-
"since": "2.17.3",
876+
"since": "2.18.0",
847877
"deprecated": false
848878
},
849879
{
@@ -855,7 +885,7 @@
855885
"workflows": [
856886
"updateInventoryItemsWorkflow"
857887
],
858-
"since": "2.17.3",
888+
"since": "2.18.0",
859889
"deprecated": false
860890
},
861891
{
@@ -872,7 +902,7 @@
872902
"batchProductVariantsWorkflow",
873903
"importProductsWorkflow"
874904
],
875-
"since": "2.17.3",
905+
"since": "2.18.0",
876906
"deprecated": false
877907
},
878908
{
@@ -892,7 +922,7 @@
892922
"batchProductsWorkflow",
893923
"importProductsWorkflow"
894924
],
895-
"since": "2.17.3",
925+
"since": "2.18.0",
896926
"deprecated": false
897927
},
898928
{
@@ -908,7 +938,7 @@
908938
"batchInventoryItemLevelsWorkflow",
909939
"confirmReturnReceiveWorkflow"
910940
],
911-
"since": "2.17.3",
941+
"since": "2.18.0",
912942
"deprecated": false
913943
},
914944
{
@@ -922,7 +952,7 @@
922952
"bulkCreateDeleteLevelsWorkflow",
923953
"batchInventoryItemLevelsWorkflow"
924954
],
925-
"since": "2.17.3",
955+
"since": "2.18.0",
926956
"deprecated": false
927957
},
928958
{
@@ -940,7 +970,7 @@
940970
"confirmExchangeRequestWorkflow",
941971
"confirmClaimRequestWorkflow"
942972
],
943-
"since": "2.17.3",
973+
"since": "2.18.0",
944974
"deprecated": false
945975
},
946976
{
@@ -954,7 +984,7 @@
954984
"createOrderFulfillmentWorkflow",
955985
"cancelOrderFulfillmentWorkflow"
956986
],
957-
"since": "2.17.3",
987+
"since": "2.18.0",
958988
"deprecated": false
959989
},
960990
{
@@ -972,37 +1002,7 @@
9721002
"cancelOrderExchangeWorkflow",
9731003
"cancelOrderClaimWorkflow"
9741004
],
975-
"since": "2.17.3",
976-
"deprecated": false
977-
},
978-
{
979-
"name": "auth.mfa_enabled",
980-
"parentName": "AuthEvents",
981-
"propertyName": "MFA_ENABLED",
982-
"payload": "```ts\n{\n auth_identity_id, // The ID of the auth identity for which the MFA factor was enabled.\n mfa_id, // The ID of the MFA factor that was enabled.\n provider, // The provider of the MFA factor that was enabled.\n}\n```",
983-
"description": "Emitted when an MFA factor is enabled for an auth identity.",
984-
"workflows": [],
985-
"since": "2.15.5",
986-
"deprecated": false
987-
},
988-
{
989-
"name": "auth.mfa_disabled",
990-
"parentName": "AuthEvents",
991-
"propertyName": "MFA_DISABLED",
992-
"payload": "```ts\n{\n auth_identity_id, // The ID of the auth identity for which the MFA factor was disabled.\n mfa_id, // The ID of the MFA factor that was disabled.\n provider, // The provider of the MFA factor that was disabled.\n}\n```",
993-
"description": "Emitted when an MFA factor is disabled for an auth identity.",
994-
"workflows": [],
995-
"since": "2.15.5",
996-
"deprecated": false
997-
},
998-
{
999-
"name": "auth.mfa_recovery_codes_generated",
1000-
"parentName": "AuthEvents",
1001-
"propertyName": "MFA_RECOVERY_CODES_GENERATED",
1002-
"payload": "```ts\n{\n auth_identity_id, // The ID of the auth identity for which the recovery codes were generated.\n count, // (number) The number of recovery codes that were generated.\n}\n```",
1003-
"description": "Emitted when recovery codes are generated for an auth identity.",
1004-
"workflows": [],
1005-
"since": "2.15.5",
1005+
"since": "2.18.0",
10061006
"deprecated": false
10071007
}
10081008
]

‎www/utils/generated/oas-output/operations/admin/delete_admin_product-options_[id]_values_[value_id].ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,5 +68,6 @@
6868
* x-workflow: deleteProductOptionValuesWorkflow
6969
* x-events: []
7070
* x-since: 2.17.0
71+
*
7172
*/
7273

‎www/utils/generated/oas-output/operations/admin/get_admin_product-options_[id]_values.ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -550,5 +550,6 @@
550550
* "500":
551551
* $ref: "#/components/responses/500_error"
552552
* x-since: 2.16.0
553+
*
553554
*/
554555

‎www/utils/generated/oas-output/operations/admin/get_admin_product-options_[id]_values_[value_id].ts‎

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -78,5 +78,6 @@
7878
* "500":
7979
* $ref: "#/components/responses/500_error"
8080
* x-since: 2.16.0
81+
*
8182
*/
8283

‎www/utils/generated/oas-output/operations/admin/post_admin_campaigns.ts‎

Lines changed: 2 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -59,9 +59,8 @@
5959
* type:
6060
* type: string
6161
* title: type
62-
* description: >
63-
* The budget's type. This can't be edited later. Use `spend` to set a limit on the total amount discounted by the campaign's promotions. Use `usage` to set a limit on the total
64-
* number of times the campaign's promotions can be used.
62+
* description: |
63+
* The budget's type. This can't be edited later. Use `spend` to set a limit on the total amount discounted by the campaign's promotions. Use `usage` to set a limit on the total number of times the campaign's promotions can be used.
6564
* enum:
6665
* - spend
6766
* - usage

0 commit comments

Comments
 (0)