Minor documentation fixes/tweaks (#597)

Mostly typos, grammar errors and inconsistent indentation in code examples. Some errors detected using Topy (https://github.com/intgr/topy), all changes verified by hand.
2016-12-14 19:29:04 +02:00
parent fbcedc2fa0
commit 71ddbb409c
47 changed files with 109 additions and 109 deletions
--- a/lemur/auth/views.py
+++ b/lemur/auth/views.py
@ -108,7 +108,7 @@ class Login(Resource):
 class Ping(Resource):
    """
    This class serves as an example of how one might implement an SSO provider for use with Lemur. In
-    this example we use a OpenIDConnect authentication flow, that is essentially OAuth2 underneath. If you have an
+    this example we use an OpenIDConnect authentication flow, that is essentially OAuth2 underneath. If you have an
    OAuth2 provider you want to use Lemur there would be two steps:

    1. Define your own class that inherits from :class:`flask.ext.restful.Resource` and create the HTTP methods the \
--- a/lemur/authorities/models.py
+++ b/lemur/authorities/models.py
@ -1,7 +1,7 @@
 """
 .. module: lemur.authorities.models
    :platform: unix
-    :synopsis: This module contains all of the models need to create a authority within Lemur.
+    :synopsis: This module contains all of the models need to create an authority within Lemur.
    :copyright: (c) 2015 by Netflix Inc., see AUTHORS for more
    :license: Apache, see LICENSE for more details.
 .. moduleauthor:: Kevin Glisson <kglisson@netflix.com>
--- a/lemur/authorities/service.py
+++ b/lemur/authorities/service.py
@ -18,7 +18,7 @@ from lemur.certificates.service import upload

 def update(authority_id, description=None, owner=None, active=None, roles=None):
    """
-    Update a an authority with new values.
+    Update an authority with new values.

    :param authority_id:
    :param roles: roles that are allowed to use this authority
@ -178,7 +178,7 @@ def render(args):
        else:
            query = database.filter(query, Authority, terms)

-    # we make sure that a user can only use an authority they either own are are a member of - admins can see all
+    # we make sure that a user can only use an authority they either own are a member of - admins can see all
    if not args['user'].is_admin:
        authority_ids = []
        for authority in args['user'].authorities:
--- a/lemur/authorities/views.py
+++ b/lemur/authorities/views.py
@ -95,7 +95,7 @@ class AuthoritiesList(AuthenticatedResource):
              }

           :query sortBy: field to sort on
-           :query sortDir: acs or desc
+           :query sortDir: asc or desc
           :query page: int default is 1
           :query filter: key value pair. format is k;v
           :query count: count number default is 10
@ -285,7 +285,7 @@ class Authorities(AuthenticatedResource):
        """
        .. http:put:: /authorities/1

-           Update a authority
+           Update an authority

           **Example request**:

--- a/lemur/certificates/service.py
+++ b/lemur/certificates/service.py
@ -32,7 +32,7 @@ from lemur.roles import service as role_service

 def get(cert_id):
    """
-    Retrieves certificate by it's ID.
+    Retrieves certificate by its ID.

    :param cert_id:
    :return:
@ -42,7 +42,7 @@ def get(cert_id):

 def get_by_name(name):
    """
-    Retrieves certificate by it's Name.
+    Retrieves certificate by its Name.

    :param name:
    :return:
--- a/lemur/certificates/views.py
+++ b/lemur/certificates/views.py
@ -111,7 +111,7 @@ class CertificatesList(AuthenticatedResource):
              }

           :query sortBy: field to sort on
-           :query sortDir: acs or desc
+           :query sortDir: asc or desc
           :query page: int. default is 1
           :query filter: key value pair format is k;v
           :query count: count number. default is 10
@ -296,10 +296,10 @@ class CertificatesUpload(AuthenticatedResource):
              Accept: application/json, text/javascript

              {
-                 "owner": "joe@exmaple.com",
-                 "publicCert": "---Begin Public...",
-                 "intermediateCert": "---Begin Public...",
-                 "privateKey": "---Begin Private..."
+                 "owner": "joe@example.com",
+                 "publicCert": "-----BEGIN CERTIFICATE-----...",
+                 "intermediateCert": "-----BEGIN CERTIFICATE-----...",
+                 "privateKey": "-----BEGIN RSA PRIVATE KEY-----..."
                 "destinations": [],
                 "notifications": [],
                 "replacements": [],
@ -427,7 +427,7 @@ class CertificatePrivateKey(AuthenticatedResource):
              Content-Type: text/javascript

              {
-                 "key": "----Begin ...",
+                 "key": "-----BEGIN ...",
              }

           :reqheader Authorization: OAuth token to authenticate
@ -732,7 +732,7 @@ class NotificationCertificatesList(AuthenticatedResource):
              }

           :query sortBy: field to sort on
-           :query sortDir: acs or desc
+           :query sortDir: asc or desc
           :query page: int default is 1
           :query filter: key value pair format is k;v
           :query count: count number default is 10
--- a/lemur/defaults/views.py
+++ b/lemur/defaults/views.py
@ -1,5 +1,5 @@
 """
-.. module: lemur.status.views
+.. module: lemur.defaults.views
    :copyright: (c) 2015 by Netflix Inc., see AUTHORS for more
    :license: Apache, see LICENSE for more details.
 """
--- a/lemur/destinations/service.py
+++ b/lemur/destinations/service.py
@ -56,7 +56,7 @@ def delete(destination_id):

 def get(destination_id):
    """
-    Retrieves an destination by it's lemur assigned ID.
+    Retrieves an destination by its lemur assigned ID.

    :param destination_id: Lemur assigned ID
    :rtype : Destination
@ -67,7 +67,7 @@ def get(destination_id):

 def get_by_label(label):
    """
-    Retrieves a destination by it's label
+    Retrieves a destination by its label

    :param label:
    :return:
--- a/lemur/destinations/views.py
+++ b/lemur/destinations/views.py
@ -82,7 +82,7 @@ class DestinationsList(AuthenticatedResource):
              }

           :query sortBy: field to sort on
