SAM: Document session creation responses for subsessions #18

Open
opened 2025-04-21 14:47:23 -04:00 by idk · 2 comments
Owner

Opened 14 months ago

Last modified 14 months ago

#2698assigneddefect

SAM: Document session creation responses for subsessions

Reported by:aarghOwned by:idk
Priority:
trivial
Milestone:
undecided
Component:
www/i2p
Version:

Keywords:
SAM
Cc:

Parent Tickets:

Sensitive:
no

Description

In the "SAM Sessions / Session Creation Response" section of docs/api/samv3

In SAM 3.3 or higher, after a style=MASTER session has been created and a subsequent subsession "SESSION ADD" message is sent, I've noticed that…

*ID=$nickname appears to be optional, because it is sent upon success when a subsession is created, but not when a new master session is created

DESTINATION=$privkey appears to now be optional instead of required because it is omitted when a subsession is created and only sent when a master session is added

*MESSAGE=$message appears to be optional because it can be sent when a subsession creation was successful (e.g.: MESSAGE=ADD $nickname)

*denotes parameters that appear to be omitted from that particular section of the doc

Alternatively, maybe rename the "Creating a Subsession" section to "Subsession Creation Request" and add a new "Subsession Creation Response" section afterwards with the parameters for better clarity.

Subtickets

Opened [14 months ago](/timeline?from=2020-02-29T23%3A31%3A26Z&precision=second "See timeline at Feb 29, 2020 11:31:26 PM") Last modified [14 months ago](/timeline?from=2020-03-16T20%3A53%3A14Z&precision=second "See timeline at Mar 16, 2020 8:53:14 PM") ## [\#2698](/ticket/2698)[assigned](/query?status=assigned)[defect](/query?status=!closed&type=defect) # SAM: Document session creation responses for subsessions Reported by:[aargh](/query?status=!closed&reporter=aargh)Owned by:[idk](/query?status=!closed&owner=eyedeekay) Priority: [trivial](/query?status=!closed&priority=trivial) Milestone: [undecided](/milestone/undecided "No date set") Component: [www/i2p](/query?status=!closed&component=www%2Fi2p) Version: Keywords: [SAM](/query?status=!closed&keywords=~SAM) Cc: Parent Tickets: Sensitive: [no](/query?status=!closed&sensitive=0) ### Description In the "SAM Sessions / Session Creation Response" section of docs/api/samv3 In SAM 3.3 or higher, after a style=MASTER session has been created and a subsequent subsession "SESSION ADD" message is sent, I've noticed that… \*ID=$nickname appears to be optional, because it is sent upon success when a subsession is created, but not when a new master session is created DESTINATION=$privkey appears to now be optional instead of required because it is omitted when a subsession is created and only sent when a master session is added \*MESSAGE=$message appears to be optional because it can be sent when a subsession creation was successful (e.g.: MESSAGE=ADD $nickname) \*denotes parameters that appear to be omitted from that particular section of the doc Alternatively, maybe rename the "Creating a Subsession" section to "Subsession Creation Request" and add a new "Subsession Creation Response" section afterwards with the parameters for better clarity. ### Subtickets
idk added this to the undecided milestone 2025-04-21 14:47:23 -04:00
idk added the
#2698
i2p
undecided
www
labels 2025-04-21 14:47:23 -04:00
idk self-assigned this 2025-04-21 14:47:23 -04:00
Author
Owner

comment:2 Changed 14 months ago by idk

I will be comparing and contrasting messages given by I2P and i2pd's SAM implementations this week.

[comment:2](https://trac.i2p2.de/\#comment:2) Changed [14 months ago](https://trac.i2p2.de//timeline?from=2020-03-16T20%3A53%3A14Z&precision=second "See timeline at Mar 16, 2020 8:53:14 PM") by idk I will be comparing and contrasting messages given by I2P and i2pd's SAM implementations this week.
Author
Owner

comment:1 Changed 14 months ago by zzz

Owner:
changed from sadie to _idk_Status:new →
assigned

also the possibility these are bugs in the code, not the doc…

[comment:1](https://trac.i2p2.de/\#comment:1) Changed [14 months ago](https://trac.i2p2.de//timeline?from=2020-03-01T19%3A05%3A58Z&precision=second "See timeline at Mar 1, 2020 7:05:58 PM") by zzz Owner: changed from _sadie_ to _idk_Status:new → assigned also the possibility these are bugs in the code, not the doc…
Sign in to join this conversation.
1 Participants
Notifications
Due Date
No due date set.
Dependencies

No dependencies set.

Reference: I2P_Developers/i2p.www#18
No description provided.