mirror of
https://github.com/ansible-collections/community.routeros.git
synced 2025-06-24 10:48:49 +02:00
Add api_info and api_modify modules (#91)
* Add api_info and api_modify modules. * Add documentation, and cross-references for the modules. * Bump version added for new modules. * Ignore dynamic entries. Allow _info module to return them. * Document behavior for dynamic entries. * Update license headers. * Add disclaimer. * Improve formulation. * Auto-generate path list in DOCUMENTATION. * Add test to make sure lists have been generated automatically.
This commit is contained in:
parent
1abaa8e7ca
commit
2911710f1b
21 changed files with 3277 additions and 6 deletions
46
update-docs.py
Executable file
46
update-docs.py
Executable file
|
@ -0,0 +1,46 @@
|
|||
#!/usr/bin/env python3
|
||||
# -*- coding: utf-8 -*-
|
||||
|
||||
# Copyright (c) 2022, Felix Fontein (@felixfontein) <felix@fontein.de>
|
||||
# GNU General Public License v3.0+ (see LICENSES/GPL-3.0-or-later.txt or https://www.gnu.org/licenses/gpl-3.0.txt)
|
||||
# SPDX-License-Identifier: GPL-3.0-or-later
|
||||
|
||||
'''
|
||||
Updates DOCUMENTATION of modules using module_utils._api_data with the correct list of supported paths.
|
||||
'''
|
||||
|
||||
import os
|
||||
|
||||
from plugins.module_utils._api_data import (
|
||||
PATHS,
|
||||
join_path,
|
||||
)
|
||||
|
||||
|
||||
MODULES = [
|
||||
'plugins/modules/api_info.py',
|
||||
'plugins/modules/api_modify.py',
|
||||
]
|
||||
|
||||
|
||||
def update_file(file, begin_line, end_line, choice_line, path_choices):
|
||||
with open(file, 'r', encoding='utf-8') as f:
|
||||
lines = f.read().splitlines()
|
||||
begin_index = lines.index(begin_line)
|
||||
end_index = lines.index(end_line, begin_index + 1)
|
||||
new_lines = lines[:begin_index + 1] + [choice_line.format(choice=choice) for choice in path_choices] + lines[end_index:]
|
||||
if lines != new_lines:
|
||||
print(f'{file} has been updated')
|
||||
with open(file, 'w', encoding='utf-8') as f:
|
||||
f.write('\n'.join(new_lines) + '\n')
|
||||
|
||||
|
||||
def main():
|
||||
path_choices = sorted([join_path(path) for path, path_info in PATHS.items() if path_info.fully_understood])
|
||||
|
||||
for file in MODULES:
|
||||
update_file(file, ' # BEGIN PATH LIST', ' # END PATH LIST', ' - {choice}', path_choices)
|
||||
|
||||
|
||||
if __name__ == '__main__':
|
||||
main()
|
Loading…
Add table
Add a link
Reference in a new issue