Fix some Endpoint::doc field usages && Rename it to documentation to avoid this kind of mistake in the future
#3044
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
… to avoid this kind of mistake in the future
guizmaii
commented
Aug 22, 2024
| @@ -575,7 +575,7 @@ final case class Endpoint[PathInput, Input, Err, Output, Auth <: AuthType]( | |||
| output = ((HttpCodec.content[Output2] ++ StatusCodec.status(status)) ?? doc) | self.output, | |||
| error, | |||
| codecError, | |||
| Doc.empty, | |||
There was a problem hiding this comment.
I don't understand why using myEndpoint.out[...](status = ..., doc = ...) would reset the doc to an empty one. Probably a typo
guizmaii
commented
Aug 22, 2024
| @@ -593,7 +593,7 @@ final case class Endpoint[PathInput, Input, Err, Output, Auth <: AuthType]( | |||
| output = (HttpCodec.content[Output2](mediaType) ++ StatusCodec.Ok ?? doc) | self.output, | |||
| error, | |||
| codecError, | |||
| doc, | |||
There was a problem hiding this comment.
This was not using the correct doc. It was using the one passed in parameter and not the one from this
guizmaii
commented
Aug 22, 2024
| @@ -612,7 +612,7 @@ final case class Endpoint[PathInput, Input, Err, Output, Auth <: AuthType]( | |||
| output = ((HttpCodec.content[Output2](mediaType) ++ StatusCodec.status(status)) ?? doc) | self.output, | |||
| error, | |||
| codecError, | |||
| doc, | |||
There was a problem hiding this comment.
This was not using the correct doc. It was using the one passed in parameter and not the one from this
guizmaii
commented
Aug 22, 2024
| @@ -451,7 +451,7 @@ object OpenAPI { | |||
|
|
|||
| // todo maybe not the best regex, but the old one was not working at all | |||
| // safe chars from RFC1738 "$" | "-" | "_" | "." | "+" | |||
| val validPath: Regex = """\/[\/a-zA-Z0-9\-_{}$.+]*""".r | |||
| private val validPath: Regex = """\/[\/a-zA-Z0-9\-_{}$.+]*""".r | |||
There was a problem hiding this comment.
Not related to the main subject of this PR but I've seen that this implementation detail was public. I think we can make it private
987Nabil
approved these changes
Aug 22, 2024
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.