Switched default branch to main; updated comments for REST methods

Signed-off-by: Mike Raineri <[email protected]>

Author: mraineri

.github/workflows/main.yml

@@ -77,7 +77,7 @@ jobs:
         git config user.email "<>"
         git add CHANGELOG.md setup.py src/redfish/__init__.py
         git commit -s -m "${{github.event.inputs.version}} versioning"
-        git push origin master
+        git push origin main
     - name: Make the release
       env:
         GITHUB_TOKEN: ${{secrets.GITHUB_TOKEN}}

README.rst

@@ -6,7 +6,7 @@ python-redfish-library
 .. image:: https://img.shields.io/github/release/DMTF/python-redfish-library.svg?maxAge=2592000
     :target: https://github.com/DMTF/python-redfish-library/releases
 .. image:: https://img.shields.io/badge/License-BSD%203--Clause-blue.svg
-    :target: https://raw.githubusercontent.com/DMTF/python-redfish-library/master/LICENSE
+    :target: https://raw.githubusercontent.com/DMTF/python-redfish-library/main/LICENSE
 .. image:: https://img.shields.io/pypi/pyversions/redfish.svg?maxAge=2592000
     :target: https://pypi.python.org/pypi/redfish
 
@@ -206,4 +206,4 @@ Copyright and License
 
 Copyright Notice:
 Copyright 2016-2022 DMTF. All rights reserved.
-License: BSD 3-Clause License. For full text see link: `https://github.com/DMTF/python-redfish-library/blob/master/LICENSE.md <https://github.com/DMTF/python-redfish-library/blob/master/LICENSE.md>`_
+License: BSD 3-Clause License. For full text see link: `https://github.com/DMTF/python-redfish-library/blob/main/LICENSE.md <https://github.com/DMTF/python-redfish-library/blob/main/LICENSE.md>`_

examples/context_manager.py

@@ -1,7 +1,7 @@
 # Copyright Notice:
 # Copyright 2016-2021 DMTF. All rights reserved.
 # License: BSD 3-Clause License. For full text see link:
-# https://github.com/DMTF/python-redfish-library/blob/master/LICENSE.md
+# https://github.com/DMTF/python-redfish-library/blob/main/LICENSE.md
 
 import sys
 import redfish

examples/discover.py

@@ -1,7 +1,7 @@
 # Copyright Notice:
 # Copyright 2016-2021 DMTF. All rights reserved.
 # License: BSD 3-Clause License. For full text see link:
-# https://github.com/DMTF/python-redfish-library/blob/master/LICENSE.md
+# https://github.com/DMTF/python-redfish-library/blob/main/LICENSE.md
 
 import redfish
 

examples/multipart_push.py

@@ -1,7 +1,7 @@
 # Copyright Notice:
 # Copyright 2016-2021 DMTF. All rights reserved.
 # License: BSD 3-Clause License. For full text see link:
-# https://github.com/DMTF/python-redfish-library/blob/master/LICENSE.md
+# https://github.com/DMTF/python-redfish-library/blob/main/LICENSE.md
 
 import sys
 import json

examples/quickstart.py

@@ -1,7 +1,7 @@
 # Copyright Notice:
 # Copyright 2016-2021 DMTF. All rights reserved.
 # License: BSD 3-Clause License. For full text see link:
-# https://github.com/DMTF/python-redfish-library/blob/master/LICENSE.md
+# https://github.com/DMTF/python-redfish-library/blob/main/LICENSE.md
 
 import sys
 import redfish

examples/quickstart_rmc.py

@@ -1,7 +1,7 @@
 # Copyright Notice:
 # Copyright 2016-2021 DMTF. All rights reserved.
 # License: BSD 3-Clause License. For full text see link:
-# https://github.com/DMTF/python-redfish-library/blob/master/LICENSE.md
+# https://github.com/DMTF/python-redfish-library/blob/main/LICENSE.md
 
 import os
 import sys

setup.py

@@ -1,7 +1,7 @@
 # Copyright Notice:
 # Copyright 2016-2021 DMTF. All rights reserved.
 # License: BSD 3-Clause License. For full text see link:
-# https://github.com/DMTF/python-redfish-library/blob/master/LICENSE.md
+# https://github.com/DMTF/python-redfish-library/blob/main/LICENSE.md
 
 from setuptools import setup, find_packages
 from codecs import open

src/redfish/__init__.py

@@ -1,7 +1,7 @@
 # Copyright Notice:
 # Copyright 2016-2021 DMTF. All rights reserved.
 # License: BSD 3-Clause License. For full text see link:
