merge master to v2 #1903

ubogdan · 2024-10-17T23:01:43Z

Describe the PR
Sync changes from master with v2 branch.

Relation issue
e.g. https:/swaggo/swag/pull/118/files

Additional context
Neet to resolve conflicts. (wip)

remove repeat net/http

* Add template action delimiter cli flag * Add delims to generator config and template Also adds tests using the "quote" test as a base. This has to have a custom Instance name or it will clash with the "quotes" one and panic since it will have registered two "swagger" instances in the package test. * Add testdata for custom delim flags Based on the "quote" testdata. * Add delims to the spec, with tests. Make sure we don't add delims if they are empty. This shouldn't be possible, but might as well be safe. * Go mod tidy and sum update * Make the CLI experience a bit cleaner * Revert go.mod and sum * Update readme

Signed-off-by: sdghchj <[email protected]>

) * add retract caused by accidentally pushed tags * update version to match new tag version --------- Co-authored-by: Tobias Theel <[email protected]>

Co-authored-by: wanglonghui7 <[email protected]>

Signed-off-by: sdghchj <[email protected]>

Bumps [github.com/gin-gonic/gin](https:/gin-gonic/gin) from 1.7.7 to 1.9.1. - [Release notes](https:/gin-gonic/gin/releases) - [Changelog](https:/gin-gonic/gin/blob/master/CHANGELOG.md) - [Commits](gin-gonic/gin@v1.7.7...v1.9.1) --- updated-dependencies: - dependency-name: github.com/gin-gonic/gin dependency-type: direct:production ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

