@stoplight/elements-core 8.3.1 → 8.3.2

package/index.esm.js

@@ -2546,42 +2546,43 @@ const oauthFlowNames = {
 function getDefaultDescription(scheme) {
     switch (scheme.type) {
         case 'apiKey':
-            return getApiKeyDescription(scheme.in, scheme.name);
+            return getApiKeyDescription(scheme);
         case 'http':
             switch (scheme.scheme) {
                 case 'basic':
-                    return getBasicAuthDescription();
+                    return getBasicAuthDescription(scheme);
                 case 'bearer':
-                    return getBearerAuthDescription();
+                    return getBearerAuthDescription(scheme);
                 case 'digest':
-                    return getDigestAuthDescription();
+                    return getDigestAuthDescription(scheme);
             }
         case 'oauth2':
             return getOAuthDescription(scheme);
     }
     return '';
 }
-function getApiKeyDescription(inProperty, name) {
+function getApiKeyDescription(scheme) {
+    const { in: inProperty, name } = scheme;
     return `An API key is a token that you provide when making API calls. Include the token in a ${inProperty} parameter called \`${name}\`.
 
-  Example: ${inProperty === 'query' ? `\`?${name}=123\`` : `\`${name}: 123\``}`;
+  Example: ${inProperty === 'query' ? `\`?${name}=123\`` : `\`${name}: 123\``}${getSecuritySchemeRoles(scheme)}`;
 }
-function getBasicAuthDescription() {
+function getBasicAuthDescription(schema) {
     return `Basic authentication is a simple authentication scheme built into the HTTP protocol.
   To use it, send your HTTP requests with an Authorization header that contains the word Basic
   followed by a space and a base64-encoded string \`username:password\`.
 
-  Example: \`Authorization: Basic ZGVtbzpwQDU1dzByZA==\``;
+  Example: \`Authorization: Basic ZGVtbzpwQDU1dzByZA==\`${getSecuritySchemeRoles(schema)}`;
 }
