48f3ac9af6
Update guidance on optional/required field serialization
2025-07-02 16:48:28 +01:00
fb55d44be2
Fix typo and grammar in StatusTooManyRequests
2023-10-26 20:47:46 +02:00
ea6cd120ae
Update references and examples to prefer SSA tags over SMD tags and attributes
2023-08-18 09:57:06 -04:00
50e4f2558c
Reorganize conventions for numeric fields
...
This puts them in a more incremental order and adds a stronger
convention around prefering int32 vs int64.
2023-07-26 14:12:19 -07:00
f88bbbabe8
Document short-names and categories
2023-05-17 08:45:17 -04:00
594d391253
Merge pull request #7244 from ChristopherFry/cfry/api-conventions-kubernetes-docs-links
...
Fix kubernetes doc links in api conventions doc
2023-04-24 15:03:02 -07:00
bc2cb20754
Merge pull request #7063 from ninjaprox/patch-1
...
Correct `generateName` doc when in conflict
2023-04-04 13:35:39 -07:00
b8e17d97af
Fix kubernetes doc links in api conventions doc
2023-04-04 20:13:12 +00:00
1bf6d426e7
Update api-conventions.md
2023-03-14 22:04:17 +08:00
f2f8ed71ce
Update contributors/devel/sig-architecture/api-conventions.md
...
Co-authored-by: Daniel Smith <dbsmith@google.com>
2023-03-10 11:16:08 +08:00
3f1dbcfe75
docs: fix api convention concurrency control and consistency part typo
...
Signed-off-by: AhmedGrati <ahmedgrati1999@gmail.com>
2023-02-26 11:02:35 +01:00
bd2ab6ed27
Fix design-proposals links in API conventions
2023-02-17 03:39:12 -07:00
4631c307ea
Correct `generateName` doc when in conflict
2023-01-24 10:19:24 +08:00
c318a6811f
Merge pull request #6264 from porridge/patch-1
...
Update stale reference to etcd modifiedIndex
2022-10-12 03:45:00 -07:00
317f798301
Merge pull request #6690 from Sea-n/design-proposals-archive
...
Fix links for k/design-proposals-archive
2022-08-25 11:40:07 -07:00
5ba422e1aa
api-conventions: fix leftover merge conflict mark
...
This seems to be a leftover.
2022-08-21 22:56:17 -07:00
a329a26b15
Merge pull request #6558 from deads2k/metav1-Condition
...
update condition guidance to use metav1.Conditions
2022-08-20 17:13:57 -07:00
b7bd632138
API conventions: add more on defaulting
...
In reviewing an issue/PR I realized this lesson had not been documented
anywhere. This is not the ideal mechanism, IMO, but better than
nothing.
2022-08-16 08:44:49 -07:00
6690abcd6b
Fix links for k/design-proposals-archive
2022-08-03 08:32:16 +08:00
4bee49a231
update condition guidance to use metav1.Conditions
2022-03-23 08:59:24 -04:00
9a4dbd3878
Remove recommendation for condition heartbeat
...
Heartbeats previously caused significant standing load, they are not
recommended for API types.
2022-03-23 08:51:01 -04:00
d1c12d11d4
clarify how to name kubernetes label and annotation keys
2022-03-16 16:26:36 -04:00
f8148d406c
Note when PUT can create items
...
See https://github.com/kubernetes/community/issues/6041#issuecomment-1021176213
2022-01-25 11:44:36 -08:00
b20f6135ee
Loosen the meaning of status in API conventions ( #5842 )
...
* Loosen the meaning of status in API conventions
As per KEP https://github.com/kubernetes/enhancements/issues/2527 -
remove the "from observation" guidance and add some discussion of when
to use status fields vs. additional types for allocated resources.
* Backtick spec and status
* Act on feedback
2022-01-10 14:42:25 -08:00
f058d9c79c
Merge pull request #5723 from Jefftree/default
...
Add default tag to api conventions
2022-01-10 10:33:12 -08:00
8b80565cb9
Update stale reference to etcd modifiedIndex
2021-12-03 09:26:55 +01:00
4f95b92105
Add note to api conventions about kind: List ( #5903 )
...
* Add note to api conventions about kind: List
* Wording change
* Fixed small typo
2021-10-12 11:32:33 -07:00
91bc44bf75
Merge pull request #5973 from robscott/kind-vs-resource-refs
...
Clarifying API Conventions regarding Kind and Resource in object refs
2021-09-14 06:27:09 -07:00
3a97f34b4b
Add default tag to api conventions
2021-09-13 10:58:32 -07:00
99780a63a6
add auto resource release
2021-09-07 18:40:57 +00:00
83877032b5
Clarifying API Conventions regarding Kind and Resource in object refs
2021-09-01 15:22:29 -07:00
a843caa9b1
Merge pull request #5832 from toumorokoshi/feature/consolidate-object-reference-guidance
...
consolidate object ref guidance in api conventions
2021-07-09 10:54:53 -07:00
00d73216d3
consolidate object ref guidance in api conventions
...
API conventions had two semi-duplicated sections for
object references, with slightly different guidance.
Consolidating guidance to point to the most recent
guidance.
Clarifying the naming recommendations for naming of lists
of object references, as the guidance was not explicit.
2021-06-18 13:46:40 -07:00
744e270f33
Apply suggestions from code review
...
Co-authored-by: Jordan Liggitt <jordan@liggitt.net>
2021-06-03 22:44:36 -07:00
1df12ac90f
Adding object references security considerations
...
Clarifying practices around object references that help
prevent against privilege escalation.
2021-06-03 22:44:36 -07:00
ac7999cb51
Addressing comments
...
including blurb recommending using multi resource object references
if there is a chance it will be used that way.
2021-05-25 22:32:35 -07:00
bda0f5062e
Addressing feeedback
...
- new section around resources with different versions
- called out edge cases around resource not found
- removed very old todo
2021-05-24 21:51:07 -07:00
9b694b1b79
Update contributors/devel/sig-architecture/api-conventions.md
...
Co-authored-by: Daniel Smith <dbsmith@google.com>
2021-05-24 21:51:07 -07:00
fed5c1e6a6
Addressing feedback
...
- switching fieldpath syntax to reference best practices already in the
spec
- clarifying naming of the object reference field
- fixing a poor example with a kind used where a resource value should
have been.
2021-05-24 21:51:07 -07:00
e5fb87eafa
addressing comments
...
- switched from kind to resource.
- extended examples to four kinds of object references.
- clarified use of JSON Pointer to determine the path to the field.
2021-05-24 21:51:07 -07:00
b1f8f5975c
clarifying schema for multi-kind object references
...
There are a few types of patterns for multi-kind object references
that are currently included in the Kubernetes core resources
(EnvVarSource, ObjectReference).
Adding a section to clarify the preferred pattern for future
resources.
2021-05-24 21:51:07 -07:00
bffe980b66
Merge pull request #5470 from ccouzens/patch-1
...
API conventions: escape back-quotes when visible
2021-05-10 04:24:51 -07:00
27e1a81029
Include documentation for listTypes in api conventions
2021-04-05 15:42:41 -07:00
86550d6f9b
add guidance about avoiding cross namespace references from namespace resources
2021-02-22 15:50:08 -05:00
7af4f21daf
API conventions: escape back-quotes when visible
...
> When referencing another field name, indicate the name in back-quotes. Example: "must be greater than `request`".
In this sentence, we're meant to see "request" surrounded by back-quotes.
In markdown, backticks (back-quotes) are used to create a code section, and thus aren't shown. By escaping them, they are shown to the user.
2021-02-05 17:28:04 +00:00
ec191fa473
Minor corrections to the api conventions.
...
Fixed the API Group convention for readability.
2021-01-10 21:45:50 +09:00
22e4475215
Merge pull request #5371 from bjhaid/master
...
Add an entry for `DELETE` on a collection of resources.
2021-01-04 11:41:56 -08:00
2199f730a5
Add an entry for `DELETE` on a collection of resources.
...
This adds an entry that matches the `GET` on a list of resources.
2020-12-17 14:03:18 -06:00
05334d450a
Correct list api examples and add link to field selector documentation
2020-12-08 13:30:48 -05:00
c2a0c7613b
api-conventions: Typo in initials
2020-11-11 14:55:01 -05:00
Joel Speed
David Barton
Joe Betz
Tim Hockin
Jordan Liggitt
Kubernetes Prow Robot
Chris Fry
Vinh Nguyen
AhmedGrati
hatfieldbrian
Ahmet Alp Balkan
Sean Wei
David Eads
Elana Hashman
Marcin Owsiany
Chris Negus
Jefftree
Khaled (Kal) Henidak
Rob Scott
Yusuke Tsutsumi
Antoine Pelisse
Chris Couzens
Ashish Billore
bjhaid
Paul Weil
Clayton Coleman