func renderSampleEvent()

in scripts/generate-docs/sample_event.go [19:39]


func renderSampleEvent(options generateOptions, packageName, dataStreamName string) (string, error) {
	eventPath := filepath.Join(options.packagesSourceDir, packageName, "data_stream", dataStreamName, sampleEventFile)

	body, err := ioutil.ReadFile(eventPath)
	if err != nil {
		return "", errors.Wrapf(err, "reading sample event file failed (path: %s)", eventPath)
	}

	formatted, err := formatSampleEvent(body)
	if err != nil {
		return "", errors.Wrapf(err, "formatting sample event file failed (path: %s)", eventPath)
	}

	var builder strings.Builder
	builder.WriteString(fmt.Sprintf("An example event for `%s` looks as following:\n\n",
		stripDataStreamFolderSuffix(dataStreamName)))
	builder.WriteString("```$json\n")
	builder.Write(formatted)
	builder.WriteString("\n```")
	return builder.String(), nil
}