Allow setting example paths and queries for DocService #2546
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
Motivation: Currently, a user cannot set example paths and queries. line#2195 The endpoint path or queries are only set automatically when sharing a URL that contains `endpoint_path` or `queries` as params. Modifications: - Add `examplePaths` to `DocService` and `DocServiceBuilder` - Add `exampleQueries` to `DocService` and `DocServiceBuilder` - Show `examplePath` if the `endpoint_path` is null and the `examplePath` is not null - Show `exampleQuery` if the `queries` is null and the `exampleQuery` is not null - Make `ENDPOINT PATH` input visible with readonlyif path type is exact Result: You can now set an example path and queries for `DocService`
|
/cc @julnamoo |
|
A screenshot of example paths and queries |
anuraaga
approved these changes
Mar 3, 2020
core/src/main/java/com/linecorp/armeria/server/docs/DocService.java
Outdated
Show resolved
Hide resolved
hexoul
reviewed
Mar 4, 2020
minwoox
approved these changes
Mar 4, 2020
Codecov Report
@@ Coverage Diff @@
## master #2546 +/- ##
========================================
Coverage ? 73.6%
Complexity ? 10947
========================================
Files ? 956
Lines ? 41917
Branches ? 5248
========================================
Hits ? 30851
Misses ? 8370
Partials ? 2696
Continue to review full report at Codecov.
|
trustin
reviewed
Mar 5, 2020
core/src/main/java/com/linecorp/armeria/server/docs/DocServiceBuilder.java
Outdated
Show resolved
Hide resolved
core/src/main/java/com/linecorp/armeria/server/docs/DocServiceBuilder.java
Outdated
Show resolved
Hide resolved
Comment on lines
117
to
118
| this.examplePaths = ImmutableList.copyOf(requireNonNull(examplePaths, "examplePaths")); | ||
| this.exampleQueries = ImmutableList.copyOf(requireNonNull(exampleQueries, "exampleQueries")); |
There was a problem hiding this comment.
How about validating all paths and query strings, using PathAndQuery and QueryParams.fromQueryString()?
There was a problem hiding this comment.
This is not addressed yet.
trustin
reviewed
Mar 9, 2020
| /** | ||
| * Adds the specified example query strings for the method with the specified service and method name. | ||
| */ | ||
| public DocServiceBuilder exampleQueries(Class<?> serviceType, String methodName, Iterable<String> queries) { |
core/src/main/java/com/linecorp/armeria/server/docs/DocServiceBuilder.java
Outdated
Show resolved
Hide resolved
core/src/main/java/com/linecorp/armeria/server/docs/DocServiceBuilder.java
Outdated
Show resolved
Hide resolved
core/src/main/java/com/linecorp/armeria/server/docs/DocServiceBuilder.java
Outdated
Show resolved
Hide resolved
core/src/main/java/com/linecorp/armeria/server/docs/DocServiceBuilder.java
Outdated
Show resolved
Hide resolved
core/src/main/java/com/linecorp/armeria/server/docs/DocServiceBuilder.java
Outdated
Show resolved
Hide resolved
Comment on lines
117
to
118
| this.examplePaths = ImmutableList.copyOf(requireNonNull(examplePaths, "examplePaths")); | ||
| this.exampleQueries = ImmutableList.copyOf(requireNonNull(exampleQueries, "exampleQueries")); |
There was a problem hiding this comment.
This is not addressed yet.
trustin
reviewed
Mar 10, 2020
core/src/main/java/com/linecorp/armeria/server/docs/MethodInfo.java
Outdated
Show resolved
Hide resolved
trustin
reviewed
Mar 10, 2020
core/src/main/java/com/linecorp/armeria/server/docs/MethodInfo.java
Outdated
Show resolved
Hide resolved
trustin
approved these changes
Mar 10, 2020
trustin
changed the title
fmguerreiro
pushed a commit
to fmguerreiro/armeria
that referenced
this pull request
Sep 19, 2020
Motivation: Currently, a user cannot set example paths and queries. line#2195 The endpoint path or queries are only set automatically when opening a URL that contains `endpoint_path` or `queries` as params. Modifications: - Add `examplePaths` to `DocService` and `DocServiceBuilder` - Add `exampleQueries` to `DocService` and `DocServiceBuilder` - Show `examplePath` if the `endpoint_path` is null and the `examplePath` is not null - Show `exampleQuery` if the `queries` is null and the `exampleQuery` is not null - Make `ENDPOINT PATH` input visible with read-only if a path is exact type Result: You can now set an example path and queries for `DocService` Fixes line#2195
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.
Motivation:
Currently, a user cannot set example paths and queries. #2195
The endpoint path or queries are only set automatically when
opening a URL that contains
endpoint_pathorqueriesas params.Modifications:
examplePathstoDocServiceandDocServiceBuilderexampleQueriestoDocServiceandDocServiceBuilderexamplePathif theendpoint_pathis null and theexamplePathis not nullexampleQueryif thequeriesis null and theexampleQueryis not nullENDPOINT PATHinput visible with read-only if a path is exact typeResult:
You can now set an example path and queries for
DocServiceFixes #2195