Skip to content

Commit

Permalink
Added docs links (#617)
Browse files Browse the repository at this point in the history
  • Loading branch information
ezilber-akamai authored Oct 31, 2024
1 parent 5404f93 commit 55cb567
Show file tree
Hide file tree
Showing 4 changed files with 6 additions and 4 deletions.
4 changes: 2 additions & 2 deletions docs/modules/lke_type_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ List and filter on LKE Types.

| Field | Type | Required | Description |
|-----------|------|----------|------------------------------------------------------------------------------|
| `name` | <center>`str`</center> | <center>**Required**</center> | The name of the field to filter on. Valid filterable fields can be found [here](https://techdocs.akamai.com/linode-api/reference/api). |
| `name` | <center>`str`</center> | <center>**Required**</center> | The name of the field to filter on. Valid filterable fields can be found [here](https://techdocs.akamai.com/linode-api/reference/get-lke-types). |
| `values` | <center>`list`</center> | <center>**Required**</center> | A list of values to allow for this field. Fields will pass this filter if at least one of these values matches. |

## Return Values
Expand Down Expand Up @@ -75,6 +75,6 @@ List and filter on LKE Types.
}
]
```
- See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/api) for a list of returned fields
- See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-lke-types) for a list of returned fields


4 changes: 2 additions & 2 deletions docs/modules/nodebalancer_type_list.md
Original file line number Diff line number Diff line change
Expand Up @@ -42,7 +42,7 @@ List and filter on Node Balancer Types.

| Field | Type | Required | Description |
|-----------|------|----------|------------------------------------------------------------------------------|
| `name` | <center>`str`</center> | <center>**Required**</center> | The name of the field to filter on. Valid filterable fields can be found [here](https://techdocs.akamai.com/linode-api/reference/api). |
| `name` | <center>`str`</center> | <center>**Required**</center> | The name of the field to filter on. Valid filterable fields can be found [here](https://techdocs.akamai.com/linode-api/reference/get-node-balancer-types). |
| `values` | <center>`list`</center> | <center>**Required**</center> | A list of values to allow for this field. Fields will pass this filter if at least one of these values matches. |

## Return Values
Expand Down Expand Up @@ -75,6 +75,6 @@ List and filter on Node Balancer Types.
}
]
```
- See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/api) for a list of returned fields
- See the [Linode API response documentation](https://techdocs.akamai.com/linode-api/reference/get-node-balancer-types) for a list of returned fields


1 change: 1 addition & 0 deletions plugins/modules/lke_type_list.py
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@
result_display_name="LKE Types",
result_field_name="lke_types",
endpoint_template="/lke/types",
result_docs_url="https://techdocs.akamai.com/linode-api/reference/get-lke-types",
examples=docs.specdoc_examples,
result_samples=docs.result_lke_type_samples,
)
Expand Down
1 change: 1 addition & 0 deletions plugins/modules/nodebalancer_type_list.py
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,7 @@
result_display_name="Node Balancer Types",
result_field_name="nodebalancer_types",
endpoint_template="/nodebalancers/types",
result_docs_url="https://techdocs.akamai.com/linode-api/reference/get-node-balancer-types",
examples=docs.specdoc_examples,
result_samples=docs.result_nodebalancer_type_samples,
)
Expand Down

0 comments on commit 55cb567

Please sign in to comment.