[metrics-bugs] #28615 [Metrics/Library]: Additional @type annotation

[Tor Bug Tracker & Wiki]

#28615: Additional @type annotation
-----------------------------+------------------------------
 Reporter:  atagar           |          Owner:  metrics-team
     Type:  enhancement      |         Status:  new
 Priority:  Medium           |      Milestone:
Component:  Metrics/Library  |        Version:
 Severity:  Normal           |     Resolution:
 Keywords:                   |  Actual Points:
Parent ID:                   |         Points:
 Reviewer:                   |        Sponsor:
-----------------------------+------------------------------

Comment (by karsten):

 Replying to [comment:4 atagar]:
 > Hi Karsten, I also need a @type for bandwidth files. Stem is learning to
 parse these since they'll soon be available via DirPorts...
 >
 > https://trac.torproject.org/projects/tor/ticket/29056
 > https://gitweb.torproject.org/torspec.git/tree/bandwidth-file-spec.txt

 What do you suggest as `@type` annotation for bandwidth files?

 > Mind if we move this forward?

 So, regarding the four suggested @type annotations from above (in slightly
 different order):

  - `@type detached-signature 1.0` seems plausible to me. Let's add it.
  - `@type router-status-entry-3 1.0` might be okay, too, even though it's
 not a descriptor of its own, but because it's defined in control-spec as
 response to a command there. We might want to document whether descriptor
 (parts) can be obtained via dir-spec, control-spec, or both. Oh, and I
 wonder if `@type network-status-entry-3 1.0` would be more consistent with
 the consensus and vote equivalents, what do you think?
  - `@type router-status-entry-micro-3 1.0` might be okay for the same
 reasons as above, though possibly renamed to `@type network-status-
 microdesc-entry-3 1.0`. One question though: which one do you get when
 running that control port command above? The unflavored or the microdesc-
 flavored entry?
  - `@type router-status-entry-2 1.0`, see above, except I'm unclear where
 you get this from in control-spec. And again, the slightly more consistent
 name could be `@type network-status-entry-2 1.0`.

 All these are questions and suggestions for discussion here.

--
Ticket URL: <https://trac.torproject.org/projects/tor/ticket/28615#comment:5>
Tor Bug Tracker & Wiki <https://trac.torproject.org/>
The Tor Project: anonymity online