Editing SimTX API v24/Packets/CatalogUpload

{{SimTX API v24 navigation}}
{{SimTX packet v24
| name = CatalogUpload
| id = 22
| hex = 0x16
| direction = c2s
| session = [[SimTX API v24/Extension catalog protocol|Control (catalog)]]
| size = Variable
| permission = <code>catalog.publish</code>
| reply = [[SimTX API v24/Packets/CatalogUploadResult|CatalogUploadResult]]
| group = catalog
}}
'''CatalogUpload''' publishes an extension or preset to the server's [[SimTX API v24/Extension catalog protocol|extension catalog]], or publishes a new revision of an entry the account already owns. It requires an authenticated control session whose account holds <code>catalog.publish</code>. The server answers with [[SimTX API v24/Packets/CatalogUploadResult|CatalogUploadResult]].

== Layout ==
{| class="wikitable"
! Field !! Type !! Description
|-
| <code>packetId</code> || <code>u8</code> || Always <code>22</code>.
|-
| <code>kind</code> || <code>UTF</code> || <code>extension</code> or <code>preset</code>. At most 16 characters.
|-
| <code>name</code> || <code>UTF</code> || Entry name, 1–64 characters after trimming.
|-
| <code>description</code> || <code>UTF</code> || At most 500 characters.
|-
| <code>categoryCount</code> || <code>i32</code> || 0–12.
|-
| <code>categories</code> || <code>categoryCount × UTF</code> || Each 1–32 characters, no commas or control characters.
|-
| <code>fileCount</code> || <code>i32</code> || 1–64 (presets: exactly 1).
|-
| <code>files</code> || <code>fileCount × { UTF path, UTF content }</code> || Path at most 128 characters; content at most 60,000 characters and 60,000 UTF-8 bytes.
|}

== Validation ==
The server checks the upload against the rules in [[SimTX API v24/Extension catalog protocol#Upload rules|Upload rules]] and reports the first problem it finds in [[SimTX API v24/Packets/CatalogUploadResult|CatalogUploadResult]]. Field lengths beyond the limits in the layout above close the connection instead, because the server stops reading the packet.

Without <code>catalog.publish</code>, the body is read and discarded, and the result is ''Publishing requires catalog.publish''.

== Revisions ==
Uploading an entry with the name of an entry the same account already owns replaces it: the ID stays the same and the revision increases. Names are compared without regard to case.

{{SimTX API v24 navbox}}
[[Category:SimTX API v24]]