Redocly/redoc
1
1
Fork 0
mirror of https://github.com/Redocly/redoc.git synced 2024-11-25 10:03:45 +03:00
Code Issues Packages Projects Releases Wiki Activity

feat: Add support for displaying operationId in the sidebar (#1927)

Browse Source 
* feat: Add support for displaying id in the sidebar

* fix: previous commit `feat: Add support for displaying id in the sidebar`

Co-authored-by: Oprysk <vyacheslav@redocly.com>
This commit is contained in:
Ryc O'Chet 2022-03-23 10:39:26 +00:00 committed by GitHub
parent ab3e8a8f80
commit 09786f2a5a
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 10 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
README.md
View File

@ -246,6 +246,7 @@ You can use all of the following options with the standalone version of the <red
* `sideNavStyle` - can be specified in various ways:
* **summary-only**: displays a summary in the sidebar navigation item. (**default**)
* **path-only**: displays a path in the sidebar navigation item.
* **id-only**: displays the operation id with a fallback to the path in the sidebar navigation item.
### `<redoc>` theme object
* `spacing`

3
src/services/RedocNormalizedOptions.ts
View File

@ -8,6 +8,7 @@ import { MDXComponentMeta } from './MarkdownRenderer';
export enum SideNavStyleEnum {
SummaryOnly = 'summary-only',
PathOnly = 'path-only',
IdOnly = 'id-only',
}
export interface RedocRawOptions {
@ -170,6 +171,8 @@ export class RedocNormalizedOptions {
return value;
case SideNavStyleEnum.PathOnly:
return SideNavStyleEnum.PathOnly;
case SideNavStyleEnum.IdOnly:
return SideNavStyleEnum.IdOnly;
default:
return defaultValue;
}

7
src/services/models/Operation.ts
View File

@ -106,7 +106,12 @@ export class OperationModel implements IMenuItem {
this.name = getOperationSummary(operationSpec);
this.sidebarLabel = options.sideNavStyle === SideNavStyleEnum.PathOnly ? this.path : this.name;
this.sidebarLabel =
options.sideNavStyle === SideNavStyleEnum.IdOnly
? this.operationId || this.path
: options.sideNavStyle === SideNavStyleEnum.PathOnly
? this.path
: this.name;
if (this.isCallback) {
// NOTE: Callbacks by default should not inherit the specification's global `security` definition.