Changelog

v0.31.0 (2024-05-12)

Full Changelog

Implemented enhancements:

• doc: refurbish doc site #3086
• Diff should detect extension value changes #2984
• Diff does not report on request param extensions #2983
• add support for ULID to swagger:strfmt #2467
• Flatten changes case on definitions #2334
• External $refs and polymorphism: models for subtypes not generated #1885
• Add validation for a 'readOnly' property #936
• API Gateway vendor extensions? #659
• edit but don't overwrite configure_xxx.go #397

Fixed bugs:

• Adding or removing a schema from response is not being recorded in the diff #3074
• generating a command line : undefined: cli #2969
• Adding an optional field to request body shouldn't be a breaking change #2962
• Go-swagger diff runtime error when comparing schema with different response codes #2952
• v0.30.4 panics during flatten #2919
• Swagger Generate Server Generates go Code With Cycles #2866
• JSON Schema in swagger API response #2821
• "swagger diff" does not work with spec that has a recursive definition #2774
• request Content-Type isn't multipart/form-data #2773
• fields named like "+1" cause swagger to fail gnerating a cli #2764
• Flatten stopped processing nested directories in v0.26.0 #2743
• Wrong import path generated for an operation called "client" #2730
• New lines in description create incorrect markdown #2700
• remove-unused does not remove all unused definitions #2657
• "swagger generate cli" generates code that does not compile #2650
• Generated code fails to call the Validate function on embedded structs resulting in incorrect validation #2604
• Validation code for maxProperties is generated incorrectly #2587
• Invalid code generated for parameters of array types with empty array as default value #2533
• panic: assignment to entry in nil map #2527
• Incompatible API with Helm Transitive Dependency #2525
• Generate models failed after separate swagger files, maybe caused by a self-ref property of a definition in the separated swagger file #2346
• "Invalid ref" error when generating server with cross-file reference when "--keep-spec-order" specified #2216
• swagger generate client command fails with invalid token reference #1898
• escaped parameters fail to generate the correct url path when a base path is present. #1083

Closed issues:

