From b8af4ec9eb1307545e63b14935ff1e9a514a28ad Mon Sep 17 00:00:00 2001 From: barriejc <73184215+barriejc@users.noreply.github.com> Date: Fri, 13 Jun 2025 14:18:44 -0700 Subject: [PATCH] fix definition example in artifact.mdx Reversed `name` and `artifact_name` in the example and updated the explanations below. --- docs/docs/guides/artifact.mdx | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/docs/docs/guides/artifact.mdx b/docs/docs/guides/artifact.mdx index f576ea3..11bc421 100644 --- a/docs/docs/guides/artifact.mdx +++ b/docs/docs/guides/artifact.mdx @@ -71,8 +71,8 @@ Add the following contents to the end of the `.infrahub.yml` file at the root of ```yaml artifact_definitions: - - name: "device_configuration" - artifact_name: "Device configuration file" + - name: "Device configuration file" + artifact_name: "device_configuration" parameters: name: "name__value" content_type: "text/plain" @@ -82,7 +82,8 @@ artifact_definitions: This defines an artifact with the following properties: -- **name**: a unique name for the artifact +- **name**: a descriptive name for the artifact definition +- **artifact_name**: a unique name for the artifact (no spaces) - **parameters**: the parameter to pass to the transformation GraphQL query, in this case this we will pass the name of the object (device) as the name parameter - **content type**: the content type for the resulting artifact - **targets**: the name of a group of which the members will be a target for this artifact