Skip to content

Commit 16361fe

Browse files
committed
[SAFRAN-1026] Update Security Scheme edition documentation
1 parent 36767f4 commit 16361fe

14 files changed

Lines changed: 28 additions & 23 deletions

designs/soa/plugins/org.obeonetwork.dsl.soa.design/description/soa.odesign

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1485,14 +1485,14 @@
14851485
<firstModelOperations xsi:type="tool_1:SetValue" featureName="type" valueExpression="aql:newValue.instance"/>
14861486
</initialOperation>
14871487
</controls>
1488-
<controls xsi:type="properties:TextAreaDescription" name="soa::SecurityScheme description" labelExpression="aql:input.emfEditServices(self).getText(self.eClass().getEStructuralFeature('description')) + ':'" helpExpression="aql:input.emfEditServices(self).getDescription(self.eClass().getEStructuralFeature('description'))" isEnabledExpression="aql:self.eClass().getEStructuralFeature('description').changeable" valueExpression="aql:self.description">
1488+
<controls xsi:type="properties:TextDescription" name="soa::SecurityScheme name" labelExpression="aql:input.emfEditServices(self).getText(self.eClass().getEStructuralFeature('name')) + ':'" helpExpression="aql:input.emfEditServices(self).getDescription(self.eClass().getEStructuralFeature('name'))" isEnabledExpression="aql:self.eClass().getEStructuralFeature('name').changeable" valueExpression="aql:self.name">
14891489
<initialOperation>
1490-
<firstModelOperations xsi:type="tool_1:SetValue" featureName="description" valueExpression="var:newValue"/>
1490+
<firstModelOperations xsi:type="tool_1:SetValue" featureName="name" valueExpression="var:newValue"/>
14911491
</initialOperation>
14921492
</controls>
1493-
<controls xsi:type="properties:TextDescription" name="soa::SecurityScheme name" labelExpression="aql:input.emfEditServices(self).getText(self.eClass().getEStructuralFeature('name')) + ':'" helpExpression="aql:input.emfEditServices(self).getDescription(self.eClass().getEStructuralFeature('name'))" isEnabledExpression="aql:self.eClass().getEStructuralFeature('name').changeable" valueExpression="aql:self.name">
1493+
<controls xsi:type="properties:TextAreaDescription" name="soa::SecurityScheme description" labelExpression="aql:input.emfEditServices(self).getText(self.eClass().getEStructuralFeature('description')) + ':'" helpExpression="aql:input.emfEditServices(self).getDescription(self.eClass().getEStructuralFeature('description'))" isEnabledExpression="aql:self.eClass().getEStructuralFeature('description').changeable" valueExpression="aql:self.description">
14941494
<initialOperation>
1495-
<firstModelOperations xsi:type="tool_1:SetValue" featureName="name" valueExpression="var:newValue"/>
1495+
<firstModelOperations xsi:type="tool_1:SetValue" featureName="description" valueExpression="var:newValue"/>
14961496
</initialOperation>
14971497
</controls>
14981498
</groups>
@@ -1788,7 +1788,7 @@
17881788
<firstModelOperations xsi:type="tool_1:ChangeContext">
17891789
<subModelOperations xsi:type="tool_1:Let" variableName="invocationContext" valueExpression="addButton"/>
17901790
<subModelOperations xsi:type="tool_1:CreateInstance" typeName="soa::SecurityScheme" referenceName="securitySchemes">
1791-
<subModelOperations xsi:type="properties:DialogModelOperation" titleExpression="Security scheme edition">
1791+
<subModelOperations xsi:type="properties:DialogModelOperation" titleExpression="Security scheme creation">
17921792
<buttons labelExpression="Cancel" closeDialogOnClick="true" rollbackChangesOnClose="true">
17931793
<initialOperation>
17941794
<firstModelOperations xsi:type="tool_1:RemoveElement">

designs/soa/plugins/org.obeonetwork.dsl.soa.doc/doc/ISD - SOA Designer.html

