Skip to content

feat: add openapi swagger spec#43

Open
ankittk wants to merge 2 commits intomcpjungle:mainfrom
ankittk:ankittk-add-openapi-spec
Open

feat: add openapi swagger spec#43
ankittk wants to merge 2 commits intomcpjungle:mainfrom
ankittk:ankittk-add-openapi-spec

Conversation

@ankittk
Copy link
Contributor

@ankittk ankittk commented Aug 11, 2025

@ankittk ankittk changed the title Ankittk add openapi spec feat: add openapi swagger spec Aug 11, 2025
@ankittk ankittk mentioned this pull request Aug 11, 2025
@@ -0,0 +1,127 @@
package docs
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it idiomatic to put swagger stuff inside a docs package in go?
Because currently there's development.md documentation file inside the docs/ directory.
I don't want to cram both go code and MD files inside the docs/ folder so either the go code can be moved to a different directory or the MD file can be.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I love the format of this project, where you keep your markdown file outside to find easily
all of your api docs / go docs can go to dir/docs , thats my suggestion, open for your thoughts.

https://github.com/agentgateway/agentgateway

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

also this is in internal/docs not docs in root of repo

got := deriveTags(tt.path)
assert.Equal(t, tt.want, got, "deriveTags(%q)", tt.path)
}
}
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Since we've decided to remove the vendor/ directory, you can remove vendor from this PR as well.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

i will rebase this branch, once #44 this merged

@duaraghav8
Copy link
Member

I am still reviewing this PR. Right now I just added my initial thoughts. I will notify you here once I've completed my review @ankittk

@duaraghav8
Copy link
Member

I just merged your other PR, so this one now has some conflicts with base that need to be fixed.

@ankittk ankittk force-pushed the ankittk-add-openapi-spec branch from f4dce02 to 474a526 Compare August 13, 2025 04:47
@ankittk
Copy link
Contributor Author

ankittk commented Aug 13, 2025

@duaraghav8 fixed the conflict, let me know if you have any swagger requested change.

@ankittk ankittk requested a review from duaraghav8 August 16, 2025 17:55
@ankittk
Copy link
Contributor Author

ankittk commented Aug 19, 2025

@duaraghav8 did you get chance to test this?

@duaraghav8 duaraghav8 force-pushed the main branch 3 times, most recently from 67f2579 to 6709e3a Compare September 11, 2025 13:50
@duaraghav8 duaraghav8 force-pushed the main branch 2 times, most recently from e6f9f3d to 321f552 Compare October 8, 2025 08:33
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants