[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           |   Keywords:
Actual Points:                   |  Parent ID:
       Points:                   |   Reviewer:
      Sponsor:                   |
---------------------------------+--------------------------
 Hi Karsten, would you mind if we add a few new @type annotations? Stem is
 getting the ability to parse detached signatures (#28495), and sometimes
 is called to parse individual router status entries.

 The way I've designed Stem expects that all descriptor types have a type
 annotation that users can provide to say 'please parse this as X'. As such
 I need to either make up my own annotations or (better!) ask for us to
 expand our official set.

 In particular I'm hoping for...

 {{{
 @type detached-signature 1.0

   Detached signature as per section 3.10 of the dir-spec,
   and downloadable for five minutes each hour via the
   '/tor/status-vote/next/consensus-signatures' resource.

 @type router-status-entry-2 1.0


   Individual router status entry from a v2 network status
   document.

 @type router-status-entry-3 1.0


   Individual router status entry from a v3 network status
   document.

 @type router-status-entry-micro-3 1.0


   Individual router status entry from a v3 microdescriptor
   network status document.
 }}}

 Thanks!

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