Skip to content

Commit 054bbe1

Browse files
committed
chore: update generated openapi.yaml for fix-assets and clean-assets endpoints
1 parent 7426d2c commit 054bbe1

1 file changed

Lines changed: 183 additions & 0 deletions

File tree

dotCMS/src/main/webapp/WEB-INF/openapi/openapi.yaml

Lines changed: 183 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -11122,6 +11122,55 @@ paths:
1112211122
description: default response
1112311123
tags:
1112411124
- TailLog
11125+
/v1/maintenance/_cleanAssets:
11126+
get:
11127+
description: Returns the current status of the clean orphan assets background
11128+
process. Poll this endpoint while running is true.
11129+
operationId: getCleanAssetsStatus
11130+
responses:
11131+
"200":
11132+
content:
11133+
application/json:
11134+
schema:
11135+
$ref: "#/components/schemas/ResponseEntityCleanAssetsStatusView"
11136+
description: Current clean assets status
11137+
"401":
11138+
content:
11139+
application/json: {}
11140+
description: Unauthorized - authentication required
11141+
"403":
11142+
content:
11143+
application/json: {}
11144+
description: Forbidden - CMS Administrator role required
11145+
summary: Poll clean assets status
11146+
tags:
11147+
- Maintenance
11148+
post:
11149+
description: Starts a background thread that deletes orphan asset directories
11150+
with no matching contentlet in the database. Returns 409 if already running.
11151+
operationId: startCleanAssets
11152+
responses:
11153+
"200":
11154+
content:
11155+
application/json:
11156+
schema:
11157+
$ref: "#/components/schemas/ResponseEntityCleanAssetsStatusView"
11158+
description: Clean assets process started
11159+
"401":
11160+
content:
11161+
application/json: {}
11162+
description: Unauthorized - authentication required
11163+
"403":
11164+
content:
11165+
application/json: {}
11166+
description: Forbidden - CMS Administrator role required
11167+
"409":
11168+
content:
11169+
application/json: {}
11170+
description: Conflict - clean assets process is already running
11171+
summary: Start clean orphan assets
11172+
tags:
11173+
- Maintenance
1112511174
/v1/maintenance/_downloadAssets:
1112611175
get:
1112711176
operationId: downloadAssets
@@ -11227,6 +11276,57 @@ paths:
1122711276
description: default response
1122811277
tags:
1122911278
- Maintenance
11279+
/v1/maintenance/_fixAssets:
11280+
get:
11281+
description: Returns the current results of the fix assets inconsistencies process.
11282+
Use this to poll for completion after starting the process.
11283+
operationId: getFixAssetsProgress
11284+
responses:
11285+
"200":
11286+
content:
11287+
application/json:
11288+
schema:
11289+
type: object
11290+
description: "ResponseEntityView wrapping a list of task result maps,\
11291+
\ each containing total, errorsFixed, initialTime, finalTime, and\
11292+
\ description"
11293+
description: Current fix task results
11294+
"401":
11295+
content:
11296+
application/json: {}
11297+
description: Unauthorized - authentication required
11298+
"403":
11299+
content:
11300+
application/json: {}
11301+
description: Forbidden - CMS Administrator role required
11302+
summary: Poll fix assets progress
11303+
tags:
11304+
- Maintenance
11305+
post:
11306+
description: Runs all registered FixTask classes that check for and fix database
11307+
inconsistencies. Returns task results when complete.
11308+
operationId: startFixAssets
11309+
responses:
11310+
"200":
11311+
content:
11312+
application/json:
11313+
schema:
11314+
type: object
11315+
description: "ResponseEntityView wrapping a list of task result maps,\
11316+
\ each containing total, errorsFixed, initialTime, finalTime, and\
11317+
\ description"
11318+
description: Fix tasks completed
11319+
"401":
11320+
content:
11321+
application/json: {}
11322+
description: Unauthorized - authentication required
11323+
"403":
11324+
content:
11325+
application/json: {}
11326+
description: Forbidden - CMS Administrator role required
11327+
summary: Start fix assets inconsistencies
11328+
tags:
11329+
- Maintenance
1123011330
/v1/maintenance/_oldVersions:
1123111331
delete:
1123211332
description: "Deletes all versions of versionable objects (contentlets, containers,\
@@ -23142,6 +23242,39 @@ components:
2314223242
type: string
2314323243
variable:
2314423244
type: string
23245+
CleanAssetsStatusView:
23246+
type: object
23247+
properties:
23248+
currentFiles:
23249+
type: integer
23250+
format: int32
23251+
description: Number of directories processed so far
23252+
example: 12500
23253+
deleted:
23254+
type: integer
23255+
format: int32
23256+
description: Number of orphan directories deleted
23257+
example: 83
23258+
running:
23259+
type: boolean
23260+
description: Whether the process is currently running
23261+
example: true
23262+
status:
23263+
type: string
23264+
description: "Current status description: Starting, Counting, Cleaning,\
23265+
\ Finished, or Error message"
23266+
example: Cleaning
23267+
totalFiles:
23268+
type: integer
23269+
format: int32
23270+
description: Total number of asset directories to process
23271+
example: 45000
23272+
required:
23273+
- currentFiles
23274+
- deleted
23275+
- running
23276+
- status
23277+
- totalFiles
2314523278
ColumnField:
2314623279
type: object
2314723280
allOf:
@@ -29109,6 +29242,29 @@ components:
2910929242
type: array
2911029243
items:
2911129244
type: string
29245+
ResponseEntityCleanAssetsStatusView:
29246+
type: object
29247+
properties:
29248+
entity:
29249+
$ref: "#/components/schemas/CleanAssetsStatusView"
29250+
errors:
29251+
type: array
29252+
items:
29253+
$ref: "#/components/schemas/ErrorEntity"
29254+
i18nMessagesMap:
29255+
type: object
29256+
additionalProperties:
29257+
type: string
29258+
messages:
29259+
type: array
29260+
items:
29261+
$ref: "#/components/schemas/MessageEntity"
29262+
pagination:
29263+
$ref: "#/components/schemas/Pagination"
29264+
permissions:
29265+
type: array
29266+
items:
29267+
type: string
2911229268
ResponseEntityCompanyConfigView:
2911329269
type: object
2911429270
properties:
@@ -31593,6 +31749,33 @@ components:
3159331749
type: array
3159431750
items:
3159531751
type: string
31752+
ResponseEntityViewListMap:
31753+
type: object
31754+
properties:
31755+
entity:
31756+
type: array
31757+
items:
31758+
type: object
31759+
additionalProperties:
31760+
type: object
31761+
errors:
31762+
type: array
31763+
items:
31764+
$ref: "#/components/schemas/ErrorEntity"
31765+
i18nMessagesMap:
31766+
type: object
31767+
additionalProperties:
31768+
type: string
31769+
messages:
31770+
type: array
31771+
items:
31772+
$ref: "#/components/schemas/MessageEntity"
31773+
pagination:
31774+
$ref: "#/components/schemas/Pagination"
31775+
permissions:
31776+
type: array
31777+
items:
31778+
type: string
3159631779
ResponseEntityViewListMulitreeView:
3159731780
type: object
3159831781
properties:

0 commit comments

Comments
 (0)