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

[kimjackson]

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]

@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]

Internal note: SECKSD-27688 created for security team.

[skearney-akamai]

@kimjackson, wanted to let you know that the issue has been passed onto the security team that owns the service. They will update the item in the schema. I'm a watcher on their ticket and as I get notified of changes, I'll pass it on to you.