Skip to content

#4537 - Invalid HTML ID for Operations with tags which contain multiple words#4538

Merged
shockey merged 3 commits intoswagger-api:masterfrom
ChristophWalter:bug/4537-invalid-html-id-for-operations
Aug 23, 2018
Merged

#4537 - Invalid HTML ID for Operations with tags which contain multiple words#4538
shockey merged 3 commits intoswagger-api:masterfrom
ChristophWalter:bug/4537-invalid-html-id-for-operations

Conversation

@ChristophWalter
Copy link
Copy Markdown
Contributor

Description

First Take a look at the bugticket #4537
This pull requests adapts the operation component to transform the tag name with help of the util function createDeepLinkPath. This leads to a valid html id of the operation containers.

Motivation and Context

Fixes #4537

How Has This Been Tested?

Manual testing with help of the developer tools. "Before" screenshots are attached to the bug ticket.

Checklist

My PR contains...

  • 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).
  • are not breaking changes.

Documentation

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

Automated tests

  • 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.

@shockey

This comment has been minimized.

Copy link
Copy Markdown
Contributor

@shockey shockey left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Approved with minor changes: using createDeepLinkPath directly on the element ID.

@shockey shockey merged commit b2c4c4e into swagger-api:master Aug 23, 2018
@shockey
Copy link
Copy Markdown
Contributor

shockey commented Aug 23, 2018

tests forthcoming in another branch (waiting on #4827's resolution first).

thanks, @ChristophWalter!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Invalid HTML ID for Operations with tags which contain multiple words

2 participants