685384 - Storage API docs reference undefined "depth" property

Status: VERIFIED FIXED

(Cloud Services Graveyard :: Server: Sync, defect)

Description

[Ryan Kelly [:rfkelly]]

Reviewing docs at:

   http://docs.services.mozilla.com/storage/apis-1.1.htm#apis

The entry for:

   DELETE https://server/pathname/version/username/storage/collection

States that the deletions can be ordered "by depth, then by sortindex".

What's "depth"?  It's not defined elsewhere on the page.

Comment 1

[Toby Elliott [:telliott]]

Heh, wow. Depth is a really old field that we used to have in the early days to try to do trees on the server side. Tarek, is this index even supported in python? I seriously doubt it, and we probably need to pull the line.

Comment 2

[Ryan Kelly [:rfkelly]]

The only reference to "depthindex" in server-storage code is the following comment in the testcases:

        # "sort"
        #   'oldest' - Orders by modification date (oldest first)
        #   'newest' - Orders by modification date (newest first)
        #   'index' - Orders by the sortindex (ordered lists)
        #   'depthindex' - Orders by depth, then by sortindex (ordered trees)

        # sort is used only if limit is used.
        # check this with toby

Comment 3

[Tarek Ziadé (:tarek)]

It's not implemented, we can nuke that doc line, thanks for the catch Ryan

Comment 4

[Ryan Kelly [:rfkelly]]

References to "depth" removed in commits:
http://hg.mozilla.org/services/docs/rev/603a3a0b21d3
http://hg.mozilla.org/services/server-storage/rev/c6bd42742071