Skip to content

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

Open
@kahlil29

Description

@kahlil29

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.

Metadata

Metadata

Assignees

Labels

DependentDependent on some other ticket/package/fix before it can be merged/fixedNeeds DiscussionThis ticket needs discussion (some solution needs to be discussed in order to proceed and implement)Webapi-SwaggerAll issues related to Webapi-swagger (generation of Webapi contracts from Swagger Docs)

Type

No type

Projects

No projects

Milestone

No milestone

Relationships

None yet

Development

No branches or pull requests

Issue actions