Remove available scopes list from OAuth2 endpoints (#4022)

This commit is contained in:
Nolann B.
2026-02-18 21:20:58 +01:00
committed by GitHub
parent 83bd0d74cd
commit f517035e38
12 changed files with 17 additions and 21 deletions
+5
View File
@@ -0,0 +1,5 @@
---
"@gitbook/react-openapi": patch
---
Remove available scopes list from OAuth2 endpoints when no scopes are required
@@ -63,17 +63,13 @@ export function OpenAPIRequiredScopes(props: {
export function OpenAPISchemaScopes(props: { export function OpenAPISchemaScopes(props: {
scopes: OpenAPISecurityScope[]; scopes: OpenAPISecurityScope[];
context: OpenAPIClientContext; context: OpenAPIClientContext;
isOAuth2?: boolean;
}) { }) {
const { scopes, context, isOAuth2 } = props; const { scopes, context } = props;
return ( return (
<div className="openapi-securities-scopes openapi-markdown"> <div className="openapi-securities-scopes openapi-markdown">
<div className="openapi-required-scopes-description"> <div className="openapi-required-scopes-description">
{t( {t(context.translation, 'required_scopes_description')}
context.translation,
isOAuth2 ? 'available_scopes' : 'required_scopes_description'
)}
</div> </div>
<ul> <ul>
{scopes.map((scope) => ( {scopes.map((scope) => (
@@ -3,7 +3,7 @@ import { Fragment } from 'react';
import { InteractiveSection } from './InteractiveSection'; import { InteractiveSection } from './InteractiveSection';
import { Markdown } from './Markdown'; import { Markdown } from './Markdown';
import { OpenAPICopyButton } from './OpenAPICopyButton'; import { OpenAPICopyButton } from './OpenAPICopyButton';
import { OpenAPIRequiredScopes, OpenAPISchemaScopes } from './OpenAPIRequiredScopes'; import { OpenAPIRequiredScopes } from './OpenAPIRequiredScopes';
import { OpenAPISchemaName } from './OpenAPISchemaName'; import { OpenAPISchemaName } from './OpenAPISchemaName';
import type { OpenAPIClientContext } from './context'; import type { OpenAPIClientContext } from './context';
import { t } from './translate'; import { t } from './translate';
@@ -176,8 +176,6 @@ function OpenAPISchemaOAuth2Item(props: {
return null; return null;
} }
const scopes = !security.scopes?.length && flow.scopes ? Object.entries(flow.scopes) : [];
const description = resolveDescription(security); const description = resolveDescription(security);
return ( return (
@@ -231,9 +229,6 @@ function OpenAPISchemaOAuth2Item(props: {
</OpenAPICopyButton> </OpenAPICopyButton>
</span> </span>
) : null} ) : null}
{scopes.length ? (
<OpenAPISchemaScopes scopes={scopes} context={context} isOAuth2 />
) : null}
</div> </div>
</div> </div>
); );
@@ -38,7 +38,7 @@ export const de = {
available_items: 'Verfügbare Elemente', available_items: 'Verfügbare Elemente',
required_scopes: 'Erforderliche Scopes', required_scopes: 'Erforderliche Scopes',
required_scopes_description: 'Dieser Endpunkt erfordert die folgenden Scopes:', required_scopes_description: 'Dieser Endpunkt erfordert die folgenden Scopes:',
available_scopes: 'Verfügbare Scopes:',
properties: 'Eigenschaften', properties: 'Eigenschaften',
or: 'oder', or: 'oder',
and: 'und', and: 'und',
@@ -38,7 +38,7 @@ export const en = {
available_items: 'Available items', available_items: 'Available items',
required_scopes: 'Required scopes', required_scopes: 'Required scopes',
required_scopes_description: 'This endpoint requires the following scopes:', required_scopes_description: 'This endpoint requires the following scopes:',
available_scopes: 'Available scopes:',
possible_values: 'Possible values', possible_values: 'Possible values',
properties: 'Properties', properties: 'Properties',
or: 'or', or: 'or',
@@ -38,7 +38,7 @@ export const es = {
available_items: 'Elementos disponibles', available_items: 'Elementos disponibles',
required_scopes: 'Scopes requeridos', required_scopes: 'Scopes requeridos',
required_scopes_description: 'Este endpoint requiere los siguientes scopes:', required_scopes_description: 'Este endpoint requiere los siguientes scopes:',
available_scopes: 'Scopes disponibles:',
properties: 'Propiedades', properties: 'Propiedades',
or: 'o', or: 'o',
and: 'y', and: 'y',
@@ -38,7 +38,7 @@ export const fr = {
available_items: 'Éléments disponibles', available_items: 'Éléments disponibles',
required_scopes: 'Scopes requis', required_scopes: 'Scopes requis',
required_scopes_description: 'Cet endpoint nécessite les scopes suivants:', required_scopes_description: 'Cet endpoint nécessite les scopes suivants:',
available_scopes: 'Scopes disponibles:',
properties: 'Propriétés', properties: 'Propriétés',
or: 'ou', or: 'ou',
and: 'et', and: 'et',
@@ -38,7 +38,7 @@ export const ja = {
available_items: '利用可能なアイテム', available_items: '利用可能なアイテム',
required_scopes: '必須スコープ', required_scopes: '必須スコープ',
required_scopes_description: 'このエンドポイントには次のスコープが必要です:', required_scopes_description: 'このエンドポイントには次のスコープが必要です:',
available_scopes: '利用可能なスコープ:',
properties: 'プロパティ', properties: 'プロパティ',
or: 'または', or: 'または',
and: 'かつ', and: 'かつ',
@@ -38,7 +38,7 @@ export const nl = {
available_items: 'Beschikbare items', available_items: 'Beschikbare items',
required_scopes: 'Vereiste scopes', required_scopes: 'Vereiste scopes',
required_scopes_description: 'Dit endpoint vereist de volgende scopes:', required_scopes_description: 'Dit endpoint vereist de volgende scopes:',
available_scopes: 'Beschikbare scopes:',
properties: 'Eigenschappen', properties: 'Eigenschappen',
or: 'of', or: 'of',
and: 'en', and: 'en',
@@ -38,7 +38,7 @@ export const no = {
available_items: 'Tilgjengelige elementer', available_items: 'Tilgjengelige elementer',
required_scopes: 'Påkrevde scopes', required_scopes: 'Påkrevde scopes',
required_scopes_description: 'Dette endepunktet krever følgende scopes:', required_scopes_description: 'Dette endepunktet krever følgende scopes:',
available_scopes: 'Tilgjengelige scopes:',
properties: 'Egenskaper', properties: 'Egenskaper',
or: 'eller', or: 'eller',
and: 'og', and: 'og',
@@ -38,7 +38,7 @@ export const pt_br = {
available_items: 'Itens disponíveis', available_items: 'Itens disponíveis',
required_scopes: 'Scopes obrigatórios', required_scopes: 'Scopes obrigatórios',
required_scopes_description: 'Este endpoint requer os seguintes scopes:', required_scopes_description: 'Este endpoint requer os seguintes scopes:',
available_scopes: 'Scopes disponíveis:',
properties: 'Propriedades', properties: 'Propriedades',
or: 'ou', or: 'ou',
and: 'e', and: 'e',
@@ -38,7 +38,7 @@ export const zh = {
available_items: '可用项', available_items: '可用项',
required_scopes: '必需范围', required_scopes: '必需范围',
required_scopes_description: '此端点需要以下范围:', required_scopes_description: '此端点需要以下范围:',
available_scopes: '可用范围:',
properties: '属性', properties: '属性',
or: '或', or: '或',
and: '和', and: '和',