-# https://github.com/DMTF/python-redfish-library/blob/master/LICENSE.md
+# https://github.com/DMTF/python-redfish-library/blob/main/LICENSE.md
 
 """ Redfish restful library """
 

src/redfish/discovery/__init__.py

@@ -1,4 +1,4 @@
 # Copyright Notice:
 # Copyright 2016-2021 DMTF. All rights reserved.
 # License: BSD 3-Clause License. For full text see link:
-# https://github.com/DMTF/python-redfish-library/blob/master/LICENSE.md
+# https://github.com/DMTF/python-redfish-library/blob/main/LICENSE.md

src/redfish/discovery/discovery.py

@@ -1,7 +1,7 @@
 # Copyright Notice:
 # Copyright 2016-2021 DMTF. All rights reserved.
 # License: BSD 3-Clause License. For full text see link:
-# https://github.com/DMTF/python-redfish-library/blob/master/LICENSE.md
+# https://github.com/DMTF/python-redfish-library/blob/main/LICENSE.md
 
 # -*- coding: utf-8 -*-
 """Discovers Redfish services"""

src/redfish/rest/__init__.py

@@ -1,6 +1,6 @@
 # Copyright Notice:
 # Copyright 2016-2021 DMTF. All rights reserved.
 # License: BSD 3-Clause License. For full text see link:
-# https://github.com/DMTF/python-redfish-library/blob/master/LICENSE.md
+# https://github.com/DMTF/python-redfish-library/blob/main/LICENSE.md
 
 """ Utilities to simplify interaction with Redfish data """

src/redfish/rest/v1.py

@@ -1,7 +1,7 @@
 # Copyright Notice:
 # Copyright 2016-2021 DMTF. All rights reserved.
 # License: BSD 3-Clause License. For full text see link:
-# https://github.com/DMTF/python-redfish-library/blob/master/LICENSE.md
+# https://github.com/DMTF/python-redfish-library/blob/main/LICENSE.md
 
 # -*- coding: utf-8 -*-
 """Helper module for working with REST technology."""
@@ -610,12 +610,12 @@ def get_root_object(self):
     def get(self, path, args=None, headers=None):
         """Perform a GET request
 
-        :param path: the URL path.
-        :type path: str.
-        :param args: the arguments to get.
-        :type args: dict.
-        :param headers: dict of headers to be appended.
-        :type headers: dict.
+        :param path: The URI to access
+        :type path: str
+        :param args: The query parameters to provide with the request
+        :type args: dict, optional
+        :param headers: Additional HTTP headers to provide in the request
+        :type headers: dict, optional
         :returns: returns a rest request with method 'Get'
 
         """
@@ -630,12 +630,12 @@ def get(self, path, args=None, headers=None):
     def head(self, path, args=None, headers=None):
         """Perform a HEAD request
 
-        :param path: the URL path.
-        :type path: str.
-        :param args: the arguments to get.
-        :type args: dict.
-        :param headers: dict of headers to be appended.
-        :type headers: dict.
+        :param path: The URI to access
+        :type path: str
+        :param args: The query parameters to provide with the request
+        :type args: dict, optional
+        :param headers: Additional HTTP headers to provide in the request
+        :type headers: dict, optional
         :returns: returns a rest request with method 'Head'
 
         """
@@ -645,14 +645,14 @@ def head(self, path, args=None, headers=None):
     def post(self, path, args=None, body=None, headers=None):
         """Perform a POST request
 
-        :param path: the URL path.
-        :type path: str.
-        :param args: the arguments to post.
-        :type args: dict.
-        :param body: the body to the sent.
-        :type body: str.
-        :param headers: dict of headers to be appended.
-        :type headers: dict.
+        :param path: The URI to access
+        :type path: str
+        :param args: The query parameters to provide with the request
+        :type args: dict, optional
+        :param body: The request body to provide; use a dict for a JSON body, list for multipart forms, bytes for an octet stream, or str for an unstructured request
+        :type body: dict or list or bytes or str, optional
+        :param headers: Additional HTTP headers to provide in the request
+        :type headers: dict, optional
         :returns: returns a rest request with method 'Post'
 
         """
@@ -662,14 +662,14 @@ def post(self, path, args=None, body=None, headers=None):
     def put(self, path, args=None, body=None, headers=None):
         """Perform a PUT request
 
-        :param path: the URL path.
-        :type path: str.
-        :param args: the arguments to put.
-        :type args: dict.
-        :param body: the body to the sent.
-        :type body: str.
-        :param headers: dict of headers to be appended.
-        :type headers: dict.
+        :param path: The URI to access
+        :type path: str
+        :param args: The query parameters to provide with the request
+        :type args: dict, optional
+        :param body: The request body to provide; use a dict for a JSON body, list for multipart forms, bytes for an octet stream, or str for an unstructured request
+        :type body: dict or list or bytes or str, optional
+        :param headers: Additional HTTP headers to provide in the request
+        :type headers: dict, optional
         :returns: returns a rest request with method 'Put'
 
         """
