-
Notifications
You must be signed in to change notification settings - Fork 15
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
feat(137): add apply AEP #248
Conversation
ec17fde
to
9dda673
Compare
This AEP notably does not describe behavior for unpopulated fields - this is waiting on #206 to describe the HTTP behavior, at which point Apply can follow similar guidance. |
add a new standard method to document apply / PUT. This AEP is useful for: - APIs that would like to offer a PUT endpoint, but has lacked guidance from the AEPs. - APIs that would like to expose a declarative-friendly API endpoint (the integration of which is simpler than apply). Apply can also serve as an alternative to expose a create and update endpoint.
9dda673
to
2171066
Compare
Co-authored-by: Richard Frankel <[email protected]>
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What benefit does Apply provide over Create that justifies deviating from specified HTTP behavior?
5851b86
to
0306fb7
Compare
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I don't think I've seen "Apply" used in this way before, which is why I was originally confused. But it looks good now that the request target has been cleaned up, and fills a significant gap. However, I would recommend adding text to make explicit that APIs may reject attempts to create resources via Apply (e.g. because a collection does not support client-provided paths for its children).
It's also worth referencing this new AEP from 134 (Update).
Ack! Thanks for the review and approval. Yes, I will add that caveat, and include the reference from AEP 134, before merging. |
Co-authored-by: Richard Gibson <[email protected]>
Also as a quick note - the term "apply" is borrowed from Kubernetes, which uses it to refer to their PUT requests: https://kubernetes.io/docs/reference/kubectl/generated/kubectl_apply/ |
add a new standard method to document apply / PUT.
This AEP is useful for:
Apply can also serve as an alternative to expose a create and update endpoint.
This PR also performs a few quick fixes:
🍱 Types of changes
What types of changes does your code introduce to AEP? Put an
x
in the boxesthat apply
📋 Your checklist for this pull request
Please review the AEP Style and Guidance for
contributing to this repository.
General
references AEPs
correctly.
(usually
prettier -w .
)Additional checklist for a new AEP
guidelines are met.
Document structure
guidelines are met.
💝 Thank you!