Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for @title keyword annotation #1657

Merged
merged 5 commits into from
Dec 8, 2024

Conversation

DominykasValutis
Copy link

@DominykasValutis DominykasValutis commented Aug 2, 2024

All Submissions:

  • Have you followed the guidelines in our Contributing document?
  • Have you checked to ensure there aren't other open Pull Requests for the same update/change?
  • Have you written unit tests?
  • Have you written unit tests that cover the negative cases (i.e.: if bad data is submitted, does the library respond properly)?
  • This PR is associated with an existing issue?

Closing issues

Put closes #1656

If this is a new feature submission:

  • Has the issue had a maintainer respond to the issue and clarify that the feature is something that aligns with the goals and philosophy of the project?

Potential Problems With The Approach

Test plan

Copy link

@github-actions github-actions bot left a comment

Choose a reason for hiding this comment

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

Hello there DominykasValutis 👋

Thank you and congrats 🎉 for opening your first PR on this project.✨

We will review the following PR soon! 👀

@stskrp stskrp mentioned this pull request Aug 14, 2024
4 tasks
@github-actions github-actions bot added the Stale label Sep 2, 2024
Repository owner deleted a comment from github-actions bot Sep 2, 2024
@WoH WoH removed the Stale label Sep 2, 2024
@WoH
Copy link
Collaborator

WoH commented Sep 2, 2024

Sorry for the delay. Could you add a test to make sure this doesn´t break accidentally?

@DominykasValutis
Copy link
Author

@WoH could you guide me for which component you want me to add test, cannot find any previous test for validatorUtils.ts file

@WoH
Copy link
Collaborator

WoH commented Sep 18, 2024

There are no tests for that file explicitly, but you can add an annotation in the test fixtures and add an assertion for OpenAPI V2 / V3 here:

https://github.com/lukeautry/tsoa/tree/master/tests%2Funit%2Fswagger

schemaDetails(3).ts

@DominykasValutis
Copy link
Author

@WoH added unit test

@jackey8616
Copy link
Collaborator

@WoH added unit test

I think still missing OpenAPI 2's unit test.
You should add at schemaDetails.ts.

@DominykasValutis
Copy link
Author

Not sure if annotations are tested in OpenAPI V2, could you point me where should I add it if I'm wrong

@DominykasValutis
Copy link
Author

@WoH @jackey8616 could you reply to the previous comment, thank you!

@jackey8616
Copy link
Collaborator

@WoH @jackey8616 could you reply to the previous comment, thank you!

Sorry for the late reply,
I believe the path should be tests/unit/swagger/schemaDetails.spec.ts

@DominykasValutis
Copy link
Author

@jackey8616 @WoH added unit tests for OpenAPI V2

@WoH WoH requested a review from jackey8616 November 11, 2024 12:31
@DominykasValutis
Copy link
Author

@jackey8616 @WoH when this can be merged?

@WoH WoH force-pushed the master branch 2 times, most recently from 30cc104 to 82b61ec Compare December 8, 2024 16:44
@WoH WoH merged commit 666fec3 into lukeautry:master Dec 8, 2024
18 checks passed
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.

4 participants