Skip to content

Commit 1c92eca

Browse files
committed
Minor fixes to the spec file
Signed-off-by: Charles d'Avernas <[email protected]>
1 parent 1f571cb commit 1c92eca

File tree

1 file changed

+6
-3
lines changed

1 file changed

+6
-3
lines changed

specification.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -3272,8 +3272,11 @@ defined via the `parameters` property in [function definitions](#FunctionRef-Def
32723272
| resource | References an auth definition to be used to access the resource defined in the operation parameter | string | yes |
32733273
| invocation | References an auth definition to be used to invoke the operation | string | no |
32743274

3275-
The `authRef` property references a name of a defined workflow [auth definition](#Auth-Definition).
3276-
It can be a string, in which case the referenced [auth definition](#Auth-Definition) is used solely for the function's invocation, or an object, in which case it is possible to specify an [auth definition](#Auth-Definition) to use for the function's resource retrieval (as defined by the `operation` property) and another for its invocation.
3275+
The `authRef` property references a name of a defined workflow [auth definition](#Auth-Definition). It can be a string or an object.
3276+
3277+
If it's a string, the referenced [auth definition](#Auth-Definition) is used solely for the function's invocation.
3278+
3279+
If it's an object, it is possible to specify an [auth definition](#Auth-Definition) to use for the function's resource retrieval (as defined by the `operation` property) and another for its invocation.
32773280

32783281
Example of a function definition configured to use an [auth definition](#Auth-Definition) called "My Basic Auth" upon invocation:
32793282

@@ -3295,7 +3298,7 @@ functions:
32953298
invocation: My OIDC Auth
32963299
```
32973300

3298-
Note that if multiple functions share the same `operation` value, and if one of them defines an [auth definition](#Auth-Definition) for resource access, then it should always be used to access said resource.
3301+
Note that if multiple functions share the same `operation` path (*which is the first component of the operation value, located before the first '#' character*), and if one of them defines an [auth definition](#Auth-Definition) for resource access, then it should always be used to access said resource.
32993302
In other words, when retrieving the resource of the function "MySecuredFunction2" defined in the following example, the "My Api Key Auth" [auth definition](#Auth-Definition) should be used, because the "MySecuredFunction1" has defined it for resource access.
33003303
This is done to avoid unnecessary repetitions of [auth definition](#Auth-Definition) configuration when using the same resource for multiple defined functions.
33013304

0 commit comments

Comments
 (0)