-           :query sortDir: acs or desc
+           :query sortDir: asc or desc
           :query page: int. default is 1
           :query filter: key value pair format is k;v
           :query count: count number default is 10
@ -392,7 +392,7 @@ class CertificateDestinations(AuthenticatedResource):
              }

           :query sortBy: field to sort on
-           :query sortDir: acs or desc
+           :query sortDir: asc or desc
           :query page: int default is 1
           :query filter: key value pair format is k;v
           :query count: count number default is 10
--- a/lemur/domains/service.py
+++ b/lemur/domains/service.py
@ -34,7 +34,7 @@ def get_all():

 def get_by_name(name):
    """
-    Fetches domain by it's name
+    Fetches domain by its name

    :param name:
    :return:
--- a/lemur/domains/views.py
+++ b/lemur/domains/views.py
@ -68,7 +68,7 @@ class DomainsList(AuthenticatedResource):
              }

           :query sortBy: field to sort on
-           :query sortDir: acs or desc
+           :query sortDir: asc or desc
           :query page: int default is 1
           :query filter: key value pair format is k;v
           :query count: count number. default is 10
@ -115,7 +115,7 @@ class DomainsList(AuthenticatedResource):
              }

           :query sortBy: field to sort on
-           :query sortDir: acs or desc
+           :query sortDir: asc or desc
           :query page: int default is 1
           :query filter: key value pair format is k;v
           :query count: count number default is 10
@ -255,7 +255,7 @@ class CertificateDomains(AuthenticatedResource):
              }

           :query sortBy: field to sort on
-           :query sortDir: acs or desc
+           :query sortDir: asc or desc
           :query page: int default is 1
           :query filter: key value pair format is k;v
           :query count: count number default is 10
--- a/lemur/endpoints/cli.py
+++ b/lemur/endpoints/cli.py
@ -1,5 +1,5 @@
 """
-.. module: lemur.certificate.cli
+.. module: lemur.endpoints.cli
    :platform: Unix
    :copyright: (c) 2015 by Netflix Inc., see AUTHORS for more
    :license: Apache, see LICENSE for more details.
--- a/lemur/endpoints/models.py
+++ b/lemur/endpoints/models.py
@ -1,7 +1,7 @@
 """
 .. module: lemur.endpoints.models
    :platform: unix
-    :synopsis: This module contains all of the models need to create a authority within Lemur.
+    :synopsis: This module contains all of the models need to create an authority within Lemur.
    :copyright: (c) 2015 by Netflix Inc., see AUTHORS for more
    :license: Apache, see LICENSE for more details.
 .. moduleauthor:: Kevin Glisson <kglisson@netflix.com>
--- a/lemur/endpoints/views.py
+++ b/lemur/endpoints/views.py
@ -51,7 +51,7 @@ class EndpointsList(AuthenticatedResource):


           :query sortBy: field to sort on
-           :query sortDir: acs or desc
+           :query sortDir: asc or desc
           :query page: int default is 1
           :query filter: key value pair. format is k;v
           :query limit: limit number default is 10
--- a/lemur/logs/views.py
+++ b/lemur/logs/views.py
@ -1,5 +1,5 @@
 """
