Skip to content

docs: regenerate API reference#27

Open
stakater-user wants to merge 1 commit into
mainfrom
chore/regenerate-api-reference
Open

docs: regenerate API reference#27
stakater-user wants to merge 1 commit into
mainfrom
chore/regenerate-api-reference

Conversation

@stakater-user

Copy link
Copy Markdown
Contributor

Regenerated content/reference/api.md from stakater-ab/template-operator@feat/auto-generate-workflow.

@stakater-user stakater-user requested a review from a team as a code owner July 1, 2026 15:49
@github-actions

github-actions Bot commented Jul 1, 2026

Copy link
Copy Markdown

@stakater-user PR doc deploy will soon be available for review on https://stakater.github.io/mto-docs/chore-regenerate-api-reference

Comment thread content/reference/api.md
| `deployedNamespaces` _object (keys:string, values:[DeployedNamespaceState](#deployednamespacestate))_ | DeployedNamespaces is a list of namespaces where template has been deployed along with its state. | | Optional: \{\} <br /> |
| `mappedSecrets` _object (keys:string, values:map[string]MappedResourcesState)_ | MappedSecrets is a list of secrets which have been mapped along with its state. | | Optional: \{\} <br /> |
| `mappedConfigmaps` _object (keys:string, values:map[string]MappedResourcesState)_ | MappedConfigmaps is a list of configmaps which have been mapped along with its state. | | Optional: \{\} <br /> |
| `templateManifestsHash` _string_ | TemplateManifestsHash is used to ignore false-positive template.manifests update events | | Optional: \{\} <br /> |

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[LanguageTool] reported by reviewdog 🐶
If a new sentence starts here, add a space and start with an uppercase letter. (LC_AFTER_PERIOD[1])
Suggestions: Manifests, manifests
Rule: https://community.languagetool.org/rule/show/LC_AFTER_PERIOD?lang=en-US&subId=1
Category: CASING

Comment thread content/reference/api.md
| Field | Description | Default | Validation |
| --- | --- | --- | --- |
| `status` _[InstanceDeploymentStatus](#instancedeploymentstatus)_ | Status holds the template instances status | | |
| `message` _string_ | A human readable message indicating details about why the namespace is in this condition. | | Optional: \{\} <br /> |

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[LanguageTool] reported by reviewdog 🐶
This word is normally spelled with a hyphen. (EN_COMPOUNDS_HUMAN_READABLE)
Suggestions: human-readable
Rule: https://community.languagetool.org/rule/show/EN_COMPOUNDS_HUMAN_READABLE?lang=en-US
Category: MISC

Comment thread content/reference/api.md
| `deployedNamespaces` _object (keys:string, values:[DeployedNamespaceState](#deployednamespacestate))_ | DeployedNamespaces is a list of namespaces where template has been deployed along with its state. | | Optional: \{\} <br /> |
| `mappedSecrets` _object (keys:string, values:map[string]MappedResourcesState)_ | MappedSecrets is a list of secrets which have been mapped along with its state. | | Optional: \{\} <br /> |
| `mappedConfigmaps` _object (keys:string, values:map[string]MappedResourcesState)_ | MappedConfigmaps is a list of configmaps which have been mapped along with its state. | | Optional: \{\} <br /> |
| `templateManifestsHash` _string_ | TemplateManifestsHash is used to ignore false-positive template.manifests update events | | Optional: \{\} <br /> |

Copy link
Copy Markdown

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

[LanguageTool] reported by reviewdog 🐶
If a new sentence starts here, add a space and start with an uppercase letter. (LC_AFTER_PERIOD[1])
Suggestions: Manifests, manifests
Rule: https://community.languagetool.org/rule/show/LC_AFTER_PERIOD?lang=en-US&subId=1
Category: CASING

@github-actions

github-actions Bot commented Jul 1, 2026

Copy link
Copy Markdown

@stakater-user Image is available for testing. docker pull ghcr.io/stakater/template-operator-docs:SNAPSHOT-PR-27-ec69e4d5

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

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant