Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Webapi-Swagger : Handle special Path Param case (Github paths) #38

Open
kahlil29 opened this issue Apr 5, 2019 · 0 comments
Open

Webapi-Swagger : Handle special Path Param case (Github paths) #38

kahlil29 opened this issue Apr 5, 2019 · 0 comments
Assignees
Labels
Dependent Dependent on some other ticket/package/fix before it can be merged/fixed Needs Discussion This ticket needs discussion (some solution needs to be discussed in order to proceed and implement) Webapi-Swagger All issues related to Webapi-swagger (generation of Webapi contracts from Swagger Docs)

Comments

@kahlil29
Copy link
Contributor

kahlil29 commented Apr 5, 2019

In the GitHub Swagger File, we encountered a Path with the following format :

'/repos/{owner}/{repo}/compare/{baseId}...{headId}':

This is quite a special case and the code is currently not configured to handle a case like this.
A potential solution to this issue would be to have a type

data HPathParam = HPathParam
  {
    baseId :: Text
  , headId :: Text
  } -- and maybe another field for the text in between the two params

And in the ToParam instance we would need to combine these 3 things into a single Path param.

Also, we need to see how Webapi would handle this in the Contract.
The fix for this ticket would probably only make sense once this is handled in Webapi.

@kahlil29 kahlil29 added Webapi-Swagger All issues related to Webapi-swagger (generation of Webapi contracts from Swagger Docs) Needs Discussion This ticket needs discussion (some solution needs to be discussed in order to proceed and implement) Dependent Dependent on some other ticket/package/fix before it can be merged/fixed labels Apr 5, 2019
@kahlil29 kahlil29 self-assigned this Apr 5, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
Dependent Dependent on some other ticket/package/fix before it can be merged/fixed Needs Discussion This ticket needs discussion (some solution needs to be discussed in order to proceed and implement) Webapi-Swagger All issues related to Webapi-swagger (generation of Webapi contracts from Swagger Docs)
Projects
None yet
Development

No branches or pull requests

1 participant