-.. module: lemur.log.views
+.. module: lemur.logs.views
    :platform: Unix
    :copyright: (c) 2015 by Netflix Inc., see AUTHORS for more
    :license: Apache, see LICENSE for more details.
@ -57,7 +57,7 @@ class LogsList(AuthenticatedResource):
              }

           :query sortBy: field to sort on
-           :query sortDir: acs or desc
+           :query sortDir: asc or desc
           :query page: int default is 1
           :query filter: key value pair format is k;v
           :query count: count number default is 10
--- a/lemur/manage.py
+++ b/lemur/manage.py
@ -372,7 +372,7 @@ class LemurServer(Command):

        app = WSGIApplication()

-        # run startup tasks on a app like object
+        # run startup tasks on an app like object
        pre_app = create_app(kwargs.get('config'))
        validate_conf(pre_app, REQUIRED_VARIABLES)

--- a/lemur/notifications/service.py
+++ b/lemur/notifications/service.py
@ -127,7 +127,7 @@ def delete(notification_id):

 def get(notification_id):
    """
-    Retrieves an notification by it's lemur assigned ID.
+    Retrieves an notification by its lemur assigned ID.

    :param notification_id: Lemur assigned ID
    :rtype : Notification
@ -138,7 +138,7 @@ def get(notification_id):

 def get_by_label(label):
    """
-    Retrieves a notification by it's label
+    Retrieves a notification by its label

    :param label:
    :return:
--- a/lemur/notifications/views.py
+++ b/lemur/notifications/views.py
@ -95,7 +95,7 @@ class NotificationsList(AuthenticatedResource):
               }

           :query sortBy: field to sort on
-           :query sortDir: acs or desc
+           :query sortDir: asc or desc
           :query page: int default is 1
           :query filter: key value pair format is k;v
           :query count: count number default is 10
@ -419,7 +419,7 @@ class CertificateNotifications(AuthenticatedResource):
               }

           :query sortBy: field to sort on
-           :query sortDir: acs or desc
+           :query sortDir: asc or desc
           :query page: int default is 1
           :query filter: key value pair format is k;v
           :query count: count number default is 10
--- a/lemur/plugins/bases/destination.py
+++ b/lemur/plugins/bases/destination.py
@ -1,5 +1,5 @@
 """
-.. module: lemur.bases.destination
+.. module: lemur.plugins.bases.destination
    :platform: Unix
    :copyright: (c) 2015 by Netflix Inc., see AUTHORS for more
    :license: Apache, see LICENSE for more details.
--- a/lemur/plugins/bases/export.py
+++ b/lemur/plugins/bases/export.py
@ -1,5 +1,5 @@
 """
-.. module: lemur.bases.export
+.. module: lemur.plugins.bases.export
    :platform: Unix
    :copyright: (c) 2015 by Netflix Inc., see AUTHORS for more
    :license: Apache, see LICENSE for more details.
--- a/lemur/plugins/bases/issuer.py
+++ b/lemur/plugins/bases/issuer.py
@ -1,5 +1,5 @@
 """
-.. module: lemur.bases.issuer
+.. module: lemur.plugins.bases.issuer
    :platform: Unix
    :copyright: (c) 2015 by Netflix Inc., see AUTHORS for more
    :license: Apache, see LICENSE for more details.
--- a/lemur/plugins/bases/metric.py
+++ b/lemur/plugins/bases/metric.py
@ -1,5 +1,5 @@
 """
-.. module: lemur.bases.metric
+.. module: lemur.plugins.bases.metric
    :platform: Unix
    :copyright: (c) 2015 by Netflix Inc., see AUTHORS for more
    :license: Apache, see LICENSE for more details.
--- a/lemur/plugins/bases/notification.py
+++ b/lemur/plugins/bases/notification.py
@ -1,5 +1,5 @@
 """
-.. module: lemur.bases.notification
+.. module: lemur.plugins.bases.notification
    :platform: Unix
    :copyright: (c) 2015 by Netflix Inc., see AUTHORS for more
    :license: Apache, see LICENSE for more details.
--- a/lemur/plugins/bases/source.py
+++ b/lemur/plugins/bases/source.py
@ -1,5 +1,5 @@
 """
-.. module: lemur.bases.source
+.. module: lemur.plugins.bases.source
    :platform: Unix
    :copyright: (c) 2015 by Netflix Inc., see AUTHORS for more
    :license: Apache, see LICENSE for more details.
