SDK 1.18.0 release notes and metadata endpoint docs#3882
Conversation
✅ Deploy Preview for replicated-docs ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
✅ Deploy Preview for replicated-docs-upgrade ready!
To edit notification comments on pull requests, go to your Netlify project configuration. |
replicated-ci
added
type::docs
![github-actions[bot]](https://avatars.githubusercontent.com/in/15368?s=60&v=4){kind=small}
| } | ||
| ``` | ||
|
|
||
| ## supportbundle |
There was a problem hiding this comment.
🚫 [vale] reported by reviewdog 🐶
[Vale.Spelling] Did you really mean 'supportbundle'?
| } | ||
| ``` | ||
|
|
||
| ## supportbundle |
There was a problem hiding this comment.
[Replicated.Headings] 'supportbundle' should use sentence case.
|
|
||
| ## supportbundle | ||
|
|
||
| ### POST /supportbundle/metadata |
There was a problem hiding this comment.
[Replicated.Headings] 'POST /supportbundle/metadata' should use sentence case.
|
|
||
| ### POST /supportbundle/metadata | ||
|
|
||
| Set support bundle metadata by replacing any existing metadata. The metadata is stored as top-level keys in a Kubernetes secret named `replicated-support-metadata` in the SDK namespace, and can be included in a support bundle with the Support Bundle Metadata [collector](https://troubleshoot.sh/docs/collect/support-bundle-metadata) |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.SentenceLength] Try to keep your sentence length to 26 words or fewer.
|
|
||
| ### POST /supportbundle/metadata | ||
|
|
||
| Set support bundle metadata by replacing any existing metadata. The metadata is stored as top-level keys in a Kubernetes secret named `replicated-support-metadata` in the SDK namespace, and can be included in a support bundle with the Support Bundle Metadata [collector](https://troubleshoot.sh/docs/collect/support-bundle-metadata) |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.Passive] In general, use active voice instead of passive voice ('is stored').
|
|
||
| Response: Status `200` OK | ||
|
|
||
| ### PATCH /supportbundle/metadata |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.Acronyms] Spell out 'PATCH' on first use, if it's unfamiliar to the audience.
|
|
||
| Response: Status `200` OK | ||
|
|
||
| ### PATCH /supportbundle/metadata |
There was a problem hiding this comment.
[Replicated.Headings] 'PATCH /supportbundle/metadata' should use sentence case.
|
|
||
| ### PATCH /supportbundle/metadata | ||
|
|
||
| Merge support bundle metadata with any existing metadata. New keys are added and existing keys are updated, but keys not included in the request are preserved. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.Passive] In general, use active voice instead of passive voice ('are added').
|
|
||
| ### PATCH /supportbundle/metadata | ||
|
|
||
| Merge support bundle metadata with any existing metadata. New keys are added and existing keys are updated, but keys not included in the request are preserved. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.Passive] In general, use active voice instead of passive voice ('are updated').
|
|
||
| ### PATCH /supportbundle/metadata | ||
|
|
||
| Merge support bundle metadata with any existing metadata. New keys are added and existing keys are updated, but keys not included in the request are preserved. |
There was a problem hiding this comment.
📝 [vale] reported by reviewdog 🐶
[Replicated.Passive] In general, use active voice instead of passive voice ('are preserved').
3 participants
No description provided.