Merged
Conversation
All annotations should start their comment line.
This fixes incorrect detection of annotation-like text buried in a sentence,
which may capture an unintended argument.
Tolerance: we allow leading blank space or other "noise" that would come
in YAML blocks or markdown comments (e.g. "|", "*", "-").
Exception: the "swagger:route" annotation is an exception and may come
after the convention godoc identifier identifier, as in:
```
// MyRoutes swagger:route {args}
```
This exception is left for backward-compatibility as it is already
present in some published examples of code, but should not be considered
the rule.
Signed-off-by: Frederic BIDON <fredbi@yahoo.com>
…tatement. In this case, the generated extension reuses the same shared doc string. Signed-off-by: Frederic BIDON <fredbi@yahoo.com>
This addresses the case when an aliased text marshaler (e.g. alias to time.Time) is not properly identified as such. Now when alias-as-ref is enabled, the type properly resolves with a $ref to its underlying type definition. Signed-off-by: Frederic BIDON <fredbi@yahoo.com>
Fixes type information loss inside an allOf (text marshaler type was not properly detected). Signed-off-by: Frederic BIDON <fredbi@yahoo.com>
…scriptions The field description was adding "in:" in parameters or headers, since "in:" is not recognized as a full-fledged annotation. Signed-off-by: Frederic BIDON <fredbi@yahoo.com>
…ching identifier. This prevents the generation of descriptions that stutter. Signed-off-by: Frederic BIDON <fredbi@yahoo.com>
…ified (camel-cased) Signed-off-by: Frederic BIDON <fredbi@yahoo.com>
Specifically for structs marked as strfmt (e.g. time.Time, UUID...), the referenced structs types resurface in the produced spec as orphan types (no $ref points to them). NOTE: if the type is annotated as a model, the struct surfaces back anyway (captures user intent). Signed-off-by: Frederic BIDON <fredbi@yahoo.com>
Codecov Report❌ Patch coverage is
Additional details and impacted files@@ Coverage Diff @@
## master #18 +/- ##
==========================================
- Coverage 87.19% 87.08% -0.11%
==========================================
Files 43 43
Lines 3958 3996 +38
==========================================
+ Hits 3451 3480 +29
- Misses 314 319 +5
- Partials 193 197 +4 ☔ View full report in Codecov by Sentry. |
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
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.
Change type
Please select: 🆕 New feature or enhancement|🔧 Bug fix'|📃 Documentation update
Short description
Fixes
Full description
Checklist