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

Feature Request - warn when an invalid openApiOperationId is specified #632

Open
jpjpjp opened this issue Aug 16, 2024 · 2 comments
Open
Assignees
Labels
new feature New potential functionality

Comments

@jpjpjp
Copy link
Contributor

jpjpjp commented Aug 16, 2024

I recently discovered that some of the tests I thought I had written weren't being created. After some investigation, I realized that the OperationId I specified didn't match what was in my spec.

In my case I had a variation test that looked something like this:

version: 1.0
tests:
  integrationTests:
    - name: /categories tests
       operations:
         - openApiOperationId: updateCategoryById
            openApiResponse: '200'
            variations:

Since my spec file didn't have an updateCategoryById none of the tests specified in this section got generated.

It would be nice if Portman would generate a warning, or even outright fail when it can't find a specified OpenAPIOperationId

Thanks for your consideration!

@thim81
Copy link
Collaborator

thim81 commented Sep 28, 2024

hi @jpjpjp

Would this be something you had in mind for the warning?
image

Question: what would be the default? That this warning is displayed or only when the --warn parameter is included?

@thim81 thim81 self-assigned this Sep 28, 2024
@thim81 thim81 added the new feature New potential functionality label Sep 28, 2024
@jpjpjp
Copy link
Contributor Author

jpjpjp commented Sep 29, 2024

Yes. This would be really helpful to catch mistakes!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
new feature New potential functionality
Projects
None yet
Development

No branches or pull requests

2 participants