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

API Definitions - Updating the API endpoint hostnames requires replacing the whole API Definition #213

Open
vkolorizos opened this issue Oct 29, 2024 · 0 comments

Comments

@vkolorizos
Copy link

vkolorizos commented Oct 29, 2024

Hello,

Currently, according to the API Definition OpenAPI schema, when trying to update the hostnames on a new version of an API Endpoint the method requires to provide all details of the API Definition and not just the required values, which is correct according to REST principles since it's a PUT request, but these raises some concerns since we will need to provide also the schema and multiple other fields, which might lead to unintended changes.

https://techdocs.akamai.com/api-definitions/reference/put-endpoint-version

In a nutshell, I feel this is neither efficient nor safe way to go, so maybe a specific-purpose PATCH request should be created to just update what part of the API endpoint someone wants or specific PATCH request for adding/removing hostnames like it exists already in Properties:

https://techdocs.akamai.com/property-mgr/reference/patch-property-version-hostnames

Let me know, what you think

Thanks

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Development

No branches or pull requests

2 participants