Commit Graph

90 Commits

Author SHA1 Message Date
Oluebube Princes Egbuna 0fbfc94968 Merge remote-tracking branch 'upstream/main' into dev-1.29 2023-10-25 09:39:05 +01:00
AmarNathChary 6f6b57cb97 updated example appearance in k8s api concept
Updated examples appearance in k8s api concep

updated examples appearance in k8s API concept

Updated examples appearance in k8s API concept
2023-10-17 12:58:04 +05:30
Kubernetes Prow Robot e805cb9e7b
Merge pull request #41114 from hatfieldbrian/patch-1
Correct `collection` definition to a list of instances of a resource _type_
2023-10-10 10:36:08 +02:00
Kat Cosgrove ad943fce2f
Merge main into dev-1.29 to keep in sync 2023-10-06 15:36:13 +01:00
Wojciech Tyczyński ac5112ef0c Graduate APIListChunking to GA documentation 2023-08-31 10:59:03 +02:00
Tim Bannister 0a89bf8d5a Fix incorrect Markdown 2023-08-15 23:06:05 +01:00
Tim Bannister 34d243a92c Add advice about choosing an update mechanism
Explain options for updating existing objects in the Kubernetes API.
2023-08-15 23:06:05 +01:00
Tim Bannister 84d072e025 Note that CRDs don't support Strategic Merge Patch
(the custom API that is, not the CustomResourceDefinition itself)
2023-08-15 23:06:05 +01:00
Tim Bannister 797f0e6a66 Improve docs relating to patching and SSA
Co-authored-by: Antoine Pelisse <apelisse@gmail.com>
Co-authored-by: Divya Mohan <divya.mohan0209@gmail.com>
2023-08-15 23:06:05 +01:00
Kubernetes Prow Robot a9773378eb
Merge pull request #41697 from pranav-pandey0804/fixedapi-concepts/invalidlink
fixed the error in the syntax of the metadata link
2023-06-20 18:18:20 -07:00
pranav-pandey0804 41fc9dc627 fixed the error in the syntax of the metadata link 2023-06-20 19:49:27 +05:30
Marcelo Giles 2e42994c9f
Document APIResponseCompression feature gate (#41318)
* Document APIResponseCompression feature gate

* Modify APIResponseCompression definition

* Document APIResponseCompression feature gate

Modify APIResponseCompression definition

Minor edits to streamline paragraphs
2023-05-26 01:16:52 -07:00
PRANAV PANDEY 1e2b0dee3b
Fixed invalid link for object metadata (#40914)
* Fixed invalid link for object metadata

* Update content/en/docs/reference/using-api/api-concepts.md

Co-authored-by: Qiming Teng <tengqm@outlook.com>

* Update api-concepts.md

---------

Co-authored-by: Qiming Teng <tengqm@outlook.com>
2023-05-23 02:48:28 -07:00
hatfieldbrian 25bb30bac1
Update api-concepts.md
Correct collection definition: a list of instances of a resource _type_
2023-05-13 04:23:57 -07:00
Tim Bannister 634c17f61c Reorganize Working with Kubernetes Objects section
- move Understanding Kubernetes Objects to be section overview
- within the section, consistently link to the new (moved) page from the
  first mention of “object”
- add a redirect

Co-authored-by: Divya Mohan <divya.mohan0209@gmail.com>
2023-04-29 21:39:42 +01:00
Kubernetes Prow Robot f23cc952bf
Merge pull request #39993 from wojtek-t/send_initial_events
Streaming lists documentation
2023-03-27 08:38:30 -07:00
Wojciech Tyczyński 2bf6e39053 Streaming lists documentation 2023-03-27 15:39:56 +02:00
Kevin Delgado c0df96e6aa make more timeless 2023-03-22 12:44:42 -07:00
Kevin Delgado b170854277 docs for field validation GA 2023-03-22 12:44:38 -07:00
Kubernetes Prow Robot 587cd17a5c
Merge pull request #37111 from stephen-dahl/main
added note about core resources using /api and added path examples
2023-01-02 23:47:31 -08:00
mgoodwin1989 7549365878
Fixed spelling mistake 2022-12-26 11:58:53 -05:00
stephen-dahl 12098cf842 added note about core resources using /api and added path examples 2022-09-30 09:53:02 -07:00
Akanksha Kumari 56a752a145 Update Anchor and point to validatingwebhook-v1-admissionregistration-k8s-io 2022-09-15 20:04:36 +05:30
Kubernetes Prow Robot f72dfae2bd
Merge pull request #34622 from irbekrm/add_remaining_items
Adds remainingItemCount to HTTP response
2022-08-24 14:11:49 -07:00
Kevin Delgado 2dc5f254e9 Add Server Side Field Validation to API Concepts 2022-07-31 05:57:55 +00:00
irbekrm f1465601c3 Adds remainingItemCount to HTTP response
Signed-off-by: irbekrm <irbekrm@gmail.com>
2022-06-26 14:25:52 +01:00
Joel Gerber 47be146d86
Update content/en/docs/reference/using-api/api-concepts.md
Co-authored-by: divya-mohan0209 <divya.mohan0209@gmail.com>
2022-04-25 07:41:46 -04:00
Joel Gerber c00146a3a6
Update content/en/docs/reference/using-api/api-concepts.md
Co-authored-by: divya-mohan0209 <divya.mohan0209@gmail.com>
2022-04-25 07:41:33 -04:00
Joel Gerber f3adb2cd66
Update content/en/docs/reference/using-api/api-concepts.md
Co-authored-by: divya-mohan0209 <divya.mohan0209@gmail.com>
2022-04-22 07:06:31 -04:00
Joel Gerber bf0c2cfcf7
Fix a minor typo in the 2nd paragraph of overview 2022-04-21 11:35:46 -04:00
Ariel Shaqed (Scolnicov) 9d45d964ed
Fix golang client-go/tools/cache package name
Documentation shows incorrect package name, I believe it should refer to
[`client-go/ools/cache`](https://pkg.go.dev/k8s.io/client-go/tools/cache).
2022-02-22 17:08:57 +02:00
Tim Bannister a49c612734 Rewrap API concepts page 2021-10-24 14:31:20 +01:00
Tim Bannister 2ca81a1cd2 Bump Table API to v1
Table is now GA
2021-10-24 14:31:20 +01:00
Tim Bannister a53db47615 Revise API details page 2021-10-24 14:31:19 +01:00
Yuiko Mouri 8f301ea379 Replace with relative path 2021-08-05 11:54:46 +09:00
Chris Negus 96d89ba3f4
Added examples of Lists to api-concepts (#28608)
* Added List descriptions to api-concepts

* Corrected note and example per comments
2021-07-13 02:04:31 -07:00
Kubernetes Prow Robot 3cc8f3fec8
Merge pull request #28066 from haardikdharma10/update-RemainingItemCount-beta
Promote RemainingItemCount to beta in Feature Gates docs
2021-06-30 03:19:03 -07:00
Haardik Dharma fe940d9263 Update api-concepts.md 2021-06-30 13:54:04 +05:30
Haardik Dharma 595962652b Update api-concepts.md 2021-06-10 20:34:22 +05:30
Squidtoon99 ddc67b8114
Fix a few grammar issues and typos (#28332)
* Fix few grammar issues and typos in the blog page

> see the API documentation more information
Should be corrected to "documentation for more information" as the sentence is incorrect.

> may only compare two resource version for equality
Everywhere else in the paragraph "resource versions" are used, I believe this is just a typo.

> The get, list and watch
Missing comma after list to separate the elements

* Fix typos in blog post

> On rare occurences, a 
"occurrences" is misspelled

>  whole list, map or struct
3 elements are missing a comma seperator after map
 
>  there are no way 
are is a plural form while "no way" is a singular subject

> `MergePatch`, `StrategicMergePatch`, `JSONPatch` or `Update`
Missing comma after JSONPatch
2021-06-08 19:11:47 -07:00
Haardik Dharma 7376d834cb Mention that responses include a remainingItemCount by default 2021-05-24 21:08:14 +05:30
Sahadat Hossain 0c7f918653
Update api-concepts.md 2021-02-13 17:26:38 +06:00
Sahadat Hossain a93938b00e
Update content/en/docs/reference/using-api/api-concepts.md
Co-authored-by: Irvi Aini <7439590+irvifa@users.noreply.github.com>
2021-02-12 22:33:16 +06:00
Sahadat Hossain 2ae6da3c19
Merge branch 'master' into master 2021-02-12 17:04:39 +06:00
sahadat_hossain 58c3f18336 fixed some typos and grammatical mistakes 2021-02-12 12:36:36 +06:00
Ricardo Pchevuzinske Katz 2346581566
Fix some spell checking
Signed-off-by: Ricardo Pchevuzinske Katz <ricardo.katz@gmail.com>
2021-01-24 16:27:42 -03:00
Qiming Teng ff6b8edc5b Move Server Side Apply into a separate reference page
"Server Side Apply" is a big topic that warrants a dedicated page on it.
Its current content is 400+ lines in the `api-concepts` page, kind of
hijacking the "api-concepts" for a standalone feature.

This PR proposes a separation for maintainability.
2020-10-13 08:56:08 +08:00
Nikhita Raghunath f5af09b9f8 SSA: fix go marker for listMapKey in the merge strategy
Ref: 64514a1d5d/pkg/generators/extension.go (L49-L50)
2020-09-25 09:51:17 +05:30
Qiming Teng 6826722885 Fix errors/nits in api-concepts
Nits fixed include:

- incorrectly specified code syntax, e.g. code snippet marked 'json' but
  the content is not JSON;
- the footnote in the paging table contains a nested table which cannot
  be rendered correctly, so the content is removed considering that it
  is just redundant table rows;
- some `kubectl apply` commands failed to provide the correct artifact
  to use while the artifact is stored online.
- fixed some other code fences by explicitly marking them as code
  snippet rather than relying on indentation (hard to maintain).
2020-09-09 08:52:06 +08:00
Savitha Raghunathan 53c71ad3f9 Merge remote-tracking branch 'upstream/master' into dev-1.19 2020-08-03 16:09:39 -04:00