Skip to content

Commit

Permalink
Add alternative docs when description is missing (#7)
Browse files Browse the repository at this point in the history
  • Loading branch information
tflibsonnet-ci authored Dec 19, 2022
1 parent 9a24b21 commit 6acbdac
Show file tree
Hide file tree
Showing 74 changed files with 389 additions and 389 deletions.
6 changes: 3 additions & 3 deletions 2.x/_gen/data/administrative_unit.libsonnet
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet');
local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet');
{
'#':: d.pkg(name='administrative_unit', url='', help='`administrative_unit` represents the `azuread_administrative_unit` Terraform data source.\n\n\n\nThis package contains functions and utilities for setting up the data source using Jsonnet code.\n'),
'#new':: d.fn(help="\n`azuread.data.administrative_unit.new` injects a new `data_azuread_administrative_unit` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.data.administrative_unit.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.data.administrative_unit` using the reference:\n\n $._ref.data_azuread_administrative_unit.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_azuread_administrative_unit.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `display_name` (`string`): The display name for the administrative unit When `null`, the `display_name` field will be omitted from the resulting object.\n - `object_id` (`string`): The object ID of the administrative unit When `null`, the `object_id` field will be omitted from the resulting object.\n - `timeouts` (`obj`): When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.data.administrative_unit.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]),
'#new':: d.fn(help="\n`azuread.data.administrative_unit.new` injects a new `data_azuread_administrative_unit` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.data.administrative_unit.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.data.administrative_unit` using the reference:\n\n $._ref.data_azuread_administrative_unit.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_azuread_administrative_unit.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `display_name` (`string`): The display name for the administrative unit When `null`, the `display_name` field will be omitted from the resulting object.\n - `object_id` (`string`): The object ID of the administrative unit When `null`, the `object_id` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting data source block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.data.administrative_unit.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]),
new(
dataSrcLabel,
display_name=null,
Expand All @@ -15,7 +15,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet');
attrs=self.newAttrs(display_name=display_name, object_id=object_id, timeouts=timeouts),
_meta=_meta
),
'#newAttrs':: d.fn(help='\n`azuread.data.administrative_unit.newAttrs` constructs a new object with attributes and blocks configured for the `administrative_unit`\nTerraform data source.\n\nUnlike [azuread.data.administrative_unit.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `display_name` (`string`): The display name for the administrative unit When `null`, the `display_name` field will be omitted from the resulting object.\n - `object_id` (`string`): The object ID of the administrative unit When `null`, the `object_id` field will be omitted from the resulting object.\n - `timeouts` (`obj`): When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.data.administrative_unit.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `administrative_unit` data source into the root Terraform configuration.\n', args=[]),
'#newAttrs':: d.fn(help='\n`azuread.data.administrative_unit.newAttrs` constructs a new object with attributes and blocks configured for the `administrative_unit`\nTerraform data source.\n\nUnlike [azuread.data.administrative_unit.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `display_name` (`string`): The display name for the administrative unit When `null`, the `display_name` field will be omitted from the resulting object.\n - `object_id` (`string`): The object ID of the administrative unit When `null`, the `object_id` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.data.administrative_unit.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `administrative_unit` data source into the root Terraform configuration.\n', args=[]),
newAttrs(
display_name=null,
object_id=null,
Expand All @@ -26,7 +26,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet');
timeouts: timeouts,
}),
timeouts:: {
'#new':: d.fn(help='\n`azuread.administrative_unit.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object.\n - `update` (`string`): When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]),
'#new':: d.fn(help='\n`azuread.administrative_unit.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `create` (`string`): Set the `create` field on the resulting object. When `null`, the `create` field will be omitted from the resulting object.\n - `delete` (`string`): Set the `delete` field on the resulting object. When `null`, the `delete` field will be omitted from the resulting object.\n - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object.\n - `update` (`string`): Set the `update` field on the resulting object. When `null`, the `update` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]),
new(
create=null,
delete=null,
Expand Down
6 changes: 3 additions & 3 deletions 2.x/_gen/data/application.libsonnet
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ local tf = (import 'github.com/tf-libsonnet/core/main.libsonnet');
local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet');
{
'#':: d.pkg(name='application', url='', help='`application` represents the `azuread_application` Terraform data source.\n\n\n\nThis package contains functions and utilities for setting up the data source using Jsonnet code.\n'),
'#new':: d.fn(help="\n`azuread.data.application.new` injects a new `data_azuread_application` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.data.application.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.data.application` using the reference:\n\n $._ref.data_azuread_application.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_azuread_application.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `application_id` (`string`): The Application ID (also called Client ID) When `null`, the `application_id` field will be omitted from the resulting object.\n - `display_name` (`string`): The display name for the application When `null`, the `display_name` field will be omitted from the resulting object.\n - `object_id` (`string`): The application\u0026#39;s object ID When `null`, the `object_id` field will be omitted from the resulting object.\n - `timeouts` (`obj`): When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.data.application.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]),
'#new':: d.fn(help="\n`azuread.data.application.new` injects a new `data_azuread_application` Terraform `data source`\nblock into the root module document.\n\nAdditionally, this inserts a private function into the `_ref` attribute that generates references to attributes of the\nresource. For example, if you added a new instance to the root using:\n\n # arguments omitted for brevity\n azuread.data.application.new('some_id')\n\nYou can get the reference to the `id` field of the created `azuread.data.application` using the reference:\n\n $._ref.data_azuread_application.some_id.get('id')\n\nThis is the same as directly entering `\"${ data_azuread_application.some_id.id }\"` as the value.\n\nNOTE: if you are chaining multiple resources together in a merge operation, you may not be able to use `super`, `self`,\nor `$` to refer to the root object. Instead, make an explicit outer object using `local`.\n\n**Args**:\n - `dataSrcLabel` (`string`): The name label of the block.\n - `application_id` (`string`): The Application ID (also called Client ID) When `null`, the `application_id` field will be omitted from the resulting object.\n - `display_name` (`string`): The display name for the application When `null`, the `display_name` field will be omitted from the resulting object.\n - `object_id` (`string`): The application\u0026#39;s object ID When `null`, the `object_id` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting data source block. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.data.application.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n- A mixin object that injects the new data source into the root Terraform configuration.\n", args=[]),
new(
dataSrcLabel,
application_id=null,
Expand All @@ -21,7 +21,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet');
),
_meta=_meta
),
'#newAttrs':: d.fn(help='\n`azuread.data.application.newAttrs` constructs a new object with attributes and blocks configured for the `application`\nTerraform data source.\n\nUnlike [azuread.data.application.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `application_id` (`string`): The Application ID (also called Client ID) When `null`, the `application_id` field will be omitted from the resulting object.\n - `display_name` (`string`): The display name for the application When `null`, the `display_name` field will be omitted from the resulting object.\n - `object_id` (`string`): The application's object ID When `null`, the `object_id` field will be omitted from the resulting object.\n - `timeouts` (`obj`): When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.data.application.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `application` data source into the root Terraform configuration.\n', args=[]),
'#newAttrs':: d.fn(help='\n`azuread.data.application.newAttrs` constructs a new object with attributes and blocks configured for the `application`\nTerraform data source.\n\nUnlike [azuread.data.application.new](#fn-new), this function will not inject the `data source`\nblock into the root Terraform document. Instead, this must be passed in as the `attrs` argument for the\n[tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) function to build a complete block.\n\nThis is most useful when you need to preprocess the attributes with functions, conditional, or looping logic prior to\ninjecting into a complete block.\n\n**Args**:\n - `application_id` (`string`): The Application ID (also called Client ID) When `null`, the `application_id` field will be omitted from the resulting object.\n - `display_name` (`string`): The display name for the application When `null`, the `display_name` field will be omitted from the resulting object.\n - `object_id` (`string`): The application's object ID When `null`, the `object_id` field will be omitted from the resulting object.\n - `timeouts` (`obj`): Set the `timeouts` field on the resulting object. When `null`, the `timeouts` sub block will be omitted from the resulting object. When setting the sub block, it is recommended to construct the object using the [azuread.data.application.timeouts.new](#fn-timeoutsnew) constructor.\n\n**Returns**:\n - An attribute object that can be used with [tf.withData](https://github.com/tf-libsonnet/core/tree/main/docs#fn-withdata) to construct a new `application` data source into the root Terraform configuration.\n', args=[]),
newAttrs(
application_id=null,
display_name=null,
Expand All @@ -34,7 +34,7 @@ local d = (import 'github.com/jsonnet-libs/docsonnet/doc-util/main.libsonnet');
timeouts: timeouts,
}),
timeouts:: {
'#new':: d.fn(help='\n`azuread.application.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `read` (`string`): When `null`, the `read` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]),
'#new':: d.fn(help='\n`azuread.application.timeouts.new` constructs a new object with attributes and blocks configured for the `timeouts`\nTerraform sub block.\n\n\n\n**Args**:\n - `read` (`string`): Set the `read` field on the resulting object. When `null`, the `read` field will be omitted from the resulting object.\n\n**Returns**:\n - An attribute object that represents the `timeouts` sub block.\n', args=[]),
new(
read=null
):: std.prune(a={
Expand Down
Loading

0 comments on commit 6acbdac

Please sign in to comment.