Skip to content

Commit a4160cb

Browse files
madangopal122madangopal122
authored
feat: Add corporate card unarchive api specs (#800)
* feat: Add corporate card unarchive api specs * Auto generate API docs
1 parent b64caaf commit a4160cb

5 files changed

Lines changed: 257 additions & 0 deletions

File tree

‎reference/admin.yaml‎

Lines changed: 126 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -7637,6 +7637,123 @@ paths:
76377637
application/json:
76387638
schema:
76397639
$ref: '#/components/schemas/404'
7640+
/admin/corporate_cards/unarchive:
7641+
post:
7642+
tags:
7643+
- Corporate Cards
7644+
summary: Unarchive a corporate card
7645+
description: |
7646+
Unarchive a corporate card
7647+
operationId: corporate_cards_unarchive
7648+
requestBody:
7649+
required: true
7650+
content:
7651+
application/json:
7652+
schema:
7653+
type: object
7654+
properties:
7655+
data:
7656+
$ref: '#/components/schemas/corporate_card_unarchive_in'
7657+
required:
7658+
- data
7659+
additionalProperties: false
7660+
responses:
7661+
'200':
7662+
description: OK
7663+
content:
7664+
application/json:
7665+
schema:
7666+
type: object
7667+
properties:
7668+
data:
7669+
$ref: '#/components/schemas/corporate_card_out'
7670+
'400':
7671+
description: Bad request
7672+
content:
7673+
application/json:
7674+
schema:
7675+
$ref: '#/components/schemas/400'
7676+
'401':
7677+
description: Unauthorized request
7678+
content:
7679+
application/json:
7680+
schema:
7681+
$ref: '#/components/schemas/401'
7682+
'403':
7683+
description: Forbidden
7684+
content:
7685+
application/json:
7686+
schema:
7687+
$ref: '#/components/schemas/403'
7688+
'404':
7689+
description: Not Found
7690+
content:
7691+
application/json:
7692+
schema:
7693+
$ref: '#/components/schemas/404'
7694+
/admin/corporate_cards/unarchive/bulk:
7695+
post:
7696+
tags:
7697+
- Corporate Cards
7698+
summary: Bulk unarchive corporate cards
7699+
description: |
7700+
Unarchive corporate cards in bulk.
7701+
operationId: corporate_cards_unarchive_bulk
7702+
requestBody:
7703+
required: true
7704+
content:
7705+
application/json:
7706+
schema:
7707+
type: object
7708+
properties:
7709+
data:
7710+
type: array
7711+
items:
7712+
$ref: '#/components/schemas/corporate_card_unarchive_in'
7713+
required:
7714+
- data
7715+
responses:
7716+
'200':
7717+
description: OK
7718+
content:
7719+
application/json:
7720+
schema:
7721+
type: object
7722+
properties:
7723+
data:
7724+
type: array
7725+
items:
7726+
$ref: '#/components/schemas/corporate_card_out'
7727+
'400':
7728+
description: Bad request
7729+
content:
7730+
application/json:
7731+
schema:
7732+
oneOf:
7733+
- $ref: '#/components/schemas/bulk_error'
7734+
- type: object
7735+
properties:
7736+
error:
7737+
type: string
7738+
nullable: true
7739+
message:
7740+
type: string
7741+
nullable: true
7742+
data:
7743+
type: object
7744+
nullable: true
7745+
'401':
7746+
description: Unauthorized request
7747+
content:
7748+
application/json:
7749+
schema:
7750+
$ref: '#/components/schemas/401'
7751+
'403':
7752+
description: Forbidden
7753+
content:
7754+
application/json:
7755+
schema:
7756+
$ref: '#/components/schemas/403'
76407757
/admin/corporate_cards/duplicate_suggestions:
76417758
get:
76427759
tags:
@@ -23731,6 +23848,15 @@ components:
2373123848
example: bawownwrng
2373223849
required:
2373323850
- id
23851+
corporate_card_unarchive_in:
23852+
type: object
23853+
properties:
23854+
id:
23855+
allOf:
23856+
- $ref: '#/components/schemas/id_string'
23857+
example: bawownwrng
23858+
required:
23859+
- id
2373423860
duplicate_suggestion_corporate_card_out_embed:
2373523861
type: object
2373623862
additionalProperties: false

‎src/admin/openapi.yaml‎

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -371,6 +371,10 @@ paths:
371371
$ref: paths/admin@corporate_cards@merge.yaml
372372
/admin/corporate_cards/archive:
373373
$ref: paths/admin@corporate_cards@archive.yaml
374+
/admin/corporate_cards/unarchive:
375+
$ref: paths/admin@corporate_cards@unarchive.yaml
376+
/admin/corporate_cards/unarchive/bulk:
377+
$ref: paths/admin@corporate_cards@unarchive@bulk.yaml
374378
/admin/corporate_cards/duplicate_suggestions:
375379
$ref: paths/admin@corporate_cards@duplicate_suggestions.yaml
376380
/admin/corporate_cards/duplicate_suggestions/dismiss:

‎src/admin/paths/admin@corporate_cards@unarchive.yaml‎

Lines changed: 54 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,54 @@
1+
post:
2+
tags:
3+
- Corporate Cards
4+
summary: Unarchive a corporate card
5+
description: |
6+
Unarchive a corporate card
7+
operationId: corporate_cards_unarchive
8+
requestBody:
9+
required: true
10+
content:
11+
application/json:
12+
schema:
13+
type: object
14+
properties:
15+
data:
16+
$ref: ../../components/schemas/corporate_card.yaml#/corporate_card_unarchive_in
17+
required:
18+
- data
19+
additionalProperties: False
20+
21+
responses:
22+
'200':
23+
description: OK
24+
content:
25+
application/json:
26+
schema:
27+
type: object
28+
properties:
29+
data:
30+
$ref: '../../components/schemas/corporate_card.yaml#/corporate_card_out'
31+
'400':
32+
description: Bad request
33+
content:
34+
application/json:
35+
schema:
36+
$ref: '../../components/schemas/400.yaml'
37+
'401':
38+
description: Unauthorized request
39+
content:
40+
application/json:
41+
schema:
42+
$ref: '../../components/schemas/401.yaml'
43+
'403':
44+
description: Forbidden
45+
content:
46+
application/json:
47+
schema:
48+
$ref: '../../components/schemas/403.yaml'
49+
'404':
50+
description: Not Found
51+
content:
52+
application/json:
53+
schema:
54+
$ref: '../../components/schemas/404.yaml'

‎src/admin/paths/admin@corporate_cards@unarchive@bulk.yaml‎

Lines changed: 62 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,62 @@
1+
post:
2+
tags:
3+
- Corporate Cards
4+
summary: Bulk unarchive corporate cards
5+
description: |
6+
Unarchive corporate cards in bulk.
7+
operationId: corporate_cards_unarchive_bulk
8+
requestBody:
9+
required: true
10+
content:
11+
application/json:
12+
schema:
13+
type: object
14+
properties:
15+
data:
16+
type: array
17+
items:
18+
$ref: '../../components/schemas/corporate_card.yaml#/corporate_card_unarchive_in'
19+
required:
20+
- data
21+
responses:
22+
'200':
23+
description: OK
24+
content:
25+
application/json:
26+
schema:
27+
type: object
28+
properties:
29+
data:
30+
type: array
31+
items:
32+
$ref: '../../components/schemas/corporate_card.yaml#/corporate_card_out'
33+
'400':
34+
description: Bad request
35+
content:
36+
application/json:
37+
schema:
38+
oneOf:
39+
- $ref: ../../components/schemas/bulk_error.yaml
40+
- type: object
41+
properties:
42+
error:
43+
type: string
44+
nullable: true
45+
message:
46+
type: string
47+
nullable: true
48+
data:
49+
type: object
50+
nullable: true
51+
'401':
52+
description: Unauthorized request
53+
content:
54+
application/json:
55+
schema:
56+
$ref: '../../components/schemas/401.yaml'
57+
'403':
58+
description: Forbidden
59+
content:
60+
application/json:
61+
schema:
62+
$ref: '../../components/schemas/403.yaml'

‎src/components/schemas/corporate_card.yaml‎

Lines changed: 11 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -831,3 +831,14 @@ corporate_card_archive_in:
831831
example: bawownwrng
832832
required:
833833
- id
834+
835+
corporate_card_unarchive_in:
836+
type: object
837+
properties:
838+
id:
839+
allOf:
840+
- $ref: './fields.yaml#/id_string'
841+
example: bawownwrng
842+
required:
843+
- id
844+

0 commit comments

Comments
 (0)