github.com/oam-dev/kubevela@v1.9.11/references/cuegen/generators/provider/testdata/valid.md (about)

     1  # test
     2  
     3  ## #Apply
     4  
     5  
     6  ### *Params*
     7  
     8   Name | Description | Type | Required | Default 
     9   ---- | ----------- | ---- | -------- | ------- 
    10   cluster | The cluster to use. | string | true |  
    11   resource | The resource to get or apply. | map[string]_ | true |  
    12   options | The options to get or apply. | [options](#options) | true |  
    13  
    14  
    15  #### options
    16  
    17   Name | Description | Type | Required | Default 
    18   ---- | ----------- | ---- | -------- | ------- 
    19   threeWayMergePatch | The strategy of the resource. | [threeWayMergePatch](#threewaymergepatch) | true |  
    20  
    21  
    22  ##### threeWayMergePatch
    23  
    24   Name | Description | Type | Required | Default 
    25   ---- | ----------- | ---- | -------- | ------- 
    26   enabled | The strategy to get or apply the resource. | bool | false | true 
    27   annotationPrefix | The annotation prefix to use for the three way merge patch. | string | false | resource 
    28  
    29  
    30  ### *Returns*
    31  
    32   Name | Description | Type | Required | Default 
    33   ---- | ----------- | ---- | -------- | ------- 
    34   \- |  | {} | true |  
    35  ## #Get
    36  
    37  
    38  ### *Params*
    39  
    40   Name | Description | Type | Required | Default 
    41   ---- | ----------- | ---- | -------- | ------- 
    42   cluster | The cluster to use. | string | true |  
    43   resource | The resource to get or apply. | map[string]_ | true |  
    44   options | The options to get or apply. | [options](#options) | true |  
    45  
    46  
    47  #### options
    48  
    49   Name | Description | Type | Required | Default 
    50   ---- | ----------- | ---- | -------- | ------- 
    51   threeWayMergePatch | The strategy of the resource. | [threeWayMergePatch](#threewaymergepatch) | true |  
    52  
    53  
    54  ##### threeWayMergePatch
    55  
    56   Name | Description | Type | Required | Default 
    57   ---- | ----------- | ---- | -------- | ------- 
    58   enabled | The strategy to get or apply the resource. | bool | false | true 
    59   annotationPrefix | The annotation prefix to use for the three way merge patch. | string | false | resource 
    60  
    61  
    62  ### *Returns*
    63  
    64   Name | Description | Type | Required | Default 
    65   ---- | ----------- | ---- | -------- | ------- 
    66   \- |  | {} | true |  
    67  ## #List
    68  
    69  
    70  ### *Params*
    71  
    72   Name | Description | Type | Required | Default 
    73   ---- | ----------- | ---- | -------- | ------- 
    74   cluster | The cluster to use. | string | true |  
    75   filter | The filter to list the resources. | [filter](#filter) | false |  
    76   resource | The resource to list. | map[string]_ | true |  
    77  
    78  
    79  #### filter
    80  
    81   Name | Description | Type | Required | Default 
    82   ---- | ----------- | ---- | -------- | ------- 
    83   namespace | The namespace to list the resources. | string | false |  
    84   matchingLabels | The label selector to filter the resources. | map[string]string | false |  
    85  
    86  
    87  ### *Returns*
    88  
    89   Name | Description | Type | Required | Default 
    90   ---- | ----------- | ---- | -------- | ------- 
    91   \- |  | {} | true |  
    92  ## #Patch
    93  
    94  
    95  ### *Params*
    96  
    97   Name | Description | Type | Required | Default 
    98   ---- | ----------- | ---- | -------- | ------- 
    99   cluster | The cluster to use. | string | true |  
   100   resource | The resource to patch. | map[string]_ | true |  
   101   patch | The patch to be applied to the resource with kubernetes patch. | [patch](#patch) | true |  
   102  
   103  
   104  #### patch
   105  
   106   Name | Description | Type | Required | Default 
   107   ---- | ----------- | ---- | -------- | ------- 
   108   type | The type of patch being provided. | "merge" or "json" or "strategic" | true |  
   109   data |  | _ | true |  
   110  
   111  
   112  ### *Returns*
   113  
   114   Name | Description | Type | Required | Default 
   115   ---- | ----------- | ---- | -------- | ------- 
   116   \- |  | {} | true |  
   117  ------
   118