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.
This commit is contained in:
Marti Raudsepp
2016-12-14 19:29:04 +02:00
committed by kevgliss
parent fbcedc2fa0
commit 71ddbb409c
47 changed files with 109 additions and 109 deletions

View File

@ -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:

View File

@ -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