…ort (#1600) Bumps [github.com/gin-gonic/gin](https:/gin-gonic/gin) from 1.7.7 to 1.9.1. - [Release notes](https:/gin-gonic/gin/releases) - [Changelog](https:/gin-gonic/gin/blob/master/CHANGELOG.md) - [Commits](gin-gonic/gin@v1.7.7...v1.9.1) --- updated-dependencies: - dependency-name: github.com/gin-gonic/gin dependency-type: direct:production ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

…le params (#1621) * fix required params parsing for routes with multiple paths and multiple params * fix incorrect variable declaration of validParams

* parser: if all tags negate return true on no hits

* support binary const Signed-off-by: sdghchj <[email protected]> * add test Signed-off-by: sdghchj <[email protected]> --------- Signed-off-by: sdghchj <[email protected]>

* global security * improve test

#1605) * change cli flag to parse operations in dependency Signed-off-by: sdghchj <[email protected]> * change cli flag to parse operations in dependency Signed-off-by: sdghchj <[email protected]> * add cli flag --pdl to determine whether parse operations in dependency Signed-off-by: sdghchj <[email protected]> * add cli flag --pdl to determine whether parse operations in dependency Signed-off-by: sdghchj <[email protected]> * add cli flag --pdl to determine whether parse operations in dependency Signed-off-by: sdghchj <[email protected]> --------- Signed-off-by: sdghchj <[email protected]>

… P (#1582)

)

test: add a test case to validate permission equal

Bumps gopkg.in/yaml.v3 from 3.0.0-20200615113413-eeeca48fe776 to 3.0.0. --- updated-dependencies: - dependency-name: gopkg.in/yaml.v3 dependency-type: indirect ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [golang.org/x/net](https:/golang/net) from 0.8.0 to 0.17.0. - [Commits](golang/net@v0.8.0...v0.17.0) --- updated-dependencies: - dependency-name: golang.org/x/net dependency-type: indirect ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

Bumps [golang.org/x/net](https:/golang/net) from 0.7.0 to 0.17.0. - [Commits](golang/net@v0.7.0...v0.17.0) --- updated-dependencies: - dependency-name: golang.org/x/net dependency-type: indirect ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

…value, make fixes to prevent a null pointer exception occurs (#1667)

Bumps [golang.org/x/net](https:/golang/net) from 0.10.0 to 0.17.0. - [Commits](golang/net@v0.10.0...v0.17.0) --- updated-dependencies: - dependency-name: golang.org/x/net dependency-type: indirect ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

) Bumps [golang.org/x/net](https:/golang/net) from 0.10.0 to 0.17.0. - [Commits](golang/net@v0.10.0...v0.17.0) --- updated-dependencies: - dependency-name: golang.org/x/net dependency-type: indirect ... Signed-off-by: dependabot[bot] <[email protected]> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com>

This commit fixes a param comment issue where a "\n" gets escaped so it would not be applied to the output swagger file.

* feat: support markdown description for declaration * fix: range PackagesDefinitions.uniqueDefinitions cause panic --------- Co-authored-by: xinbi.nie <[email protected]>

* fix：parse all fields names declared in a row

ubogdan · 2024-10-18T22:20:40Z

@sdghchj can you please give a hand here, we have 2 unit tests failing ...

sdghchj · 2024-10-19T02:44:48Z

My pleasure, however what can I do for you?
I have no developing experience about v2 mechanism.
I just doubt v2 was wrongly used.
I see the v2 branch is trying to support OpenAPI specification both V2 and V3, that means it is trying to be compatible with the master branch. But v2 is usually used when the compatibility is broken.
I just tried removing the v2 from the module path and all the import package path in the branch v2-merge you created a few hours ago , then I found the test TestParseGenericsFunctionScoped passed.
So my opinion is remove v2.
@Nerzal Here needs your advice.

ubogdan · 2024-10-19T05:27:59Z

@sdghchj No worries about the experience with the v2 branch.

We changed the import path so v2 can be used/tested until the development is ready. The reason is obvious: many community members want OAS3, and a smaller one is open to testing and contributing.
Also, I avoided merging so many changes into the master branch and breaking the v1.x version.

The main reason we are doing this is to keep OAS 2 fixes in sync with v2, This means we can adapt the test import path to "..v2/,,,' .

Keeping both OAS2 and OAS 3 in v2 will be more like transition path, When we consider the development is done we can warn users that we accept only security patches for "OAS2' and we will drop it in v3.

@sdghchj @easonlin404 @Nerzal what is your suggestion here: Should we drop OAS 2 completely in v2?

ubogdan · 2024-10-19T07:32:31Z

@sdghchj Thanks for the tip. Unit tests are fixed now.

This reverts commit 7b50e07.

tzxdtc and others added 30 commits April 11, 2023 10:43

Update README_zh-CN.md (#1545)

3c5e486

remove repeat net/http

fix bug: enums of explicit type conversion (#1556)

c14cc8e

Signed-off-by: sdghchj <[email protected]>

add retract to fix proxy cache caused by accidentally pushed tags (#1562

21d34e2

) * add retract caused by accidentally pushed tags * update version to match new tag version --------- Co-authored-by: Tobias Theel <[email protected]>

docs: doc to pt Add option to set template delims. (#1563)

5774b7b

fix: lint error for generated docs.go (#1583)

e749ad5

Co-authored-by: wanglonghui7 <[email protected]>

fix bug: enums of underscored number (#1581)

ea35767

Signed-off-by: sdghchj <[email protected]>

fix using tab (\t) as separator for custom type names (#1594)

e73a0d0

fix required params parsing for routes with multiple paths and multip…

0cee1c5

…le params (#1621) * fix required params parsing for routes with multiple paths and multiple params * fix incorrect variable declaration of validParams

parser: if all tags negate return true on no hits (#1624)

fe971d2

* parser: if all tags negate return true on no hits

fix: enums in body got parse incorrectly (#1625)

4536bf2

parse binary literal const (#1593)

575963e

* support binary const Signed-off-by: sdghchj <[email protected]> * add test Signed-off-by: sdghchj <[email protected]> --------- Signed-off-by: sdghchj <[email protected]>

feat: global security (#1620)

1bf0078

* global security * improve test

feat: add --packagePrefix=P for only parse packages matched by prefix…

d0f9dc5

… P (#1582)

enchancement: report which property is triggering a parsing error (#1439

27b27bd

)

add byte check before and after file is formatted (#1637)

f05ccdc

feat: preserve file permission when write formatted files (#1636)

9f128b4

test: add a test case to validate permission equal

docs(readme): fix param brace (#1647)

8ebf32f

yaml.v3 security patch (#1664)

e9d0aa5

test: remove redundant filepath.Clean call (#1675)

1460377

When the return value defined by the @success tag is equal to a null …

2da9651

…value, make fixes to prevent a null pointer exception occurs (#1667)

yukiomoto and others added 12 commits September 20, 2024 09:56

Fix param comment escaping issue (#1890)

1d730c5

This commit fixes a param comment issue where a "\n" gets escaped so it would not be applied to the output swagger file.

support markdown description for declaration (#1893)

a3c6d12

* feat: support markdown description for declaration * fix: range PackagesDefinitions.uniqueDefinitions cause panic --------- Co-authored-by: xinbi.nie <[email protected]>

update README (#1856)

9069105

Update docs for request and response headers (#1825)

4fd8a36

fix：parse all field names declared in a row (#1872)

a74d34c

* fix：parse all fields names declared in a row

Flags to parse internal and dependency package (#1894)

28de14c

fix: failing assert in enums test on 32bit (#1634)

7159b0f

Feat: Add support for parenthesis in router patterns (#1859)

d323b48

chore: Update ci.yml (#1902)

103ac42

new release (#1901)

0b9e347

Merge branch 'v2' into v2-merge

5b930d4

fix some issues

36c14a4

fix unit tests

6106783

ubogdan requested review from sdghchj, Nerzal and easonlin404 and removed request for sdghchj October 19, 2024 07:31

sdghchj approved these changes Oct 19, 2024

View reviewed changes

ubogdan merged commit 7b50e07 into v2 Oct 19, 2024
9 of 10 checks passed

ubogdan deleted the v2-merge branch October 19, 2024 20:25

ubogdan restored the v2-merge branch October 19, 2024 20:25

ubogdan added a commit that referenced this pull request Oct 19, 2024

Revert "merge master to v2 (#1903)"

a02df0a

This reverts commit 7b50e07.

ubogdan mentioned this pull request Oct 19, 2024

Revert "merge master to v2" #1906

Merged

ubogdan added a commit that referenced this pull request Oct 19, 2024

Revert "merge master to v2 (#1903)" (#1906)

37834cd

This reverts commit 7b50e07.

ubogdan deleted the v2-merge branch October 19, 2024 20:30

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

merge master to v2 #1903

merge master to v2 #1903

ubogdan commented Oct 17, 2024 •

edited

Loading

ubogdan commented Oct 18, 2024

sdghchj commented Oct 19, 2024 •

edited

Loading

ubogdan commented Oct 19, 2024

ubogdan commented Oct 19, 2024

merge master to v2 #1903

merge master to v2 #1903

Conversation

ubogdan commented Oct 17, 2024 • edited Loading

ubogdan commented Oct 18, 2024

sdghchj commented Oct 19, 2024 • edited Loading

ubogdan commented Oct 19, 2024

ubogdan commented Oct 19, 2024

ubogdan commented Oct 17, 2024 •

edited

Loading

sdghchj commented Oct 19, 2024 •

edited

Loading