Lines changed: 13 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
<p>
1111
<code>Authors</code> Stéphane Thibaudeau, Vincent Richard
1212
<br/>
13-
<code>Contacts</code> stephane.thibaudeau@obeo.fr, vincent.richard@obeo.fr
13+
<code>Contacts</code> vincent.richard@obeo.fr
1414
</p>
1515
<h1 id="ISDSOADesigner">ISD &#8211; SOA Designer</h1>
1616
<p>
@@ -865,21 +865,25 @@ <h5 id="Modlisationdesschmasdescurit">Modélisation des schémas de sécurité</
865865
<em>Component</em>.
866866
</p>
867867
<p>La création d&#8217;un
868-
<em>Security Scheme</em> déclenche l&#8217;affichage d&#8217;une boîte de dialogue permettant de le spécifier.
869-
<br/>Les données disponibles dans la boite du dialogue sont adaptées au type de
870-
<em>Security Scheme</em>:
868+
<em>Security Scheme</em> déclenche l&#8217;affichage d&#8217;une boîte de dialogue permettant de spécifier son type, son nom et sa description :
869+
<br/>
870+
<img border="0" src="pics/securityschemes/Dialog_SecurityScheme_Creation.png"/>
871+
</p>
872+
<p>Un double clic sur un
873+
<em>Security Scheme</em> déclenche l&#8217;affichge d&#8217;un dialogue d'édition permettant de spécifier les données spécifiques au type de
874+
<em>Security Scheme</em>.
871875
</p>
872876
<p>-
873877
<strong>Api Key:</strong>
874878
<br/>
875-
<img border="0" src="pics/securityschemes/Dialog_SecurityScheme_ApiKey.PNG"/>
879+
<img border="0" src="pics/securityschemes/Dialog_SecurityScheme_Edition_ApiKey.png"/>
876880
<br/>Un
877881
<em>Security Scheme</em> de type Api key permet la définition d&#8217;une clé, ainsi que la spécification de sa localisation: dans le header, la requête, ou le cookie.
878882
</p>
879883
<p>-
880884
<strong>HTTP:</strong>
881885
<br/>
882-
<img border="0" src="pics/securityschemes/Dialog_SecurityScheme_HTTP.PNG"/>
886+
<img border="0" src="pics/securityschemes/Dialog_SecurityScheme_Edition_HTTP.png"/>
883887
<br/>Un
884888
<em>Security Scheme</em> de type HTTP défini un schéma d&#8217;authentification de type Basic, ou Bearer.
885889
<br/>Dans le cas d&#8217;un schéma d&#8217;authentification de type Basic, le server attendra un mot de passe de type username:password, encodé en base-64.
@@ -888,19 +892,19 @@ <h5 id="Modlisationdesschmasdescurit">Modélisation des schémas de sécurité</
888892
<p>-
889893
<strong>OAuth2:</strong>
890894
<br/>
891-
<img border="0" src="pics/securityschemes/Dialog_SecurityScheme_OAuth2.PNG"/>
895+
<img border="0" src="pics/securityschemes/Dialog_SecurityScheme_Edition_OAuth2.png"/>
892896
</p>
893897
<p>-
894898
<strong>Open ID:</strong>
895899
<br/>
896-
<img border="0" src="pics/securityschemes/Dialog_SecurityScheme_OpenID.PNG"/>
900+
<img border="0" src="pics/securityschemes/Dialog_SecurityScheme_Edition_OpenID.png"/>
897901
</p>
898902
<p>Les
899903
<em>Security Scheme</em> de type OAuth2 et Open ID requièrent la spécification de
900904
<em>Flows</em>, ainsi que leurs
901905
<em>Scopes</em> respectifs:
902906
<br/>
903-
<img border="0" src="pics/securityschemes/Dialog_Flow.PNG"/>
907+
<img border="0" src="pics/securityschemes/Dialog_Flow_Edition.png"/>
904908
</p>
905909
<p>Les
906910
<em>Flows</em> représentent des scénarios que le client effectue afin d&#8217;obtenir l&#8217;accès à un token d&#8217;authentification.

designs/soa/plugins/org.obeonetwork.dsl.soa.doc/doc/ISD - SOA Designer.textile

