Interface: ApiPurgeResponse
Defined in: core/purge.ts:32
Response of action=purge.
Extends
Properties
batchcomplete?
optionalbatchcomplete?:true
Defined in: envelope/index.ts:178
Present and true when all data for the current batch of pages has been
returned. Continuation may still be ongoing: the generator runs again for
the next batch of pages, and list/meta modules may continue independently.
Serialized as a real boolean under formatversion=2.
Inherited from
converted?
optionalconverted?:ApiQueryTitlePair[]
Defined in: core/purge.ts:43
Title conversions on a language-variant wiki, same shape as query.converted.
curtimestamp?
optionalcurtimestamp?:string
Defined in: envelope/index.ts:187
Current server time (ISO 8601), present when the request set curtimestamp.
Inherited from
errorlang?
optionalerrorlang?:string
Defined in: envelope/index.ts:199
Language error messages are rendered in (responselanginfo=1).
Inherited from
normalized?
optionalnormalized?:ApiQueryNormalized[]
Defined in: core/purge.ts:40
Title normalizations the pageSet applied before the purge (e.g. underscore
and capitalization fixes), same shape as query.normalized.
purge
purge:
ApiPurgeEntry[]
Defined in: core/purge.ts:34
Result of action=purge; one entry per targeted page.
redirects?
optionalredirects?:ApiQueryTitlePair[]
Defined in: core/purge.ts:46
Redirect resolutions (with redirects=1).
requestid?
optionalrequestid?:string
Defined in: envelope/index.ts:190
Opaque value echoed back from the request's requestid parameter.
Inherited from
servedby?
optionalservedby?:string
Defined in: envelope/index.ts:184
Identifier of the server that handled the request. Present by default on error responses; on successful responses only when explicitly requested.
Inherited from
uselang?
optionaluselang?:string
Defined in: envelope/index.ts:196
Language of the interface strings in the response (responselanginfo=1).
Inherited from
warnings?
optionalwarnings?:ApiWarnings
Defined in: envelope/index.ts:193
Non-fatal warnings; shape depends on errorformat (see ApiWarnings).