swagger-ui icon indicating copy to clipboard operation
swagger-ui copied to clipboard

doc(usage.configuration.tagsSorter): fix wrong declaration

Open dancer1325 opened this issue 1 year ago • 1 comments

Description

  • Fix wrong definition of tagsSorter for alpha

Motivation and Context

  • Why is this change required? What problem does it solve?
    • value wrongly defined

How Has This Been Tested?

  • Extend the sample 'webpack-getting-started' -- Check theProjectInMyForkedBranch --
    • my set up: NodeJs v20.11.0, NPM 10.4.0
    • OpenAPI sample extended -- https://github.com/dancer1325/swagger-ui/blob/master/docs/samples/webpack-getting-started/src/swagger-config.yaml --
    • tagsSorter:"alpha" -- https://github.com/dancer1325/swagger-ui/blob/master/docs/samples/webpack-getting-started/src/index.js#L20 --
  • isolated changes -> just affected this sample project

Screenshots (if appropriate):

image

Checklist

My PR contains...

  • [x] No code changes (src/ is unmodified: changes to documentation, CI, metadata, etc.)
  • [ ] Dependency changes (any modification to dependencies in package.json)
  • [ ] Bug fixes (non-breaking change which fixes an issue)
  • [ ] Improvements (misc. changes to existing features)
  • [ ] Features (non-breaking change which adds functionality)

My changes...

  • [ ] are breaking changes to a public API (config options, System API, major UI change, etc).
  • [ ] are breaking changes to a private API (Redux, component props, utility functions, etc.).
  • [ ] are breaking changes to a developer API (npm script behavior changes, new dev system dependencies, etc).
  • [x] are not breaking changes.

Documentation

  • [] My changes do not require a change to the project documentation.
  • [x] My changes require a change to the project documentation.
  • [ ] If yes to above: I have updated the documentation accordingly.

Automated tests

  • [x] My changes can not or do not need to be tested.
  • [ ] My changes can and should be tested by unit and/or integration tests.
  • [ ] If yes to above: I have added tests to cover my changes.
  • [ ] If yes to above: I have taken care to cover edge cases in my tests.
  • [ ] All new and existing tests passed.

dancer1325 avatar Jul 09 '24 06:07 dancer1325

maybe @char0n ?

dancer1325 avatar Jul 09 '24 18:07 dancer1325