Lines changed: 10 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
__Copyright (c) 2008, 2022 Obeo - All rights reserved. This program and the accompanying materials are made available under the terms of the Eclipse Public License v1.0__
22

33
@Authors@ Stéphane Thibaudeau, Vincent Richard
4-
@Contacts@ stephane.thibaudeau@obeo.fr, vincent.richard@obeo.fr
4+
@Contacts@ vincent.richard@obeo.fr
55

66
h1. ISD - SOA Designer
77

@@ -396,31 +396,32 @@ Les schemas de sécurité sont définis sur l'onglet _Security Schemes_ de la vu
396396

397397
Cette vue permet de créer (!pics/etool16/add.gif!), supprimer (!pics/etool16/delete.gif!) et réordonner (!pics/etool16/up.gif!, !pics/etool16/down.gif!) les _Security Schemes_ du _Component_.
398398

399-
La création d'un _Security Scheme_ déclenche l'affichage d'une boîte de dialogue permettant de le spécifier.
400-
Les données disponibles dans la boite du dialogue sont adaptées au type de _Security Scheme_:
399+
La création d'un _Security Scheme_ déclenche l'affichage d'une boîte de dialogue permettant de spécifier son type, son nom et sa description :
400+
!pics/securityschemes/Dialog_SecurityScheme_Creation.png!
401+
402+
Un double clic sur un _Security Scheme_ déclenche l'affichge d'un dialogue d'édition permettant de spécifier les données spécifiques au type de _Security Scheme_.
401403

402404
- *Api Key:*
403-
!pics/securityschemes/Dialog_SecurityScheme_ApiKey.PNG!
405+
!pics/securityschemes/Dialog_SecurityScheme_Edition_ApiKey.png!
404406
Un _Security Scheme_ de type Api key permet la définition d'une clé, ainsi que la spécification de sa localisation: dans le header, la requête, ou le cookie.
405407

406408
- *HTTP:*
407-
!pics/securityschemes/Dialog_SecurityScheme_HTTP.PNG!
409+
!pics/securityschemes/Dialog_SecurityScheme_Edition_HTTP.png!
408410
Un _Security Scheme_ de type HTTP défini un schéma d'authentification de type Basic, ou Bearer.
409411
Dans le cas d'un schéma d'authentification de type Basic, le server attendra un mot de passe de type username:password, encodé en base-64.
410412
Dans le cas d'un schéma d'authentification de type Bearer, le bearer-format définit la manière dont le token est stocké.
411413

412414
- *OAuth2:*
413-
!pics/securityschemes/Dialog_SecurityScheme_OAuth2.PNG!
415+
!pics/securityschemes/Dialog_SecurityScheme_Edition_OAuth2.png!
414416

415417
- *Open ID:*
416-
!pics/securityschemes/Dialog_SecurityScheme_OpenID.PNG!
418+
!pics/securityschemes/Dialog_SecurityScheme_Edition_OpenID.png!
417419

418420
Les _Security Scheme_ de type OAuth2 et Open ID requièrent la spécification de _Flows_, ainsi que leurs _Scopes_ respectifs:
419-
!pics/securityschemes/Dialog_Flow.PNG!
421+
!pics/securityschemes/Dialog_Flow_Edition.png!
420422

421423
Les _Flows_ représentent des scénarios que le client effectue afin d'obtenir l'accès à un token d'authentification.
422424
Chaque flow propose des _Scopes_. Ces scopes définissent un droit d'accès (restreint) a une fonctionnalité prodiguée par le serveur.
423-
424425

425426
L'édition des valeurs saisies est modifiable par la suite en double-cliquant sur un _SecurityScheme_ dans cette même vue de propriétés, ou bien dans la vue de propriétés d'un _SecurityScheme_ lorsque celui-ci est séléctionné dans la vue _Model Explorer_ :
426427

Binary file not shown.
29.8 KB
Loading
29 KB
Loading
37 KB
Loading
34.8 KB
Loading
36.1 KB
Loading

0 commit comments

Comments
 (0)