NotificationTemplate [notificationtemplates.ait.alauda.io/v1beta1]

Description: NotificationTemplate is the Schema for the templates API
Type: object
Required: spec

Specification

Property	Type	Description
`apiVersion`	`string`	APIVersion defines the versioned schema of this representation of an object. Servers should convert recognized schemas to the latest internal value, and may reject unrecognized values. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#resources
`kind`	`string`	Kind is a string value representing the REST resource this object represents. Servers may infer this from the endpoint the client submits requests to. Cannot be updated. In CamelCase. More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
`metadata`	`ObjectMeta`	ObjectMeta is metadata that all persisted resources must have, which includes all objects users must create.
`spec`	`object`	NotificationTemplateSpec defines the desired state of NotificationTemplate

.spec

Description: NotificationTemplateSpec defines the desired state of NotificationTemplate
Type: object

Property	Type	Description
`email`	`object`	NotificationTemplateEmail defines the desired state of email NotificationTemplate
`sms`	`object`	NotificationTemplateCommon defines the desired state of common NotificationTemplate
`templates`	`array`
`webhook`	`object`	NotificationTemplateCommon defines the desired state of common NotificationTemplate

.spec.email

Description: NotificationTemplateEmail defines the desired state of email NotificationTemplate
Type: object
Required: content

Property	Type	Description
`content`	`string`	Content template to render notification message
`subject`	`string`	Subject template to render notification message

.spec.sms

Description: NotificationTemplateCommon defines the desired state of common NotificationTemplate
Type: object
Required: content

Property	Type	Description
`content`	`string`	Content template to render notification message

.spec.templates

Type: array

.spec.templates[]

Description: NotificationTemplateDetail defines the desired state of common NotificationTemplateDetail
Type: object
Required: contenttype

Property	Type	Description
`content`	`string`	Content template to render notification message
`subject`	`string`
`type`	`string`	TemplateType defines template type

.spec.webhook

Description: NotificationTemplateCommon defines the desired state of common NotificationTemplate
Type: object
Required: content

Property	Type	Description
`content`	`string`	Content template to render notification message

API Endpoints

The following API endpoints are available:

/apis/ait.alauda.io/v1beta1/namespaces/{namespace}/notificationtemplates
- DELETE: delete collection of NotificationTemplate
- GET: list objects of kind NotificationTemplate
- POST: create a new NotificationTemplate
/apis/ait.alauda.io/v1beta1/namespaces/{namespace}/notificationtemplates/{name}
- DELETE: delete the specified NotificationTemplate
- GET: read the specified NotificationTemplate
- PATCH: partially update the specified NotificationTemplate
- PUT: replace the specified NotificationTemplate

/apis/ait.alauda.io/v1beta1/namespaces/{namespace}/notificationtemplates

HTTP method: DELETE
Description: delete collection of NotificationTemplate
HTTP responses

HTTP code	Response body
200 - OK	`Status` schema
401 - Unauthorized	Empty

HTTP method: GET
Description: list objects of kind NotificationTemplate
HTTP responses

HTTP code	Response body
200 - OK	`NotificationTemplateList` schema
401 - Unauthorized	Empty

HTTP method: POST
Description: create a new NotificationTemplate

Query parameters

Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Body parameters

Parameter	Type	Description
`body`	`NotificationTemplate` schema	`application/json` formatted

HTTP responses

HTTP code	Response body
200 - OK	`NotificationTemplate` schema
201 - Created	`NotificationTemplate` schema
202 - Accepted	`NotificationTemplate` schema
401 - Unauthorized	Empty

/apis/ait.alauda.io/v1beta1/namespaces/{namespace}/notificationtemplates/{name}

HTTP method: DELETE
Description: delete the specified NotificationTemplate

Query parameters

Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed

HTTP responses

HTTP code	Response body
200 - OK	`Status` schema
202 - Accepted	`Status` schema
401 - Unauthorized	Empty

HTTP method: GET
Description: read the specified NotificationTemplate
HTTP responses

HTTP code	Response body
200 - OK	`NotificationTemplate` schema
401 - Unauthorized	Empty

HTTP method: PATCH
Description: partially update the specified NotificationTemplate

Query parameters

Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

HTTP responses

HTTP code	Response body
200 - OK	`NotificationTemplate` schema
401 - Unauthorized	Empty

HTTP method: PUT
Description: replace the specified NotificationTemplate

Query parameters

Parameter	Type	Description
`dryRun`	`string`	When present, indicates that modifications should not be persisted. An invalid or unrecognized dryRun directive will result in an error response and no further processing of the request. Valid values are: - All: all dry run stages will be processed
`fieldValidation`	`string`	fieldValidation instructs the server on how to handle objects in the request (POST/PUT/PATCH) containing unknown or duplicate fields. Valid values are: - Ignore: This will ignore any unknown fields that are silently dropped from the object, and will ignore all but the last duplicate field that the decoder encounters. This is the default behavior prior to v1.23. - Warn: This will send a warning via the standard warning response header for each unknown field that is dropped from the object, and for each duplicate field that is encountered. The request will still succeed if there are no other errors, and will only persist the last of any duplicate fields. This is the default in v1.23+ - Strict: This will fail the request with a BadRequest error if any unknown fields would be dropped from the object, or if any duplicate fields are present. The error returned from the server will contain all unknown and duplicate fields encountered.

Body parameters

Parameter	Type	Description
`body`	`NotificationTemplate` schema	`application/json` formatted

HTTP responses

HTTP code	Response body
200 - OK	`NotificationTemplate` schema
201 - Created	`NotificationTemplate` schema
401 - Unauthorized	Empty

#NotificationTemplate [notificationtemplates.ait.alauda.io/v1beta1]

Specification#

.spec#

.spec.email#

.spec.sms#

.spec.templates#

.spec.templates[]#

.spec.webhook#

API Endpoints#

/apis/ait.alauda.io/v1beta1/namespaces/{namespace}/notificationtemplates#

/apis/ait.alauda.io/v1beta1/namespaces/{namespace}/notificationtemplates/{name}#

NotificationTemplate [notificationtemplates.ait.alauda.io/v1beta1]

Specification

.spec

.spec.email

.spec.sms

.spec.templates

.spec.templates[]

.spec.webhook

API Endpoints

/apis/ait.alauda.io/v1beta1/namespaces/{namespace}/notificationtemplates

/apis/ait.alauda.io/v1beta1/namespaces/{namespace}/notificationtemplates/{name}