|
| 1 | +name: New Stack functionality |
| 2 | +description: Add support for new Stack functionality |
| 3 | +title: "[FEATURE] <title>" |
| 4 | +labels: ["Feature", "Stack Led"] |
| 5 | +body: |
| 6 | +- type: input |
| 7 | + attributes: |
| 8 | + label: Name of the resource |
| 9 | + description: What is the name of the resource you are adding or extending? |
| 10 | + placeholder: "e.g elasticstack_elasticsearch_ml_datafeed" |
| 11 | +- type: textarea |
| 12 | + attributes: |
| 13 | + label: Describe new functionality |
| 14 | + description: A concise description of the new functionality to add. |
| 15 | + placeholder: | |
| 16 | + If you're extending an existing resource: |
| 17 | + * Describe any new fields, or changes to existing fields. |
| 18 | + * Reference the source code for the existing resource. |
| 19 | + * Describe any new cases that should be covered in acceptance testing. |
| 20 | + e.g: |
| 21 | + Add support for `query` field to the Machine Learning Datafeed resource. |
| 22 | + The code for the resource is in `internal/elasticsearch/ml/datafeed/`. |
| 23 | + Add new acceptance tests covering the new `query` field. |
| 24 | +
|
| 25 | + If you're adding an entirely new resource: |
| 26 | + * Describe the resource and its purpose. |
| 27 | + * Include links to relevant API documentation. |
| 28 | + * Describe where the resource code should live in the provider. |
| 29 | + * Describe any cases that should be covered in acceptance testing. |
| 30 | + e.g |
| 31 | + Add a new Machine Learning Datafeed resource to manage datafeeds for ML jobs. |
| 32 | + The new resource should live in `internal/elasticsearch/ml/datafeed/`. |
| 33 | + The resource will allow users to create, read, and delete ML datafeeds via the Elasticsearch API. |
| 34 | + API docs: |
| 35 | + - Create: https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-put-datafeed |
| 36 | + - Get: https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-get-datafeeds |
| 37 | + - Delete: https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-ml-delete-datafeed |
| 38 | + Make sure acceptance tests cover both a basic datafeed, and thoroughly cover all attributes in the resource schema, including datafeeds filtered by the `query` attribute. |
| 39 | + validations: |
| 40 | + required: true |
| 41 | +- type: input |
| 42 | + attributes: |
| 43 | + label: Version Introduced |
| 44 | + description: What version of the Stack was this functionality introduced in? |
| 45 | + placeholder: "e.g 9.2.0" |
| 46 | + validations: |
| 47 | + required: true |
| 48 | +- type: textarea |
| 49 | + attributes: |
| 50 | + label: Anything else? |
| 51 | + placeholder: | |
| 52 | + Links? References? Anything that will give us more context about the functionality you're adding! |
| 53 | +
|
| 54 | + e.g: |
| 55 | + - Links to issues/PRs where this was added in Elasticsearch/Kibana etc. |
| 56 | + - Links to any relevant documentation. |
| 57 | + - Describe any dependencies or relationships to other resources (e.g an ML datafeed is linked to an anomaly detection job). |
| 58 | + - Describe any edge cases that should be covered in acceptance testing. |
| 59 | + validations: |
| 60 | + required: false |
0 commit comments