Skip to content
This repository was archived by the owner on Aug 18, 2020. It is now read-only.

[CO-322] Fix Swagger names in the spec #3595

Merged
merged 2 commits into from
Sep 14, 2018
Merged

Conversation

parsonsmatt
Copy link
Contributor

@parsonsmatt parsonsmatt commented Sep 13, 2018

Description

The previous swagger spec had names like WalletResponse<[Wallet]> where <[]> are banned characters. This PR replaces them with URI friendly characters -- specifically, the above would now be WalletResponse-_Wallet_.

Linked issue

https://iohk.myjetbrains.com/youtrack/issue/CO-322

Type of change

  • 🐞 Bug fix (non-breaking change which fixes an issue)
  • [~] 🛠 New feature (non-breaking change which adds functionality)
  • [~] ⚠️ Breaking change (fix or feature that would cause existing functionality to change)
  • [~] 🏭 Refactoring that does not change existing functionality but does improve things like code readability, structure etc
  • 🔨 New or improved tests for existing code
  • [~] ⛑ git-flow chore (backport, hotfix, etc)

Developer checklist

  • I have read the style guide document, and my code follows the code style of this project.
  • If my code deals with exceptions, it follows the guidelines.
  • I have updated any documentation accordingly, if needed. Documentation changes can be reflected in opening a PR on cardanodocs.com, amending the inline Haddock comments, any relevant README file or one of the document listed in the docs directory.
  • CHANGELOG entry has been added and is linked to the correct PR on GitHub.

Testing checklist

  • I have added tests to cover my changes.
  • All new and existing tests passed.

QA Steps

Screenshots (if available)

@@ -617,6 +617,7 @@ test-suite wallet-new-specs
, formatting
, hedgehog
, hspec
, insert-ordered-containers
Copy link
Contributor

Choose a reason for hiding this comment

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

We don't need this import right?

Copy link
Contributor

Choose a reason for hiding this comment

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

I always try to use Control.Lens.At instead of bringing in this dep :/ ...

Copy link
Contributor

Choose a reason for hiding this comment

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

Or Control.Lens.Indexed in that case actually

Copy link
Contributor Author

Choose a reason for hiding this comment

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

I needed to get access to the keys of the map and couldn't figure out how to do that with lens :\

@parsonsmatt parsonsmatt force-pushed the matt/CO-322/swagger-names branch from 174bf7c to fbcd439 Compare September 14, 2018 20:12
[CO-322] Changelog entry

[CO-322] pkgs/generate.sh
@parsonsmatt parsonsmatt force-pushed the matt/CO-322/swagger-names branch from fbcd439 to c8a6170 Compare September 14, 2018 20:43
Copy link
Member

@erikd erikd left a comment

Choose a reason for hiding this comment

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

LGTM!

@parsonsmatt parsonsmatt merged commit f9cee93 into develop Sep 14, 2018
@parsonsmatt parsonsmatt deleted the matt/CO-322/swagger-names branch October 24, 2018 02:02
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants