add Security Requirements

asyncapi · Aug 29, 2022 · 5897a1e · 5897a1e
1 parent 7b9b575
commit 5897a1e
Showing 1 changed file with 14 additions and 4 deletions.
diff --git a/docs/v1.md b/docs/v1.md
@@ -215,7 +215,7 @@
 - extensions() : `Extensions`
 - hasRefreshUrl() : `boolean`
 - refreshUrl() : `string` | `undefined`
-- scopes() : `Object.&lt;string, string&gt;` | `undefined`
+- scopes() : `Map[string, string]` | `undefined`
 - tokenUrl() : `string` | `undefined`
 
 ## OAuthFlows
@@ -251,7 +251,7 @@
 - servers() : `Server[]`
 - summary() : `string` | `undefined`
 - tags() : `Tags`
-- security() : `Array<Record<string, { schema: SecurityScheme, scopes: Array<string> }>>`
+- security() : `SecurityRequirements`
 - isSend(): `boolean`
 - isReceive(): `boolean`
 - action() : `enum{'Send', 'Receive', 'Publish', 'Subscribe'}`
@@ -275,7 +275,7 @@
 - servers() : `Server[]`
 - summary() : `string` | `undefined`
 - tags() : `Tags`
-- security() : `Array<Record<string, { schema: SecurityScheme, scopes: Array<string> }>>`
+- security() : `SecurityRequirements`
 - isSend(): `boolean`
 - isReceive(): `boolean`
 - action() : `enum{'Send', 'Receive', 'Publish', 'Subscribe'}`
@@ -339,6 +339,16 @@
 - has(id: `string`) : `boolean`
 - isEmpty() : `boolean`
 
+## SecurityRequirement
+- scheme: `SecurityScheme`
+- scopes: `string[]`
+
+## SecurityRequirements
+- all() : `SecurityRequirement[]`
+- get(name: `string`) : `SecurityRequirement` | `undefined`
+- has(name: `string`) : `boolean`
+- isEmpty() : `boolean`
+
 ## SecurityScheme
 - id() : `string`
 - bearerFormat() : `string` | `undefined`
@@ -380,7 +390,7 @@
 - operations() : `Operations`
 - protocol() : `string` | `undefined`
 - protocolVersion() : `string` | `undefined`
-- security() : `Array<Record<string, { schema: SecurityScheme, scopes: Array<string> }>>`
+- security() : `SecurityRequirements`
 - url() : `string` | `undefined`
 - variables() : `ServerVariables`