refactor base documentation (#7)

Author: cmeissner

README.md

@@ -34,10 +34,10 @@ Current documentation can be found on [readthedocs.io](https://phpipam-ansible-m
 If you have installed the collection you can facilitate `ansible-doc` to display documentation for a given module.
 
 ```bash
-$ ansible-doc codeaffen.phpipam.subnet
-> SUBNET    (/home/user/ansible_collections/codeaffen/phpipam/plugins/modules/subnet.py)
+$ ansible-doc codeaffen.phpipam.section
+> SECTION    (/home/user/ansible_collections/codeaffen/phpipam/plugins/modules/section.py)
 
-        create, update and delete subnets
+        create, update and delete sections
 
   * This module is maintained by The Ansible Community
 OPTIONS (= is mandatory):
@@ -47,28 +47,84 @@ OPTIONS (= is mandatory):
         [Default: ansible]
         type: str
 
-= cidr
-        Subnet in CIDR notation
+- description
+        Short describtive text
+        [Default: None]
+        type: str
+
+- dns_resolver
+        The NS resolver to be used for this section
+        [Default: (null)]
+        type: str
 
+- list_order
+        Order in sections list view
+        [Default: (null)]
+        type: int
+
+= name
+        Name of the section
+
+        example: customer_1
+        type: str
+
+- parent
+        Name of the parent section
+        (Aliases: master, master_section)[Default: None]
         type: str
 
 = password
         Password of the user to access phpIPAM server
 
         type: str
 
+- permissions
+        JSON object that represent the permissions for each user
+        [Default: None]
+        type: json
+
 = server_url
         URL of the phpIPAM server
 
         type: str
 
+- show_supernets_only
+        Show only supernets in sebnet list view
+        [Default: False]
+        type: bool
+
+- show_vlan
+        Show/hide VLANs in subnet list view
+        [Default: False]
+        type: bool
+
+- show_vrf
+        Show/hide VRFs in subnet list view
+        [Default: False]
+        type: bool
+
+- state
+        State of the entity
+        (Choices: present, absent)[Default: present]
+        type: str
+
+- strict_mode
+        If set to true, consistency of subnets and IP addresses will be checked
+        [Default: False]
+        type: bool
+
+- subnet_ordering
+        How to order subnets within this section
+        [Default: subnet,asc]
+        type: str
+
 = username
         Username to access phpIPAM server
 
         type: str
 
 
-REQUIREMENTS:  phpipam-client
+REQUIREMENTS:  inflection, ipaddress, phpypam
 
 AUTHOR: Christian Meißner (@cmeissner)
         METADATA:
@@ -79,26 +135,24 @@ AUTHOR: Christian Meißner (@cmeissner)
 
 EXAMPLES:
 
-- name: "Create a subnet"
-  cmeissner.phpipam.subnet:
+- name: "Create a section"
+  codeaffen.phpipam.section:
     username: "admin"
     password: "s3cr3t"
     server_url: "https://ipam.example.com"
-    cidr: "192.0.2.128/25"
+    name: "EXAMPLE INC"
+    description: "Section for company EXAMPLE INC"
     state: present
 
-
-RETURN VALUES:
-
-entity:
-  description: Final state of the affected entities grouped by their type.
-  returned: success
-  type: dict
-  contains:
-    subnets:
-      description: List of subnets.
-      type: list
-      elements: dicts
+- name: "Create a section with parent"
+  codeaffen.phpipam.section:
+    username: "admin"
+    password: "s3cr3t"
+    server_url: "https://ipam.example.com"
+    name: "DEVOPS department"
+    parent: "EXAMPLE INC"
+    description: "Section for devops department in EXAMPLE INC"
+    state: present
 ```
 
 ### repository folder
@@ -109,5 +163,6 @@ A last option to read the docs is the [docs](docs) folder in this repository.
 
 The following dependencies have to be fulfiled by the Ansible controller.
 
-* phpipam-client
-* PyYAML
+* inflection
+* ipaddress
+* phpypam

doc_fragments/phpipam.py

@@ -21,7 +21,7 @@ class ModuleDocFragment(object):
   # phpIPAM documentation fragment
   DOCUMENTATION = '''
 requirements:
-  - phpipam-client
+  - phpypam
 options:
   server_url:
     description: URL of the phpIPAM server

docs/CNAME

@@ -22,10 +22,9 @@ class ModuleDocFragment(object):
     # phpIPAM documentation fragment
     DOCUMENTATION = '''
 requirements:
-    - phpipam-client
-    - json
     - inflection
-    - PyYAML
+    - ipaddress
+    - phpypam
 options:
     server_url:
         description: URL of the phpIPAM server

plugins/doc_fragments/phpipam.py

@@ -1,3 +1,3 @@
-phpypam
-PyYAML
 inflection
+ipaddress
+phpypam