[CAMEL-16606] rest dsl - Allow specifying security requirement(s) applicable to entire API

• Type: Improvement
• Status: Resolved
• Priority: Major
• Resolution: Fixed
• Affects Version/s: 3.9.0
• Fix Version/s: 3.10.0
• Component/s: camel-core, rest
• Estimated Complexity: Novice
• Assignee: Unassigned
• Reporter: Shankar Ramamoorthy
• Created: 12/May/21 07:47
• Updated: 14/May/21 12:54
• Resolved: 14/May/21 04:11

Description

In the Camel REST DSL one can specify security requirements per endpoint. But there isn't a way to specify security requirement(s) applicable to all endpoints. In the OpenAPI 3 schema this corresponds to a security section at the root level. 

Perhaps this can be done by just using the existing

RestDefinition.security(String name [, String scopes])

but allow it to be called without a verb, in which case it would apply to the entire API.

In generated OpenAPI 3 JSON schema this would produce a root level node such as: "security": [ {"api_key": []}] or "security":  [{"oauth2_auth": [ "read", "write" ]}]

Currently if you do, for example, rest().security(scheme), you get an IllegalArgumentException that one "Must add verb first, ..."

Issue Links

• relates to: CAMEL-16609 rest dsl - Add more security models for JWT bearer tokens etc
• links to: GitHub Pull Request #5557