--- a/lemur/plugins/lemur_acme/plugin.py
+++ b/lemur/plugins/lemur_acme/plugin.py
@ -1,7 +1,7 @@
 """
-.. module: lemur.plugins.lemur_acme.acme
+.. module: lemur.plugins.lemur_acme.plugin
    :platform: Unix
-    :synopsis: This module is responsible for communicating with a ACME CA.
+    :synopsis: This module is responsible for communicating with an ACME CA.
    :copyright: (c) 2015 by Netflix Inc., see AUTHORS for more
    :license: Apache, see LICENSE for more details.

@ -179,7 +179,7 @@ class ACMEIssuerPlugin(IssuerPlugin):

    def create_certificate(self, csr, issuer_options):
        """
-        Creates a ACME certificate.
+        Creates an ACME certificate.

        :param csr:
        :param issuer_options:
--- a/lemur/plugins/lemur_aws/ec2.py
+++ b/lemur/plugins/lemur_aws/ec2.py
@ -1,5 +1,5 @@
 """
-.. module: lemur.plugins.lemur_aws.elb
+.. module: lemur.plugins.lemur_aws.ec2
    :synopsis: Module contains some often used and helpful classes that
    are used to deal with ELBs

--- a/lemur/plugins/lemur_aws/plugin.py
+++ b/lemur/plugins/lemur_aws/plugin.py
@ -1,5 +1,5 @@
 """
-.. module: lemur.plugins.lemur_aws.aws
+.. module: lemur.plugins.lemur_aws.plugin
    :platform: Unix
    :copyright: (c) 2015 by Netflix Inc., see AUTHORS for more
    :license: Apache, see LICENSE for more details.
--- a/lemur/plugins/lemur_aws/sts.py
+++ b/lemur/plugins/lemur_aws/sts.py
@ -1,5 +1,5 @@
 """
-.. module: lemur.common.services.aws.sts
+.. module: lemur.plugins.lemur_aws.sts
    :platform: Unix
    :copyright: (c) 2015 by Netflix Inc., see AUTHORS for more
    :license: Apache, see LICENSE for more details.
--- a/lemur/plugins/lemur_digicert/plugin.py
+++ b/lemur/plugins/lemur_digicert/plugin.py
@ -1,5 +1,5 @@
 """
-.. module: lemur.plugins.lemur_digicert.digicert
+.. module: lemur.plugins.lemur_digicert.plugin
    :platform: Unix
    :synopsis: This module is responsible for communicating with the DigiCert '
    Advanced API.
--- a/lemur/plugins/lemur_kubernetes/plugin.py
+++ b/lemur/plugins/lemur_kubernetes/plugin.py
@ -1,5 +1,5 @@
 """
-.. module: lemur.plugins.lemur_kubernetes.aws
+.. module: lemur.plugins.lemur_kubernetes.plugin
    :platform: Unix
    :copyright: (c) 2015 by Netflix Inc., see AUTHORS for more
    :license: Apache, see LICENSE for more details.
--- a/lemur/plugins/lemur_slack/plugin.py
+++ b/lemur/plugins/lemur_slack/plugin.py
@ -1,5 +1,5 @@
 """
-.. module: lemur.plugins.lemur_slack.slack
+.. module: lemur.plugins.lemur_slack.plugin
    :platform: Unix
    :copyright: (c) 2015 by Netflix Inc., see AUTHORS for more
    :license: Apache, see LICENSE for more details.
--- a/lemur/plugins/lemur_verisign/plugin.py
+++ b/lemur/plugins/lemur_verisign/plugin.py
@ -1,5 +1,5 @@
 """
-.. module: lemur.plugins.lemur_verisign.verisign
+.. module: lemur.plugins.lemur_verisign.plugin
    :platform: Unix
    :synopsis: This module is responsible for communicating with the VeriSign VICE 2.0 API.
    :copyright: (c) 2015 by Netflix Inc., see AUTHORS for more
@ -196,7 +196,7 @@ class VerisignIssuerPlugin(IssuerPlugin):

    def get_available_units(self):
        """
-        Uses the Verisign to fetch the number of available unit's left. This can be used to get tabs
+        Uses the Verisign to fetch the number of available units left. This can be used to get tabs
        on the number of certificates that can be issued.

        :return:
--- a/lemur/plugins/views.py
+++ b/lemur/plugins/views.py
@ -79,7 +79,7 @@ class PluginsList(AuthenticatedResource):


 class Plugins(AuthenticatedResource):
