f3d5e11 Extend API documentation

69 files Authored by antorres 2 years ago, Committed by frenaud 2 years ago,
69 files changed. 555 lines added. 1 lines removed.
doc/api/A6Record.md
file modified
+2 -0
doc/api/AAAARecord.md
file modified
+2 -0
doc/api/AFSDBRecord.md
file modified
+2 -0
doc/api/APLRecord.md
file modified
+2 -0
doc/api/ARecord.md
file modified
+2 -0
doc/api/AccessTime.md
file modified
+4 -0
doc/api/Any.md
file modified
+2 -0
doc/api/BinaryFile.md
file modified
+2 -0
doc/api/Bool.md
file modified
+2 -0
doc/api/Bytes.md
file modified
+6 -0
doc/api/BytesEnum.md
file modified
+2 -0
doc/api/CERTRecord.md
file modified
+2 -0
doc/api/CNAMERecord.md
file modified
+2 -0
doc/api/Certificate.md
file modified
+2 -0
doc/api/DHCIDRecord.md
file modified
+2 -0
doc/api/DLVRecord.md
file modified
+2 -0
doc/api/DNAMERecord.md
file modified
+2 -0
doc/api/DNOrURL.md
file modified
+4 -0
doc/api/DNParam.md
file modified
+2 -0
doc/api/DNSNameParam.md
file modified
+5 -0
doc/api/DNSRecord.md
file modified
+2 -0
doc/api/DSRecord.md
file modified
+2 -0
doc/api/Data.md
file modified
+6 -0
doc/api/DateTime.md
file modified
+14 -0
doc/api/Decimal.md
file modified
+7 -0
doc/api/Dict.md
file modified
+2 -0
doc/api/Enum.md
file modified
+2 -0
doc/api/File.md
file modified
+4 -0
doc/api/Flag.md
file modified
+32 -0
doc/api/ForwardRecord.md
file modified
+2 -0
doc/api/HINFORecord.md
file modified
+2 -0
doc/api/HIPRecord.md
file modified
+2 -0
doc/api/HostPassword.md
file modified
+6 -0
doc/api/IA5Str.md
file modified
+2 -0
doc/api/IPSECKEYRecord.md
file modified
+2 -0
doc/api/Int.md
file modified
+2 -0
doc/api/IntEnum.md
file modified
+2 -0
doc/api/KEYRecord.md
file modified
+2 -0
doc/api/KXRecord.md
file modified
+2 -0
doc/api/LOCRecord.md
file modified
+2 -0
doc/api/MDRecord.md
file modified
+2 -0
doc/api/MINFORecord.md
file modified
+2 -0
doc/api/MXRecord.md
file modified
+2 -0
doc/api/NAPTRRecord.md
file modified
+2 -0
doc/api/NSECRecord.md
file modified
+2 -0
doc/api/NSRecord.md
file modified
+2 -0
doc/api/NXTRecord.md
file modified
+2 -0
doc/api/Number.md
file modified
+2 -0
doc/api/OTPTokenKey.md
file modified
+2 -0
doc/api/PTRRecord.md
file modified
+2 -0
doc/api/Password.md
file modified
+2 -0
doc/api/Principal.md
file modified
+2 -0
doc/api/RPRecord.md
file modified
+2 -0
doc/api/RRSIGRecord.md
file modified
+2 -0
doc/api/SIGRecord.md
file modified
+2 -0
doc/api/SPFRecord.md
file modified
+2 -0
doc/api/SRVRecord.md
file modified
+2 -0
doc/api/SSHFPRecord.md
file modified
+2 -0
doc/api/Str.md
file modified
+9 -0
doc/api/StrEnum.md
file modified
+14 -0
doc/api/TLSARecord.md
file modified
+2 -0
doc/api/TXTRecord.md
file modified
+2 -0
doc/api/URIRecord.md
file modified
+2 -0
doc/api/UnsupportedDNSRecord.md
file modified
+3 -0
doc/api/access_control_guide.md
file added
+66
doc/api/api_cli_differences.md
file added
+47
doc/api/basic_usage.md
file modified
+88 -1
doc/api/guides.rst
file modified
+3 -0
doc/api/jsonrpc_usage.md
file added
+135
    Extend API documentation
    
    This includes:
    
    * Section about command/param info in usage guide
    * Section about metadata retrieval in usage guide
    * Guide about differences between CLI and API
    * Access control guide (management of roles, privileges and
      permissions).
    * Guide about API contexts
    * JSON-RPC usage guide and JSON-to-Python conversion
    * Notes about types in API Reference
    
    Signed-off-by: Antonio Torres <antorres@redhat.com>
    Reviewed-By: Alexander Bokovoy <abokovoy@redhat.com>
    Reviewed-By: Rob Crittenden <rcritten@redhat.com>
    
        
file modified
+2 -0
file modified
+2 -0
file modified
+2 -0
file modified
+2 -0
file modified
+2 -0
file modified
+4 -0
file modified
+2 -0
file modified
+2 -0
file modified
+2 -0
file modified
+6 -0
file modified
+2 -0
file modified
+2 -0
file modified
+2 -0
file modified
+2 -0
file modified
+2 -0
file modified
+2 -0
file modified
+2 -0
file modified
+4 -0
file modified
+2 -0
file modified
+5 -0
file modified
+2 -0
file modified
+2 -0
file modified
+6 -0
file modified
+14 -0
file modified
+7 -0
file modified
+2 -0
file modified
+2 -0
file modified
+4 -0
file modified
+32 -0
file modified
+2 -0
file modified
+2 -0
file modified
+2 -0
file modified
+6 -0
file modified
+2 -0
file modified
+2 -0
file modified
+2 -0
file modified
+2 -0
file modified
+2 -0
file modified
+2 -0
file modified
+2 -0
file modified
+2 -0
file modified
+2 -0
file modified
+2 -0
file modified
+2 -0
file modified
+2 -0
file modified
+2 -0
file modified
+2 -0
file modified
+2 -0
file modified
+2 -0
file modified
+2 -0
file modified
+2 -0
file modified
+2 -0
file modified
+2 -0
file modified
+2 -0
file modified
+2 -0
file modified
+2 -0
file modified
+2 -0
file modified
+2 -0
file modified
+9 -0
file modified
+14 -0
file modified
+2 -0
file modified
+2 -0
file modified
+2 -0
file modified
+88 -1
file modified
+3 -0