Skip to content

Commit

Permalink
docs: improve token refresh docu (#1123)
Browse files Browse the repository at this point in the history
* docs: improve token refresh docu

* fix numbering
  • Loading branch information
paullatzelsperger authored Mar 12, 2024
1 parent a939764 commit 88db876
Show file tree
Hide file tree
Showing 5 changed files with 173 additions and 42 deletions.
69 changes: 69 additions & 0 deletions docs/development/dataplane-signaling/AutomaticRefreshEdrApi.drawio
Original file line number Diff line number Diff line change
@@ -0,0 +1,69 @@
<mxfile host="Electron" modified="2024-03-12T12:05:42.507Z" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/24.0.4 Chrome/120.0.6099.109 Electron/28.1.0 Safari/537.36" etag="w7PgxH3aSy8QzgqONvjS" version="24.0.4" type="device">
<diagram name="Page-1" id="QkwFA1DzPIJVPvUpdssr">
<mxGraphModel dx="2086" dy="1930" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="827" pageHeight="1169" math="0" shadow="0">
<root>
<mxCell id="0" />
<mxCell id="1" parent="0" />
<mxCell id="9Vp6ap9HHpzuf-tuijH6-1" value="&lt;div align=&quot;left&quot;&gt;CONSUMER&lt;/div&gt;" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#dae8fc;strokeColor=#6c8ebf;align=left;verticalAlign=top;" parent="1" vertex="1">
<mxGeometry x="-420" y="-20" width="450" height="280" as="geometry" />
</mxCell>
<mxCell id="9Vp6ap9HHpzuf-tuijH6-2" value="Consumer ControlPlane" style="rounded=1;whiteSpace=wrap;html=1;" parent="1" vertex="1">
<mxGeometry x="-350" y="30" width="330" height="180" as="geometry" />
</mxCell>
<mxCell id="9Vp6ap9HHpzuf-tuijH6-4" value="DSP API" style="rounded=1;whiteSpace=wrap;html=1;arcSize=41;rotation=90;fillColor=#d0cee2;strokeColor=#56517e;" parent="1" vertex="1">
<mxGeometry x="-60" y="80" width="70" height="40" as="geometry" />
</mxCell>
<mxCell id="9Vp6ap9HHpzuf-tuijH6-15" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;entryX=0;entryY=0.5;entryDx=0;entryDy=0;exitX=0.75;exitY=0;exitDx=0;exitDy=0;dashed=1;startArrow=classic;startFill=1;" parent="1" source="9Vp6ap9HHpzuf-tuijH6-6" target="9Vp6ap9HHpzuf-tuijH6-16" edge="1">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="9Vp6ap9HHpzuf-tuijH6-6" value="EDR API" style="rounded=1;whiteSpace=wrap;html=1;arcSize=41;rotation=90;fillColor=#d0cee2;strokeColor=#56517e;align=center;" parent="1" vertex="1">
<mxGeometry x="-510" y="100" width="180" height="40" as="geometry" />
</mxCell>
<mxCell id="9Vp6ap9HHpzuf-tuijH6-8" value="GET /edrs/{id}" style="endArrow=classic;html=1;rounded=0;fontFamily=Courier New;entryX=0.75;entryY=1;entryDx=0;entryDy=0;exitX=1.05;exitY=0.661;exitDx=0;exitDy=0;exitPerimeter=0;" parent="1" source="9Vp6ap9HHpzuf-tuijH6-11" target="9Vp6ap9HHpzuf-tuijH6-6" edge="1">
<mxGeometry x="0.0018" width="50" height="50" relative="1" as="geometry">
<mxPoint x="-600" y="165" as="sourcePoint" />
<mxPoint x="-450" y="172" as="targetPoint" />
<mxPoint as="offset" />
</mxGeometry>
</mxCell>
<mxCell id="9Vp6ap9HHpzuf-tuijH6-9" value="(1)" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontSize=16;fontColor=#FF3333;" parent="1" vertex="1">
<mxGeometry x="-610" y="130" width="70" height="30" as="geometry" />
</mxCell>
<mxCell id="9Vp6ap9HHpzuf-tuijH6-11" value="CLIENT APPLICATION" style="rounded=0;whiteSpace=wrap;html=1;align=left;verticalAlign=top;fillColor=#f5f5f5;fontColor=#333333;strokeColor=#666666;" parent="1" vertex="1">
<mxGeometry x="-740" y="-20" width="90" height="280" as="geometry" />
</mxCell>
<mxCell id="9Vp6ap9HHpzuf-tuijH6-12" value="(2)" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontSize=16;fontColor=#FF3333;rotation=0;dashed=1;" parent="1" vertex="1">
<mxGeometry x="-440" y="170" width="70" height="30" as="geometry" />
</mxCell>
<mxCell id="9Vp6ap9HHpzuf-tuijH6-13" value="POST /token/refresh?refresh_token=..." style="endArrow=classic;html=1;rounded=0;fontFamily=Courier New;fillColor=#ffe6cc;strokeColor=#d79b00;dashed=1;startArrow=classic;startFill=1;" parent="1" source="9Vp6ap9HHpzuf-tuijH6-16" edge="1">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="-20" y="170" as="sourcePoint" />
<mxPoint x="350" y="170" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="9Vp6ap9HHpzuf-tuijH6-14" value="(3)" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontSize=16;fontColor=#FF3333;dashed=1;" parent="1" vertex="1">
<mxGeometry x="-240" y="180" width="70" height="30" as="geometry" />
</mxCell>
<mxCell id="9Vp6ap9HHpzuf-tuijH6-16" value="TokenRefreshHandler" style="rounded=1;whiteSpace=wrap;html=1;" parent="1" vertex="1">
<mxGeometry x="-260" y="150" width="150" height="30" as="geometry" />
</mxCell>
<mxCell id="dR5asBM_HeGZLUQ2tBJT-1" value="(4)" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontSize=16;fontColor=#FF3333;rotation=0;dashed=1;" parent="1" vertex="1">
<mxGeometry x="100" y="170" width="70" height="30" as="geometry" />
</mxCell>
<mxCell id="dR5asBM_HeGZLUQ2tBJT-6" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;entryX=1;entryY=0.75;entryDx=0;entryDy=0;" parent="1" source="dR5asBM_HeGZLUQ2tBJT-2" target="9Vp6ap9HHpzuf-tuijH6-11" edge="1">
<mxGeometry relative="1" as="geometry">
<Array as="points">
<mxPoint x="-420" y="190" />
</Array>
</mxGeometry>
</mxCell>
<mxCell id="dR5asBM_HeGZLUQ2tBJT-2" value="exp?" style="rhombus;whiteSpace=wrap;html=1;" parent="1" vertex="1">
<mxGeometry x="-440" y="146" width="40" height="40" as="geometry" />
</mxCell>
<mxCell id="dR5asBM_HeGZLUQ2tBJT-7" value="(3)/(5)" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontSize=16;fontColor=#FF3333;rotation=0;dashed=1;" parent="1" vertex="1">
<mxGeometry x="-580" y="190" width="70" height="30" as="geometry" />
</mxCell>
</root>
</mxGraphModel>
</diagram>
</mxfile>
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
75 changes: 53 additions & 22 deletions docs/development/dataplane-signaling/ManualRefresh.drawio
Original file line number Diff line number Diff line change
@@ -1,52 +1,83 @@
<mxfile host="app.diagrams.net" modified="2024-03-05T13:49:42.163Z" agent="Mozilla/5.0 (X11; Linux x86_64; rv:123.0) Gecko/20100101 Firefox/123.0" etag="LcFI5pNSsZdChNOywfmA" version="24.0.1" type="device">
<mxfile host="Electron" modified="2024-03-12T10:53:18.414Z" agent="Mozilla/5.0 (Macintosh; Intel Mac OS X 10_15_7) AppleWebKit/537.36 (KHTML, like Gecko) draw.io/24.0.4 Chrome/120.0.6099.109 Electron/28.1.0 Safari/537.36" etag="NqwI7NTNUX9M5dtRHCLC" version="24.0.4" type="device">
<diagram name="Page-1" id="QkwFA1DzPIJVPvUpdssr">
<mxGraphModel dx="4051" dy="2459" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="827" pageHeight="1169" math="0" shadow="0">
<mxGraphModel dx="2676" dy="2356" grid="1" gridSize="10" guides="1" tooltips="1" connect="1" arrows="1" fold="1" page="1" pageScale="1" pageWidth="827" pageHeight="1169" math="0" shadow="0">
<root>
<mxCell id="0" />
<mxCell id="1" parent="0" />
<mxCell id="9Vp6ap9HHpzuf-tuijH6-1" value="&lt;div align=&quot;left&quot;&gt;CONSUMER&lt;/div&gt;" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#dae8fc;strokeColor=#6c8ebf;align=left;verticalAlign=top;" vertex="1" parent="1">
<mxCell id="9Vp6ap9HHpzuf-tuijH6-1" value="&lt;div align=&quot;left&quot;&gt;CONSUMER&lt;/div&gt;" style="rounded=0;whiteSpace=wrap;html=1;fillColor=#dae8fc;strokeColor=#6c8ebf;align=left;verticalAlign=top;" parent="1" vertex="1">
<mxGeometry x="-420" y="-20" width="450" height="280" as="geometry" />
</mxCell>
<mxCell id="9Vp6ap9HHpzuf-tuijH6-2" value="Consumer ControlPlane" style="rounded=1;whiteSpace=wrap;html=1;" vertex="1" parent="1">
<mxCell id="9Vp6ap9HHpzuf-tuijH6-2" value="Consumer ControlPlane" style="rounded=1;whiteSpace=wrap;html=1;" parent="1" vertex="1">
<mxGeometry x="-350" y="30" width="330" height="180" as="geometry" />
</mxCell>
<mxCell id="9Vp6ap9HHpzuf-tuijH6-4" value="DSP API" style="rounded=1;whiteSpace=wrap;html=1;arcSize=41;rotation=90;fillColor=#d0cee2;strokeColor=#56517e;" vertex="1" parent="1">
<mxCell id="9Vp6ap9HHpzuf-tuijH6-4" value="DSP API" style="rounded=1;whiteSpace=wrap;html=1;arcSize=41;rotation=90;fillColor=#d0cee2;strokeColor=#56517e;" parent="1" vertex="1">
<mxGeometry x="-60" y="80" width="70" height="40" as="geometry" />
</mxCell>
<mxCell id="9Vp6ap9HHpzuf-tuijH6-15" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;entryX=0;entryY=0.5;entryDx=0;entryDy=0;exitX=0.75;exitY=0;exitDx=0;exitDy=0;" edge="1" parent="1" source="9Vp6ap9HHpzuf-tuijH6-6" target="9Vp6ap9HHpzuf-tuijH6-16">
<mxCell id="9Vp6ap9HHpzuf-tuijH6-15" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;entryX=0;entryY=0.5;entryDx=0;entryDy=0;exitX=0.75;exitY=0;exitDx=0;exitDy=0;" parent="1" source="9Vp6ap9HHpzuf-tuijH6-6" target="9Vp6ap9HHpzuf-tuijH6-16" edge="1">
<mxGeometry relative="1" as="geometry" />
</mxCell>
<mxCell id="9Vp6ap9HHpzuf-tuijH6-6" value="Management API" style="rounded=1;whiteSpace=wrap;html=1;arcSize=41;rotation=90;fillColor=#d0cee2;strokeColor=#56517e;" vertex="1" parent="1">
<mxGeometry x="-510" y="100" width="180" height="40" as="geometry" />
<mxCell id="9Vp6ap9HHpzuf-tuijH6-6" value="Management API" style="rounded=1;whiteSpace=wrap;html=1;arcSize=41;rotation=90;fillColor=#d0cee2;strokeColor=#56517e;" parent="1" vertex="1">
<mxGeometry x="-475" y="150" width="110" height="40" as="geometry" />
</mxCell>
<mxCell id="9Vp6ap9HHpzuf-tuijH6-8" value="POST /token/refresh" style="endArrow=classic;html=1;rounded=0;fontFamily=Courier New;entryX=0.75;entryY=1;entryDx=0;entryDy=0;exitX=1.05;exitY=0.661;exitDx=0;exitDy=0;exitPerimeter=0;" edge="1" parent="1" source="9Vp6ap9HHpzuf-tuijH6-11" target="9Vp6ap9HHpzuf-tuijH6-6">
<mxGeometry x="0.0018" width="50" height="50" relative="1" as="geometry">
<mxPoint x="-600" y="165" as="sourcePoint" />
<mxPoint x="-450" y="172" as="targetPoint" />
<mxPoint as="offset" />
</mxGeometry>
</mxCell>
<mxCell id="9Vp6ap9HHpzuf-tuijH6-9" value="(1)" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontSize=16;fontColor=#FF3333;" vertex="1" parent="1">
<mxGeometry x="-580" y="170" width="70" height="30" as="geometry" />
<mxCell id="9Vp6ap9HHpzuf-tuijH6-9" value="(4)" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontSize=16;fontColor=#FF3333;" parent="1" vertex="1">
<mxGeometry x="-580" y="200" width="70" height="30" as="geometry" />
</mxCell>
<mxCell id="9Vp6ap9HHpzuf-tuijH6-11" value="CLIENT APPLICATION" style="rounded=0;whiteSpace=wrap;html=1;align=left;verticalAlign=top;fillColor=#f5f5f5;fontColor=#333333;strokeColor=#666666;" vertex="1" parent="1">
<mxCell id="9Vp6ap9HHpzuf-tuijH6-11" value="CLIENT APPLICATION" style="rounded=0;whiteSpace=wrap;html=1;align=left;verticalAlign=top;fillColor=#f5f5f5;fontColor=#333333;strokeColor=#666666;" parent="1" vertex="1">
<mxGeometry x="-740" y="-20" width="90" height="280" as="geometry" />
</mxCell>
<mxCell id="9Vp6ap9HHpzuf-tuijH6-12" value="(2)" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontSize=16;fontColor=#FF3333;rotation=90;" vertex="1" parent="1">
<mxCell id="9Vp6ap9HHpzuf-tuijH6-12" value="(5)" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontSize=16;fontColor=#FF3333;rotation=0;" parent="1" vertex="1">
<mxGeometry x="-220" y="180" width="70" height="30" as="geometry" />
</mxCell>
<mxCell id="9Vp6ap9HHpzuf-tuijH6-13" value="POST /token/refresh?refresh_token=..." style="endArrow=classic;html=1;rounded=0;fontFamily=Courier New;fillColor=#ffe6cc;strokeColor=#d79b00;" edge="1" parent="1" source="9Vp6ap9HHpzuf-tuijH6-16">
<mxCell id="9Vp6ap9HHpzuf-tuijH6-13" value="POST /token/refresh?refresh_token=..." style="endArrow=classic;html=1;rounded=0;fontFamily=Courier New;fillColor=#ffe6cc;strokeColor=#d79b00;" parent="1" source="9Vp6ap9HHpzuf-tuijH6-16" edge="1">
<mxGeometry width="50" height="50" relative="1" as="geometry">
<mxPoint x="-20" y="170" as="sourcePoint" />
<mxPoint x="350" y="170" as="targetPoint" />
</mxGeometry>
</mxCell>
<mxCell id="9Vp6ap9HHpzuf-tuijH6-14" value="(3)" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontSize=16;fontColor=#FF3333;" vertex="1" parent="1">
<mxCell id="9Vp6ap9HHpzuf-tuijH6-14" value="(6)" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontSize=16;fontColor=#FF3333;" parent="1" vertex="1">
<mxGeometry x="100" y="180" width="70" height="30" as="geometry" />
</mxCell>
<mxCell id="9Vp6ap9HHpzuf-tuijH6-16" value="TokenRefreshHandler" style="rounded=1;whiteSpace=wrap;html=1;" vertex="1" parent="1">
<mxCell id="9Vp6ap9HHpzuf-tuijH6-16" value="TokenRefreshHandler" style="rounded=1;whiteSpace=wrap;html=1;" parent="1" vertex="1">
<mxGeometry x="-260" y="150" width="150" height="30" as="geometry" />
</mxCell>
<mxCell id="c1sjahpwHX4zWzdY5Vkf-1" value="EDR API" style="rounded=1;whiteSpace=wrap;html=1;arcSize=41;rotation=90;fillColor=#d0cee2;strokeColor=#56517e;" vertex="1" parent="1">
<mxGeometry x="-470" y="40" width="100" height="40" as="geometry" />
</mxCell>
<mxCell id="c1sjahpwHX4zWzdY5Vkf-4" value="GET /edrs/{id}" style="endArrow=classic;html=1;rounded=0;fontFamily=Courier New;entryX=0.75;entryY=1;entryDx=0;entryDy=0;exitX=1.05;exitY=0.661;exitDx=0;exitDy=0;exitPerimeter=0;" edge="1" parent="1">
<mxGeometry x="0.0018" width="50" height="50" relative="1" as="geometry">
<mxPoint x="-647.5" y="55" as="sourcePoint" />
<mxPoint x="-442.5" y="55" as="targetPoint" />
<mxPoint as="offset" />
</mxGeometry>
</mxCell>
<mxCell id="c1sjahpwHX4zWzdY5Vkf-5" value="(1)" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontSize=16;fontColor=#FF3333;" vertex="1" parent="1">
<mxGeometry x="-612.5" y="20" width="70" height="30" as="geometry" />
</mxCell>
<mxCell id="c1sjahpwHX4zWzdY5Vkf-6" value="GET /some/data" style="edgeStyle=orthogonalEdgeStyle;rounded=0;orthogonalLoop=1;jettySize=auto;html=1;exitX=0.5;exitY=1;exitDx=0;exitDy=0;fontFamily=Courier New;" edge="1" parent="1" source="9Vp6ap9HHpzuf-tuijH6-11">
<mxGeometry relative="1" as="geometry">
<mxPoint x="-390" y="208" as="sourcePoint" />
<mxPoint x="350" y="370" as="targetPoint" />
<Array as="points">
<mxPoint x="-695" y="370" />
</Array>
</mxGeometry>
</mxCell>
<mxCell id="c1sjahpwHX4zWzdY5Vkf-7" value="(2)" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontSize=16;fontColor=#FF3333;" vertex="1" parent="1">
<mxGeometry x="-545" y="330" width="70" height="30" as="geometry" />
</mxCell>
<mxCell id="c1sjahpwHX4zWzdY5Vkf-8" value="" style="sketch=0;outlineConnect=0;fontColor=#232F3E;gradientColor=none;fillColor=#232F3D;strokeColor=none;dashed=0;verticalLabelPosition=bottom;verticalAlign=top;align=center;html=1;fontSize=12;fontStyle=0;aspect=fixed;pointerEvents=1;shape=mxgraph.aws4.alert;" vertex="1" parent="1">
<mxGeometry x="-723.26" y="190" width="56.52" height="50" as="geometry" />
</mxCell>
<mxCell id="c1sjahpwHX4zWzdY5Vkf-9" value="(3)" style="text;html=1;align=center;verticalAlign=middle;whiteSpace=wrap;rounded=0;fontSize=16;fontColor=#FF3333;" vertex="1" parent="1">
<mxGeometry x="-750" y="170" width="70" height="30" as="geometry" />
</mxCell>
<mxCell id="9Vp6ap9HHpzuf-tuijH6-8" value="POST /token/refresh" style="endArrow=classic;html=1;rounded=0;fontFamily=Courier New;entryX=0.75;entryY=1;entryDx=0;entryDy=0;exitX=1;exitY=0.75;exitDx=0;exitDy=0;" parent="1" source="c1sjahpwHX4zWzdY5Vkf-9" target="9Vp6ap9HHpzuf-tuijH6-6" edge="1">
<mxGeometry x="0.0018" width="50" height="50" relative="1" as="geometry">
<mxPoint x="-640" y="110" as="sourcePoint" />
<mxPoint x="-450" y="172" as="targetPoint" />
<mxPoint as="offset" />
</mxGeometry>
</mxCell>
</root>
</mxGraphModel>
</diagram>
Expand Down
Binary file modified docs/development/dataplane-signaling/ManualRefresh.drawio.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 88db876

Please sign in to comment.