@@ -679,14 +679,14 @@ def put(self, path, args=None, body=None, headers=None):
     def patch(self, path, args=None, body=None, headers=None):
         """Perform a PUT request
 
-        :param path: the URL path.
-        :type path: str.
-        :param args: the arguments to patch.
-        :type args: dict.
-        :param body: the body to the sent.
-        :type body: str.
-        :param headers: dict of headers to be appended.
-        :type headers: dict.
+        :param path: The URI to access
+        :type path: str
+        :param args: The query parameters to provide with the request
+        :type args: dict, optional
+        :param body: The request body to provide; use a dict for a JSON body, list for multipart forms, bytes for an octet stream, or str for an unstructured request
+        :type body: dict or list or bytes or str, optional
+        :param headers: Additional HTTP headers to provide in the request
+        :type headers: dict, optional
         :returns: returns a rest request with method 'Patch'
 
         """
@@ -696,12 +696,12 @@ def patch(self, path, args=None, body=None, headers=None):
     def delete(self, path, args=None, headers=None):
         """Perform a DELETE request
 
-        :param path: the URL path.
-        :type path: str.
-        :param args: the arguments to delete.
-        :type args: dict.
-        :param headers: dict of headers to be appended.
-        :type headers: dict.
+        :param path: The URI to access
+        :type path: str
+        :param args: The query parameters to provide with the request
+        :type args: dict, optional
+        :param body: The request body to provide; use a dict for a JSON body, list for multipart forms, bytes for an octet stream, or str for an unstructured request
+        :type headers: dict, optional
         :returns: returns a rest request with method 'Delete'
 
         """
@@ -733,18 +733,18 @@ def _rest_request(self, path, method='GET', args=None, body=None,
                       headers=None, allow_redirects=True):
         """Rest request main function
 
-        :param path: path within tree
+        :param path: The URI to access
         :type path: str
-        :param method: method to be implemented
-        :type method: str
-        :param args: the arguments for method
-        :type args: dict
-        :param body: body payload for the rest call
-        :type body: dict
-        :param headers: provide additional headers
-        :type headers: dict
-        :param allow_redirects: controls whether redirects are followed
-        :type allow_redirects: bool
+        :param method: The HTTP method to invoke on the URI; GET if not provided
+        :type method: str, optional
+        :param args: The query parameters to provide with the request
+        :type args: dict, optional
+        :param body: The request body to provide; use a dict for a JSON body, list for multipart forms, bytes for an octet stream, or str for an unstructured request
+        :type body: dict or list or bytes or str, optional
+        :param headers: Additional HTTP headers to provide in the request
+        :type headers: dict, optional
+        :param allow_redirects: Controls whether redirects are followed
+        :type allow_redirects: bool, optional
         :returns: returns a RestResponse object
 
         """

src/redfish/ris/__init__.py

@@ -1,7 +1,7 @@
 # Copyright Notice:
 # Copyright 2016-2021 DMTF. All rights reserved.
 # License: BSD 3-Clause License. For full text see link:
