Skip to content

Commit 2119d2c

Browse files
author
Nathan Thiesen
authored
Merge pull request #55 from mineiros-io/kassianh/docs/update-outputs
docs: update outputs
2 parents 5f605ed + f016116 commit 2119d2c

File tree

2 files changed

+38
-20
lines changed

2 files changed

+38
-20
lines changed

README.md

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -111,7 +111,7 @@ See [variables.tf] and [examples/] for details and use-cases.
111111
- [**`parent_team_id`**](#var-parent_team_id): *(Optional `number`)*<a name="var-parent_team_id"></a>
112112

113113
The ID of the parent team, if this is a nested team.
114-
114+
115115
Default is to create a root team without a parent.
116116

117117
- [**`ldap_dn`**](#var-ldap_dn): *(Optional `string`)*<a name="var-ldap_dn"></a>
@@ -190,27 +190,27 @@ See [variables.tf] and [examples/] for details and use-cases.
190190

191191
The following attributes are exported in the outputs of the module:
192192

193-
- **`id`**
193+
- [**`id`**](#output-id): *(`string`)*<a name="output-id"></a>
194194

195195
The ID of the team.
196196

197-
- **`name`**
197+
- [**`name`**](#output-name): *(`string`)*<a name="output-name"></a>
198198

199199
The name of the team.
200200

201-
- **`slug`**
201+
- [**`slug`**](#output-slug): *(`string`)*<a name="output-slug"></a>
202202

203203
The Slug of the team.
204204

205-
- **`team`**
205+
- [**`team`**](#output-team): *(`object(team)`)*<a name="output-team"></a>
206206

207207
The full team object.
208208

209-
- **`team_memberships`**
209+
- [**`team_memberships`**](#output-team_memberships): *(`list(team_membership)`)*<a name="output-team_memberships"></a>
210210

211211
A list of all team memberships.
212212

213-
- **`team_repositories`**
213+
- [**`team_repositories`**](#output-team_repositories): *(`list(team_repository)`)*<a name="output-team_repositories"></a>
214214

215215
A list of all team repositories.
216216

README.tfdoc.hcl

Lines changed: 31 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -253,31 +253,49 @@ section {
253253
title = "Module Outputs"
254254
content = <<-END
255255
The following attributes are exported in the outputs of the module:
256+
END
256257

257-
- **`id`**
258-
258+
output "id" {
259+
type = string
260+
description = <<-END
259261
The ID of the team.
262+
END
263+
}
260264

261-
- **`name`**
262-
265+
output "name" {
266+
type = string
267+
description = <<-END
263268
The name of the team.
269+
END
270+
}
264271

265-
- **`slug`**
266-
272+
output "slug" {
273+
type = string
274+
description = <<-END
267275
The Slug of the team.
276+
END
277+
}
268278

269-
- **`team`**
270-
279+
output "team" {
280+
type = object(team)
281+
description = <<-END
271282
The full team object.
283+
END
284+
}
272285

273-
- **`team_memberships`**
274-
286+
output "team_memberships" {
287+
type = list(team_membership)
288+
description = <<-END
275289
A list of all team memberships.
290+
END
291+
}
276292

277-
- **`team_repositories`**
278-
293+
output "team_repositories" {
294+
type = list(team_repository)
295+
description = <<-END
279296
A list of all team repositories.
280-
END
297+
END
298+
}
281299
}
282300

283301
section {

0 commit comments

Comments
 (0)