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

The schema for the appsec Rate Policy Actions API is incorrect. #8

Open
1 of 4 tasks
kimjackson opened this issue Mar 11, 2024 · 1 comment
Open
1 of 4 tasks
Labels
bug Something isn't working STG Security team needed under investigation Internal investigation of the issue in progress

Comments

@kimjackson
Copy link

Issue type

  • Bug
  • New feature request
  • Improvement
  • Documentation (description, summaries, general text field issues)

Which API?

/appsec/v1/configs/{configId}/versions/{versionNumber}/security-policies/{policyId}/rate-policies
a.k.a. get rate policy actions.

Issue

  1. The response object is incorrectly named ratePolicies, but it should be ratePolicyActions.
  2. The type for the id field is set to string, but it should be integer.

Context

We're building an application using client code generated from the API spec with openapi-generator. We're having to patch around errors in the Akamai API specs to get some of the API calls working.

Bugs: Steps to reproduce

https://github.com/akamai/akamai-apis/blob/main/apis/appsec/v1/schemas/rate-policy-actions.yaml#L11
https://github.com/akamai/akamai-apis/blob/main/apis/appsec/v1/schemas/rate-policy-actions.yaml#L24
https://github.com/akamai/akamai-apis/blob/main/apis/appsec/v1/examples/rate-policy-actions.json#L2

Possible solution

I'll raise a PR.

Additional information

@skearney-akamai
Copy link
Collaborator

@kimjackson opened a PR for the fixes. See PR-9.

Kim,

As I said on the PR, I'll look into this and get back to you here.

Thanks again,
Sheila Kearney

@skearney-akamai skearney-akamai added bug Something isn't working under investigation Internal investigation of the issue in progress labels Mar 12, 2024
@skearney-akamai skearney-akamai added the STG Security team needed label Apr 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working STG Security team needed under investigation Internal investigation of the issue in progress
Development

Successfully merging a pull request may close this issue.

2 participants