Skip to content

Cherry-pick #9269 to 6.x: Fix alias field generation in docs #9498

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Dec 11, 2018
Merged

Cherry-pick #9269 to 6.x: Fix alias field generation in docs #9498

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
13 changes: 7 additions & 6 deletions libbeat/scripts/generate_fields_docs.py
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -39,12 +39,12 @@ def document_fields(output, section, sections, path):
document_field(output, field, newpath)


def document_field(output, field, path):
def document_field(output, field, field_path):

if "path" not in field:
field["path"] = path
if "field_path" not in field:
field["field_path"] = field_path

output.write("*`{}`*::\n+\n--\n".format(field["path"]))
output.write("*`{}`*::\n+\n--\n".format(field["field_path"]))

if "deprecated" in field:
output.write("\ndeprecated[{}]\n\n".format(field["deprecated"]))
Expand All @@ -57,7 +57,8 @@ def document_field(output, field, path):
output.write("format: {}\n\n".format(field["format"]))
if "required" in field:
output.write("required: {}\n\n".format(field["required"]))

if "path" in field:
output.write("alias to: {}\n\n".format(field["path"]))
if "description" in field:
output.write("{}\n\n".format(field["description"]))

Expand All @@ -71,7 +72,7 @@ def document_field(output, field, path):

if "multi_fields" in field:
for subfield in field["multi_fields"]:
document_field(output, subfield, path + "." + subfield["name"])
document_field(output, subfield, field_path + "." + subfield["name"])
output.write("--\n\n")


Expand Down