add sortOperationsAlphabetically config, html show error
Nobody has claimed this yet.
- Dominant language
- TypeScript
- Stars
- 25.9k
- Forks
- 2.4k
- Avg merge
- 13h 10m
- Merged PRs (30d)
- 4
Description
sorry first, my english is not good
Describe the bug
i add sortOperationsAlphabetically is true in redocly.yaml then build html file.
but summary field and description field show order error.
use this code can reappear
Expected behavior
show content same as yaml file
Minimal reproducible OpenAPI snippet(if possible)
test.yaml file content:
info:
title: Api
version: "0.1"
paths:
/internal/clear_cache:
post:
description: 清空缓存
operationId: 清空缓存
responses:
"200":
$ref: '#/responses/NoDataResponseSwagger'
summary: 清空缓存
tags:
- internal
/internal/unbind_account_all:
post:
description: 将账号下的所有绑定关系解绑
operationId: UnbindAccountAllReqSwagger
responses:
"400":
$ref: '#/responses/NoDataResponseSwagger'
summary: 解绑账号所有隐私号
tags:
- internal
responses:
NoDataResponseSwagger:
description: ""
schema:
type: object
schemes:
- https
swagger: "2.0"
redocly.yaml file content:
extends:
- recommended
apis:
test:
root: test.yaml
theme:
openapi:
hideDownloadButton: true
schemaExpansionLevel: 3
sortPropsAlphabetically: true
sortTagsAlphabetically: true
sortOperationsAlphabetically: true
run command:
docker run --rm -v `pwd`:/app -w /app redocly/cli build-docs -o test.html --disableGoogleFont=true test
Screenshots
this file has 2 problem:
- show message is error
- show response code is error
I delete sortOperationsAlphabetically field in redocly.yaml, success
excuse my bad english, thinks.
Additional context
none
Contributor guide
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Start with the provided test.yaml and redocly.yaml files, then run the documented Docker build-docs command with sortOperationsAlphabetically enabled. Compare the generated test.html with the YAML ordering, focusing on the summary, description, and response code. Done means the displayed content and response code match the source YAML.
Written by the indexing model from the issue text.
Assessment
- Tech stack
- typescript
- Domain
- documentation, frontend
- Issue type
- Bug
- Difficulty
- 3/5
- Estimated time
- 1-2 days
- Activity status
- Stale
- Clarity
- Mostly clear
- Newbie friendliness
- 45/100