• How to disable try it out option for the swagger-ui go-openapi/runtime/middleware #3102
• Broken swagger:response Generation with Go 1.22.0 + 1.21.5 darwin/arm64 #3071
• Install swagger server failed! #3067
• Enum fields are not properly scanned (and documented) #3002
• feat: provide SwaggerUI middleware to serve spec file #2988
• Swagger generates broken code in $GOPATH #2982
• wrong generated swagger.yml file when using flatten #2978
• API client generation without requiring go-openapi modules #2976
• API Client Generation - Strange naming of folder inside of client folder #2974
• CVE-2022-4742 | CVSS Score: 9.8 | Category: CWE-1321 | A vulnerability, which was classified as critical, has been found in json-pointer. Affected by this issue is the function set of the file index.js. The manipulation leads to improperly controlled modification of object prototype attributes ('prototype pollution'). The attack may be launched remotely. The name of the patch is 859c9984b6c407fc2d5a0a7e47c7274daa681941. It is recommended to apply a patch to fix this issue. VDB-216794 is the identifier assigned to this vulnerability. #2971
• Generated server.go has default write timeout value of 60s #2967
• pprof is a tool for visualization and analysis of profiling data #2966
• diff result has no URL, when there is an object type array field in the schema #2964
• bug: incorrect logic and missing imports #2939
• swagger generate markdown doesn't respect both '--output' and '--target' #2938
• Add diff support for extensions #2935
• is support for generic structures？ #2920
• When the response refers to a structure with the same name under a different package, only the structure of the latest structure will be generated #2918
• [Bug] The parameters section can't be generate under go1.20 #2913
• ContextValidate panics if the field is nil for discriminator types #2911
• [Bug?] Swagger Flatten, Not Recognizing Nested Operations #2908
• Object has no field "components", but it has (flattening error) #2903
• Swagger docs validate failed when enums_as_ints=true #2890
• Generation error against something that used to work ok (2 years ago :-) ) #2887
• Docs not updated for 0.30.4 #2883
• UUID regex more liberal than spec #2878
• swagger flatten randomizes order in yaml output #2850
• Custom server tutorials raise an error while swagger generates files #2833
• Upload of large files permanently leaves files in TEMPDIR #2789
• How to modify CSS / Color using Swagger V2? #2788
• the context passed to ContextValidate is not the request context #2748
• minimum misspelled #2740
• Documentation missing for parameters section in swagger:route #2719
• Substags not provided #2686
• Installation instructions are not up-to-date #2664
• Problem with generate server #2634
• Using minItems not generating correct validation code #2597
• Generated client code prints a pointer in Error() func #2590
• Support for a "description" struct tag #2541
• Get an error "invalid character '-' in numeric literal\n\nrequest body: " when using formData. #2491
• Single Model has rogue type with no explanation #2254
• Update README with a new section about OpenAPI 3.0 to avoid more questions [#2192](htt...

Changelog

v0.30.5 (2023-06-10)

Full Changelog

Implemented enhancements:

• feat: swagger mixin -c all #2297
• Server hangs given a panic in configure_ #1655

Closed issues:

• Default client error lacks context which is the failing operation #2945
• Coverity issue shows up after using pattern keyword for string data type #2941
• go-swagger install error #2934
• [Proposal] Introducing new compatibility level "Warning" for changes which are technically non-breaking but can cause unforeseen behavior change for client #2932
• Diff tool does not find differences in form params #2929
• Problem generate definitions of models #2910
• Version v0.30.4 generates incomplete spec #2904
• Response schema is not generated #2902
• Swagger parser ignores response entries when there's an extension #2901
• DIFF command panics when definition property type changes from an array to a non-array type #2894
• Generated client not compiled when x-go-name is specified #2892

Merged pull requests:

• Use proper operation name in default client error #2947 (petar-dochev-f3)
• fix timeout of golangci-lint #2946 (satorunooshie)
• Fix typo in operation.go #2943 (steambap)
• Fix typo in faq doc #2937 (ChandanChainani)
• extension diff support #2936 (zmay2030)
• feat(diff): introducing warning compatibility level #2933 (schafle)
• fix(diff): swagger diff is not working for certain cases #2931 (schafle)
• Fixed panic in AddMiddlewareFor method if method is not uppercase #2928 (iv-menshenin)
• Skip ContextValidate when the field is nil avoiding a panic fixing #2911 #2927 (romainbou)
• Fixes PropertiesSpecOrder not being used #2925 (bg451)
• Fix parameters order #2921 (inercia)
• docs: fix typo in docs/use/spec.md #2916 (davidhsingyuchen)
• test: use T.TempDir and T.Setenv to simplify code #2914 (alexandear)
• handles scenario when a def in v1 changes from array to non-array typ… #2895 (zmay2030)
• Fixed generation SetDefaults for client when x-go-name is specified #2893 (asv)

* This Changelog was automatically generated by github_changelog_generator

What's Changed

• made up for missing packages from template by @koron in #2824
• fixes #2831, circular dependency issue by @aven30 in #2832
• Fix #2800 Update key import method for debian by @tina-hello in #2834
• Support for extensions within swagger:parameters by @cccRaim in #2836
• build without -trimpath because it causes issues when generating a spec by @casualjim in #2843

New Contributors

• @aven30 made their first contribution in #2832
• @tina-hello made their first contribution in #2834
• @cccRaim made their first contribution in #2836

Full Changelog: v0.30.2...v0.30.3

What's Changed

• format output as yaml by @casualjim in #2819

Full Changelog: v0.30.1...v0.30.2

Changelog

v0.30.0 (2022-08-26)

Full Changelog

Implemented enhancements:

• Support for extensions within swagger:route #1957
• How to get enums to show up in a swagger specification? #954

Closed issues:

• any type (generics) #2809
• Question: how to make snakize to ignore some abbreviation? #2794
• Work around for name collisions? #2792
• Specify the same parameter more than one time #2786
• unhandled type to resolve JSON pointer #2768
• Go 1.19 change breaks swagger #2759
• [CLI] Generating an empty object using swagger:type object does not work as expected. #2758
• generate: Ref property in response doesn't have a description #2757
• swagger generate client returns info.title in body is required #2739
• Add trimPrefix and trimSuffix to template FuncMap #2737
• Generated CLI does not compile when using arrays as query parameters #2735
• How can I import from a yaml file #2729
• Middleware not stopping request execution #2723
• @failure, @success Response Type Usage Error #2722
• Need to fix the options of todo-list-server in todo-list example #2716
• Call for transparent HTTP status codes in generated struct #2706
• strfmt.ObjectId is scanned back as an array of strings #2704
• Cannot convert an expression of the type 'map[string]SomeType' to the type 'SomeType' #2682
• Installing go-swagger as Debian packages fails #2558
• swagger:type override is not working #2229
• Generating code for go modules is much slower than under GOPATH #1826

Merged pull requests:

• Fixes for go 1.19 #2808 (casualjim)
• fixbug: interface{} in a map as value should be generated/typed to any #2776 (emilgpa)
• Fix docker command in install.md #2765 (tingstad)
• 1957: Support for extensions within swagger:route #2751 (Huckletoon)
• #2748 passing request context to ConextValidate() #2749 (dimovnike)
• support swagger:type on structs #2747 (casualjim)
• Add support for template plugins #2745 (kevinbarbour)
• Update jwt library #2744 (katyanna)
• Add sprig library for template functions. #2741 (kevinbarbour)
• Fix issue assigning slice pointer to slice in CLI #2736 (kevinbarbour)
• support MarshalText in custom type #2727 (emilgpa)
• fixes using indexed property for accessing additional properties #2725 (casualjim)
• Update the option --tls-certificate-key to --tls-key of todo-list-server in todo-list example #2718 (nishipy)
• support for passing basepath as an argument #2713 (svyotov)
• add an interface to deal with client responses based on the status code #2708 (casualjim)
• support key non-string in map if the key implements TextMarshaler interface #2707 (emilgpa)
• #2704 codescan fix for strfmt.ObjectId #2705 (dimovnike)

* This Changelog was automatically generated by github_changelog_generator

Changelog

v0.29.0 (2022-01-23)

Full Changelog

Implemented enhancements:

• custom generator / export generation data #2055

Closed issues:

• crash in swagger generate spec --scan-models #2690
• Support nested body params in map objects. #2684
• My uint's becomes int64 and so does my byte's #2677
• go-swagger generate invalid code #2667
• When go-swagger will have support openApi 3.0 ? #2666
• How to read body in handler? (using params cause fields to be re-ordered) #2665
• Add Release Arch for darwin_arm64 #2658
• Is it possible to the order in which the APIs are shown in swagger #2646
• how to combine swagger doc for multiple services running in different ports into a single SWAGGER UI #2645
• Client generator generates code files with invalid/broken imports #2609
• couldn't find a swagger spec #2580

Merged pull requests:

• Replace bindata with go:embed #2697 (kaisawind)
• Fixed exclude spec not work issue #2696 (nanjj)
• Fix broken docs link to pflag project #2695 (pgier)
• avoid nil pointer panic #2691 (dirkm)
• Add support for nested map property names in errors. #2685 (veleek)
• enhancement: Add .Pointer\(\) method to enums. #2680 (thetorpedodog)
• build binaries for Darwin arm64 #2671 (parsnips)
• genspec: use schema only for params in body #2661 (crazytyper)
• codescan: use TypeSpec.Doc over GenDecl.Doc #2659 (crazytyper)

* This Changelog was automatically generated by github_changelog_generator

Changelog

v0.28.0 (2021-10-09)

Full Changelog

Fixed bugs:

• strfmt.bsonobjectid validation fails #2616
• Creating models crash when using $ref on an array #2511

Closed issues:

• The CLI should return a JSON output rather than objects #2640
• Log-output is not working for validate command #2631
• unsupported type "invalid type" when add a new empty go file #2630
• how to response different field of response struct by different routes? #2629
• Using swagger:strfmt on a []byte type (UUID) infers the type as an array of strings #2627
• "github.com/go-openapi/errors".CompositeError has no field or method ValidateName #2623
• undefined: validate.ReadOnly #2613
• [BUG]gen model-package with relative path has incorrect imports from v0.25.0 #2608
• Error: "source formatting on generated source "autoconfigure" failed" on server generate #2602
• Error: "source formatting on generated source "autoconfigure" failed" if StrictResponders and ImplementationPackage were both set for a server generation #2601
• How to change the case style (pascal, camel) of a struct tag #2600
• 05 Method Not Allowed response instead of 400 with incorrect validation details #2598
• Support nested body params for CompositeError #2594
• [apiKey] auth by two apikey together(AND Operation) #2586
• How to add authInfo to request with generated client #2584
• Is there good to way to omit readonly key #2581
• Generating Spec results in Invalid Type Error #2577
• Integration with viper #2572
• unsupported type "invalid type" #2569
• Cannot install directly from github #2560
• Generated server code with Go v1.15 and above generates deprecation warning for TLSConfig #2559

Merged pull requests:

• Add github workflow to validate bindata.go #2642 (youyuanwu)
• Fix auto-configure example #2641 (youyuanwu)
• Fix generate server with flag --keep-spec-order #2621 (elipavlov)
• 2617 array params #2620 (dimovnike)
• update build containers to freeze to go 1.15 for now #2606 (casualjim)
• Removed bracket that was causeing an error if StrictResponders and Im… #2603 (mattalexx)
• Support nested body params for CompositeError #2595 (veleek)
• Build from interface panic fix #2591 (Pungyeon)
• fix a broken link in todo-list tutorial #2589 (rueyaa332266)
• remove call to deprecated function BuildNameToCertificate #2582 (rcousineau-xandr)
• Added ppc64le support on circleci & goreleaser #2574 (mgiessing)
• CLI nil ptr dereference bug fix, and support enum completion #2571 (youyuanwu)
• add option to add your own path #2570 (matthewdaltonamount)
• CLI code generation is ready for release #2562 (youyuanwu)
• add enum description #2561 (d0ngw)
• Generate CLI: Able to generate cli for docker, and major functionalities complete #2556 (youyuanwu)

* This Changelog was automatically generated by github_changelog_generator

Changelog

v0.27.0 (2021-03-31)

Full Changelog

Breaking changes:

• Updating go-openapi breaks $ref on windows #2428

Implemented enhancements:

• Pointer convertors for enum types are not generated. #2482
• extension fields in info.contact do not propagate to embedded spec #2054

Fixed bugs:

• Client Headers in response panic #2544
• Swagger expand add invalid authorizationUrl key in securityDefinitions #2506

Closed issues:

• Unable to install go-swagger package #2555
• Question: How can I get the raw response body without decoding? #2552
• There is a typo in docs/install.md #2550
• can't generate header from source code #2532
• Authentication tutorial missing required Swagger spec updates #2530
• Use-case for --exclude-configuration or public function SetMiddleware() #2529
• Documention translate #2526
• Unknown command 'markdown' #2517

Merged pull requests:

• refactor CLI generate, support datetime, support multi success resp #2554 (youyuanwu)
• #1472 SecurityPrincipalFrom() and request reference #2553 (andrefsp)
• Fix a typo in install.md #2551 (masa08)
• Bugfix: Client response headers panic #2548 (kenjones-cisco)
• CLI implementation (generate command line tool) #2545 (youyuanwu)
• generator: introduce support for "description" struct tag #2542 (redlicha)
• generator: fix initialization of empty arrays #2534 (redlicha)
• Update Authentication tutorial with spec changes #2531 (slawekzachcial)
• enhancement: added enum pointer factory to codegen #2514 (fredbi)
• windows support: updated go-openapi dependencies #2513 (fredbi)
• Update install.md #2512 (ashishtiwari1993)
• Auto wire api and backend #2510 (youyuanwu)

* This Changelog was automatically generated by github_changelog_generator