Repository Index

Repository Manager Index
Indexing is a central aspect of the Repository Manager server.
The role of the repository indexing process is to perform the heavy and long process of collecting and processing all information about a given repository and storing it in a nicely formatted and properly accessible file called the repository index file, alongside files relevant to applications, so that the information contained in them can be accessed instantly and frequently when needed.
The repository indexing process usually runs once per day in order to accomodate potential application updates, and always pulls latest changes from version control before it can start.
All files relevant to the repository index are contained in a "data" directory in the server's root, with the "index file" called index.json, located inside of the "data" directory.
If the index file happens to be missing/corrupt when required, an empty index will be generated and running an index will be required for repository information to be available.
The index is never directly exposed to the user, and is only used internally. The only way to access the contents of the index externally is through the API.


Index File
Below is a tree of the index file structure:
  • {}
    • {} repository
      • name
      • provider
      • description
    • [] categories
      • {} <category objects>
        • name
        • display_name
        • singular
        • plural
    • [] contents
      • {} <application objects>
          • <contents of manifest>
        • {} source
          • <contents of manifest>
          • <contents of manifest>
        • {} metaxml
          • {} app
            • <contents of meta.xml in JSON>
        • {} index_computed_info
          • package_type (dol/elf/thm)
          • md5_hash
          • release_date (int, unix epoch)
          • icon_size (int)
          • compressed_size (int)
          • binary_size (int)
          • uncompressed_size (int)
          • peripherals (in HBB-compatible format)
          • [] subdirectories