-# https://github.com/DMTF/python-redfish-library/blob/master/LICENSE.md
+# https://github.com/DMTF/python-redfish-library/blob/main/LICENSE.md
 
 # -*- coding: utf-8 -*-
 """

src/redfish/ris/config.py

@@ -1,7 +1,7 @@
 # Copyright Notice:
 # Copyright 2016-2021 DMTF. All rights reserved.
 # License: BSD 3-Clause License. For full text see link:
-# https://github.com/DMTF/python-redfish-library/blob/master/LICENSE.md
+# https://github.com/DMTF/python-redfish-library/blob/main/LICENSE.md
 
 # -*- coding: utf-8 -*-
 """Module for working with global configuration options."""

src/redfish/ris/ris.py

@@ -1,7 +1,7 @@
 # Copyright Notice:
 # Copyright 2016-2021 DMTF. All rights reserved.
 # License: BSD 3-Clause License. For full text see link:
-# https://github.com/DMTF/python-redfish-library/blob/master/LICENSE.md
+# https://github.com/DMTF/python-redfish-library/blob/main/LICENSE.md
 
 # -*- coding: utf-8 -*-
 """RIS implementation"""

src/redfish/ris/rmc.py

@@ -1,7 +1,7 @@
 # Copyright Notice:
 # Copyright 2016-2021 DMTF. All rights reserved.
 # License: BSD 3-Clause License. For full text see link:
-# https://github.com/DMTF/python-redfish-library/blob/master/LICENSE.md
+# https://github.com/DMTF/python-redfish-library/blob/main/LICENSE.md
 
 # -*- coding: utf-8 -*-
 """RMC implementation """

src/redfish/ris/rmc_helper.py

@@ -1,7 +1,7 @@
 # Copyright Notice:
 # Copyright 2016-2021 DMTF. All rights reserved.
 # License: BSD 3-Clause License. For full text see link:
-# https://github.com/DMTF/python-redfish-library/blob/master/LICENSE.md
+# https://github.com/DMTF/python-redfish-library/blob/main/LICENSE.md
 
 # -*- coding: utf-8 -*-
 """RMC helper implementation"""

src/redfish/ris/sharedtypes.py

@@ -1,7 +1,7 @@
 # Copyright Notice:
 # Copyright 2016-2021 DMTF. All rights reserved.
 # License: BSD 3-Clause License. For full text see link:
-# https://github.com/DMTF/python-redfish-library/blob/master/LICENSE.md
+# https://github.com/DMTF/python-redfish-library/blob/main/LICENSE.md
 
 # -*- coding: utf-8 -*-
 """ Shared types used in this module """

tests/__init__.py

@@ -1,4 +1,4 @@
 # Copyright Notice:
 # Copyright 2016-2021 DMTF. All rights reserved.
 # License: BSD 3-Clause License. For full text see link:
-# https://github.com/DMTF/python-redfish-library/blob/master/LICENSE.md
+# https://github.com/DMTF/python-redfish-library/blob/main/LICENSE.md

tests/discovery/__init__.py

@@ -1,4 +1,4 @@
 # Copyright Notice:
 # Copyright 2016-2021 DMTF. All rights reserved.
 # License: BSD 3-Clause License. For full text see link:
-# https://github.com/DMTF/python-redfish-library/blob/master/LICENSE.md
+# https://github.com/DMTF/python-redfish-library/blob/main/LICENSE.md

tests/discovery/test_discovery.py

@@ -1,7 +1,7 @@
 # Copyright Notice:
 # Copyright 2016-2021 DMTF. All rights reserved.
 # License: BSD 3-Clause License. For full text see link:
-# https://github.com/DMTF/python-redfish-library/blob/master/LICENSE.md
+# https://github.com/DMTF/python-redfish-library/blob/main/LICENSE.md
 
 # -*- encoding: utf-8 -*-
 import unittest

tests/rest/__init__.py

@@ -1,4 +1,4 @@
 # Copyright Notice:
 # Copyright 2016-2021 DMTF. All rights reserved.
 # License: BSD 3-Clause License. For full text see link:
-# https://github.com/DMTF/python-redfish-library/blob/master/LICENSE.md
+# https://github.com/DMTF/python-redfish-library/blob/main/LICENSE.md

tests/rest/test_v1.py

@@ -1,7 +1,7 @@
 # Copyright Notice:
 # Copyright 2016-2021 DMTF. All rights reserved.
 # License: BSD 3-Clause License. For full text see link:
-# https://github.com/DMTF/python-redfish-library/blob/master/LICENSE.md
+# https://github.com/DMTF/python-redfish-library/blob/main/LICENSE.md
 
 # -*- encoding: utf-8 -*-
 import unittest

tests/ris/__init__.py

@@ -1,4 +1,4 @@
 # Copyright Notice:
 # Copyright 2016-2021 DMTF. All rights reserved.
 # License: BSD 3-Clause License. For full text see link:
-# https://github.com/DMTF/python-redfish-library/blob/master/LICENSE.md
+# https://github.com/DMTF/python-redfish-library/blob/main/LICENSE.md

tests/ris/test_config.py

@@ -1,7 +1,7 @@
 # Copyright Notice:
 # Copyright 2016-2021 DMTF. All rights reserved.
 # License: BSD 3-Clause License. For full text see link:
-# https://github.com/DMTF/python-redfish-library/blob/master/LICENSE.md
+# https://github.com/DMTF/python-redfish-library/blob/main/LICENSE.md
 
 # -*- encoding: utf-8 -*-
 import tempfile

tests/ris/test_ris.py

@@ -1,7 +1,7 @@
 # Copyright Notice:
 # Copyright 2016-2021 DMTF. All rights reserved.
 # License: BSD 3-Clause License. For full text see link:
-# https://github.com/DMTF/python-redfish-library/blob/master/LICENSE.md
+# https://github.com/DMTF/python-redfish-library/blob/main/LICENSE.md
 
 # -*- encoding: utf-8 -*-
 import unittest