-    """ Defines the the 'plugins' endpoint """
+    """ Defines the 'plugins' endpoint """
    def __init__(self):
        super(Plugins, self).__init__()

--- a/lemur/roles/service.py
+++ b/lemur/roles/service.py
@ -63,7 +63,7 @@ def get(role_id):

 def get_by_name(role_name):
    """
-    Retrieve a role by it's name
+    Retrieve a role by its name

    :param role_name:
    :return:
--- a/lemur/roles/views.py
+++ b/lemur/roles/views.py
@ -70,7 +70,7 @@ class RolesList(AuthenticatedResource):
              }

           :query sortBy: field to sort on
-           :query sortDir: acs or desc
+           :query sortDir: asc or desc
           :query page: int default is 1
           :query filter: key value pair format is k;v
           :query count: count number default is 10
@ -353,7 +353,7 @@ class UserRolesList(AuthenticatedResource):
              }

           :query sortBy: field to sort on
-           :query sortDir: acs or desc
+           :query sortDir: asc or desc
           :query page: int default is 1
           :query filter: key value pair format is k;v
           :query count: count number default is 10
@ -412,7 +412,7 @@ class AuthorityRolesList(AuthenticatedResource):
              }

           :query sortBy: field to sort on
-           :query sortDir: acs or desc
+           :query sortDir: asc or desc
           :query page: int default is 1
           :query filter: key value pair format is k;v
           :query count: count number default is 10
--- a/lemur/sources/service.py
+++ b/lemur/sources/service.py
@ -257,7 +257,7 @@ def delete(source_id):

 def get(source_id):
    """
-    Retrieves an source by it's lemur assigned ID.
+    Retrieves an source by its lemur assigned ID.

    :param source_id: Lemur assigned ID
    :rtype : Source
@ -268,7 +268,7 @@ def get(source_id):

 def get_by_label(label):
    """
-    Retrieves a source by it's label
+    Retrieves a source by its label

    :param label:
    :return:
--- a/lemur/sources/views.py
+++ b/lemur/sources/views.py
@ -75,7 +75,7 @@ class SourcesList(AuthenticatedResource):
              }

           :query sortBy: field to sort on
-           :query sortDir: acs or desc
+           :query sortDir: asc or desc
           :query page: int default is 1
           :query filter: key value pair format is k;v
           :query count: count number default is 10
@ -331,7 +331,7 @@ class CertificateSources(AuthenticatedResource):
              }

           :query sortBy: field to sort on
-           :query sortDir: acs or desc
+           :query sortDir: asc or desc
           :query page: int default is 1
           :query filter: key value pair format is k;v
           :query count: count number default is 10
--- a/lemur/users/views.py
+++ b/lemur/users/views.py
@ -1,5 +1,5 @@
 """
-.. module: lemur.user.views
+.. module: lemur.users.views
    :platform: Unix
    :copyright: (c) 2015 by Netflix Inc., see AUTHORS for more
    :license: Apache, see LICENSE for more details.
@ -55,27 +55,27 @@ class UsersList(AuthenticatedResource):
              Content-Type: text/javascript

              {
-                "items": [
+                 "items": [
                    {
-                      "id": 2,
-                      "active": True,
-                      "email": "user2@example.com",
-                      "username": "user2",
-                      "profileImage": null
+                       "id": 2,
+                       "active": True,
+                       "email": "user2@example.com",
+                       "username": "user2",
+                       "profileImage": null
                    },
                    {
-                      "id": 1,
-                      "active": False,
-                      "email": "user1@example.com",
-                      "username": "user1",
-                      "profileImage": null
+                       "id": 1,
+                       "active": False,
+                       "email": "user1@example.com",
+                       "username": "user1",
+                       "profileImage": null
                    }
-                  ]
-                "total": 2
+                 ]
+                 "total": 2
              }

           :query sortBy: field to sort on
-           :query sortDir: acs or desc
+           :query sortDir: asc or desc
           :query page: int default is 1
           :query filter: key value pair format is k;v
           :query count: count number default is 10
--- a/lemur/utils.py
+++ b/lemur/utils.py
@ -70,7 +70,7 @@ class Vault(types.TypeDecorator):
    """
    A custom SQLAlchemy column type that transparently handles encryption.

-    This uses the MultiFernet from the cryptography package to faciliate
+    This uses the MultiFernet from the cryptography package to facilitate
    key rotation. That class handles encryption and signing.

    Fernet uses AES in CBC mode with 128-bit keys and PKCS7 padding. It