-function getBearerAuthDescription() {
+function getBearerAuthDescription(schema) {
     return `Provide your bearer token in the Authorization header when making requests to protected resources.
 
-  Example: \`Authorization: Bearer 123\``;
+  Example: \`Authorization: Bearer 123\`${getSecuritySchemeRoles(schema)}`;
 }
-function getDigestAuthDescription() {
+function getDigestAuthDescription(schema) {
     return `Provide your encrypted digest scheme data in the Authorization header when making requests to protected resources.
 
-  Example: \`Authorization: Digest username=guest, realm="test", nonce="2", uri="/uri", response="123"\``;
+  Example: \`Authorization: Digest username=guest, realm="test", nonce="2", uri="/uri", response="123"\`${getSecuritySchemeRoles(schema)}`;
 }
 function getOAuthDescription(scheme) {
     const flows = keys(scheme.flows);
@@ -2604,6 +2605,11 @@ function getOAuthFlowDescription(title, flow) {
 ${scopes.map(([key, value]) => `- \`${key}\` - ${value}`).join('\n')}`;
     }
     return description;
+}
+function getSecuritySchemeRoles(scheme) {
+    var _a;
+    const scopes = (_a = scheme.extensions) === null || _a === void 0 ? void 0 : _a['x-scopes'];
+    return Array.isArray(scopes) ? `\n\nRoles: ${scopes.map(scope => `\`${scope}\``).join(', ')}` : '';
 }
 
 const PanelContent = ({ schemes }) => {

package/index.js

@@ -2607,42 +2607,43 @@ const oauthFlowNames = {
 function getDefaultDescription(scheme) {
     switch (scheme.type) {
         case 'apiKey':
-            return getApiKeyDescription(scheme.in, scheme.name);
+            return getApiKeyDescription(scheme);
         case 'http':
             switch (scheme.scheme) {
                 case 'basic':
-                    return getBasicAuthDescription();
+                    return getBasicAuthDescription(scheme);
                 case 'bearer':
-                    return getBearerAuthDescription();
+                    return getBearerAuthDescription(scheme);
                 case 'digest':
-                    return getDigestAuthDescription();
+                    return getDigestAuthDescription(scheme);
             }
         case 'oauth2':
             return getOAuthDescription(scheme);
     }
     return '';
 }
-function getApiKeyDescription(inProperty, name) {
+function getApiKeyDescription(scheme) {
+    const { in: inProperty, name } = scheme;
     return `An API key is a token that you provide when making API calls. Include the token in a ${inProperty} parameter called \`${name}\`.
 
-  Example: ${inProperty === 'query' ? `\`?${name}=123\`` : `\`${name}: 123\``}`;
+  Example: ${inProperty === 'query' ? `\`?${name}=123\`` : `\`${name}: 123\``}${getSecuritySchemeRoles(scheme)}`;
 }
-function getBasicAuthDescription() {
+function getBasicAuthDescription(schema) {
     return `Basic authentication is a simple authentication scheme built into the HTTP protocol.
   To use it, send your HTTP requests with an Authorization header that contains the word Basic
   followed by a space and a base64-encoded string \`username:password\`.
 
-  Example: \`Authorization: Basic ZGVtbzpwQDU1dzByZA==\``;
+  Example: \`Authorization: Basic ZGVtbzpwQDU1dzByZA==\`${getSecuritySchemeRoles(schema)}`;
 }
-function getBearerAuthDescription() {
+function getBearerAuthDescription(schema) {
     return `Provide your bearer token in the Authorization header when making requests to protected resources.
 
-  Example: \`Authorization: Bearer 123\``;
+  Example: \`Authorization: Bearer 123\`${getSecuritySchemeRoles(schema)}`;
 }
-function getDigestAuthDescription() {
+function getDigestAuthDescription(schema) {
     return `Provide your encrypted digest scheme data in the Authorization header when making requests to protected resources.
 
-  Example: \`Authorization: Digest username=guest, realm="test", nonce="2", uri="/uri", response="123"\``;
+  Example: \`Authorization: Digest username=guest, realm="test", nonce="2", uri="/uri", response="123"\`${getSecuritySchemeRoles(schema)}`;
 }
 function getOAuthDescription(scheme) {
     const flows = keys__default["default"](scheme.flows);
@@ -2665,6 +2666,11 @@ function getOAuthFlowDescription(title, flow) {
 ${scopes.map(([key, value]) => `- \`${key}\` - ${value}`).join('\n')}`;
     }
     return description;
+}
+function getSecuritySchemeRoles(scheme) {
+    var _a;
+    const scopes = (_a = scheme.extensions) === null || _a === void 0 ? void 0 : _a['x-scopes'];
+    return Array.isArray(scopes) ? `\n\nRoles: ${scopes.map(scope => `\`${scope}\``).join(', ')}` : '';
 }
 
 const PanelContent = ({ schemes }) => {

package/index.mjs

@@ -2546,42 +2546,43 @@ const oauthFlowNames = {
 function getDefaultDescription(scheme) {
     switch (scheme.type) {
         case 'apiKey':
-            return getApiKeyDescription(scheme.in, scheme.name);
+            return getApiKeyDescription(scheme);
         case 'http':
             switch (scheme.scheme) {
                 case 'basic':
-                    return getBasicAuthDescription();
+                    return getBasicAuthDescription(scheme);
                 case 'bearer':
-                    return getBearerAuthDescription();
+                    return getBearerAuthDescription(scheme);
                 case 'digest':
-                    return getDigestAuthDescription();
+                    return getDigestAuthDescription(scheme);
             }
         case 'oauth2':
             return getOAuthDescription(scheme);
     }
     return '';
 }
-function getApiKeyDescription(inProperty, name) {
+function getApiKeyDescription(scheme) {
+    const { in: inProperty, name } = scheme;
     return `An API key is a token that you provide when making API calls. Include the token in a ${inProperty} parameter called \`${name}\`.
 
-  Example: ${inProperty === 'query' ? `\`?${name}=123\`` : `\`${name}: 123\``}`;
+  Example: ${inProperty === 'query' ? `\`?${name}=123\`` : `\`${name}: 123\``}${getSecuritySchemeRoles(scheme)}`;
 }
-function getBasicAuthDescription() {
+function getBasicAuthDescription(schema) {
     return `Basic authentication is a simple authentication scheme built into the HTTP protocol.
   To use it, send your HTTP requests with an Authorization header that contains the word Basic
   followed by a space and a base64-encoded string \`username:password\`.
 
-  Example: \`Authorization: Basic ZGVtbzpwQDU1dzByZA==\``;
+  Example: \`Authorization: Basic ZGVtbzpwQDU1dzByZA==\`${getSecuritySchemeRoles(schema)}`;
 }
-function getBearerAuthDescription() {
+function getBearerAuthDescription(schema) {
     return `Provide your bearer token in the Authorization header when making requests to protected resources.
 
-  Example: \`Authorization: Bearer 123\``;
+  Example: \`Authorization: Bearer 123\`${getSecuritySchemeRoles(schema)}`;
 }
-function getDigestAuthDescription() {
+function getDigestAuthDescription(schema) {
     return `Provide your encrypted digest scheme data in the Authorization header when making requests to protected resources.
 
-  Example: \`Authorization: Digest username=guest, realm="test", nonce="2", uri="/uri", response="123"\``;
+  Example: \`Authorization: Digest username=guest, realm="test", nonce="2", uri="/uri", response="123"\`${getSecuritySchemeRoles(schema)}`;
 }
 function getOAuthDescription(scheme) {
     const flows = keys(scheme.flows);
@@ -2604,6 +2605,11 @@ function getOAuthFlowDescription(title, flow) {
 ${scopes.map(([key, value]) => `- \`${key}\` - ${value}`).join('\n')}`;
     }
     return description;
+}
+function getSecuritySchemeRoles(scheme) {
+    var _a;
+    const scopes = (_a = scheme.extensions) === null || _a === void 0 ? void 0 : _a['x-scopes'];
+    return Array.isArray(scopes) ? `\n\nRoles: ${scopes.map(scope => `\`${scope}\``).join(', ')}` : '';
 }
 
 const PanelContent = ({ schemes }) => {

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@stoplight/elements-core",
-  "version": "8.3.1",
+  "version": "8.3.2",
   "main": "./index.js",
   "sideEffects": [
     "web-components.min.js",
@@ -24,7 +24,7 @@
     "react-dom": ">=16.8"
   },
   "dependencies": {
-    "@stoplight/http-spec": "^7.0.3",
+    "@stoplight/http-spec": "^7.1.0",
     "@stoplight/json": "^3.21.0",
     "@stoplight/json-schema-ref-parser": "^9.2.7",
     "@stoplight/json-schema-sampler": "0.3.0",