From 2ba48995fec1bae220962a7176ba5bd32f0ecb0b Mon Sep 17 00:00:00 2001 From: kevgliss Date: Fri, 29 Jan 2016 11:47:16 -0800 Subject: [PATCH] Fixing documentation for filter format --- lemur/authorities/views.py | 6 +++--- lemur/certificates/views.py | 8 ++++---- lemur/destinations/views.py | 10 +++++----- lemur/domains/views.py | 16 ++++++++-------- lemur/notifications/views.py | 12 ++++++------ lemur/roles/views.py | 18 +++++++++--------- lemur/sources/views.py | 12 ++++++------ lemur/users/views.py | 6 +++--- 8 files changed, 44 insertions(+), 44 deletions(-) diff --git a/lemur/authorities/views.py b/lemur/authorities/views.py index 43a65fe5..f5e85d75 100644 --- a/lemur/authorities/views.py +++ b/lemur/authorities/views.py @@ -85,9 +85,9 @@ class AuthoritiesList(AuthenticatedResource): :query sortBy: field to sort on :query sortDir: acs or desc - :query page: int. default is 1 - :query filter: key value pair. format is k=v; - :query limit: limit number. default is 10 + :query page: int default is 1 + :query filter: key value pair. format is k;v + :query limit: limit number default is 10 :reqheader Authorization: OAuth token to authenticate :statuscode 200: no error :statuscode 403: unauthenticated diff --git a/lemur/certificates/views.py b/lemur/certificates/views.py index 009d1c16..26da8a88 100644 --- a/lemur/certificates/views.py +++ b/lemur/certificates/views.py @@ -188,7 +188,7 @@ class CertificatesList(AuthenticatedResource): :query sortBy: field to sort on :query sortDir: acs or desc :query page: int. default is 1 - :query filter: key value pair. format is k=v; + :query filter: key value pair format is k;v :query limit: limit number. default is 10 :reqheader Authorization: OAuth token to authenticate :statuscode 200: no error @@ -738,9 +738,9 @@ class NotificationCertificatesList(AuthenticatedResource): :query sortBy: field to sort on :query sortDir: acs or desc - :query page: int. default is 1 - :query filter: key value pair. format is k=v; - :query limit: limit number. default is 10 + :query page: int default is 1 + :query filter: key value pair format is k;v + :query limit: limit number default is 10 :reqheader Authorization: OAuth token to authenticate :statuscode 200: no error :statuscode 403: unauthenticated diff --git a/lemur/destinations/views.py b/lemur/destinations/views.py index 21e7886e..bc8799a1 100644 --- a/lemur/destinations/views.py +++ b/lemur/destinations/views.py @@ -82,8 +82,8 @@ class DestinationsList(AuthenticatedResource): :query sortBy: field to sort on :query sortDir: acs or desc :query page: int. default is 1 - :query filter: key value pair. format is k=v; - :query limit: limit number. default is 10 + :query filter: key value pair format is k;v + :query limit: limit number default is 10 :reqheader Authorization: OAuth token to authenticate :statuscode 200: no error """ @@ -341,9 +341,9 @@ class CertificateDestinations(AuthenticatedResource): :query sortBy: field to sort on :query sortDir: acs or desc - :query page: int. default is 1 - :query filter: key value pair. format is k=v; - :query limit: limit number. default is 10 + :query page: int default is 1 + :query filter: key value pair format is k;v + :query limit: limit number default is 10 :reqheader Authorization: OAuth token to authenticate :statuscode 200: no error """ diff --git a/lemur/domains/views.py b/lemur/domains/views.py index b0922f05..1fa6a6d7 100644 --- a/lemur/domains/views.py +++ b/lemur/domains/views.py @@ -72,8 +72,8 @@ class DomainsList(AuthenticatedResource): :query sortBy: field to sort on :query sortDir: acs or desc - :query page: int. default is 1 - :query filter: key value pair. format is k=v; + :query page: int default is 1 + :query filter: key value pair format is k;v :query limit: limit number. default is 10 :reqheader Authorization: OAuth token to authenticate :statuscode 200: no error @@ -119,9 +119,9 @@ class DomainsList(AuthenticatedResource): :query sortBy: field to sort on :query sortDir: acs or desc - :query page: int. default is 1 - :query filter: key value pair. format is k=v; - :query limit: limit number. default is 10 + :query page: int default is 1 + :query filter: key value pair format is k;v + :query limit: limit number default is 10 :reqheader Authorization: OAuth token to authenticate :statuscode 200: no error :statuscode 403: unauthenticated @@ -266,9 +266,9 @@ class CertificateDomains(AuthenticatedResource): :query sortBy: field to sort on :query sortDir: acs or desc - :query page: int. default is 1 - :query filter: key value pair. format is k=v; - :query limit: limit number. default is 10 + :query page: int default is 1 + :query filter: key value pair format is k;v + :query limit: limit number default is 10 :reqheader Authorization: OAuth token to authenticate :statuscode 200: no error :statuscode 403: unauthenticated diff --git a/lemur/notifications/views.py b/lemur/notifications/views.py index 5366c716..281546ac 100644 --- a/lemur/notifications/views.py +++ b/lemur/notifications/views.py @@ -133,9 +133,9 @@ class NotificationsList(AuthenticatedResource): :query sortBy: field to sort on :query sortDir: acs or desc - :query page: int. default is 1 - :query filter: key value pair. format is k=v; - :query limit: limit number. default is 10 + :query page: int default is 1 + :query filter: key value pair format is k;v + :query limit: limit number default is 10 :reqheader Authorization: OAuth token to authenticate :statuscode 200: no error """ @@ -470,9 +470,9 @@ class CertificateNotifications(AuthenticatedResource): :query sortBy: field to sort on :query sortDir: acs or desc - :query page: int. default is 1 - :query filter: key value pair. format is k=v; - :query limit: limit number. default is 10 + :query page: int default is 1 + :query filter: key value pair format is k;v + :query limit: limit number default is 10 :reqheader Authorization: OAuth token to authenticate :statuscode 200: no error """ diff --git a/lemur/roles/views.py b/lemur/roles/views.py index e19e2e06..15f878df 100644 --- a/lemur/roles/views.py +++ b/lemur/roles/views.py @@ -75,9 +75,9 @@ class RolesList(AuthenticatedResource): :query sortBy: field to sort on :query sortDir: acs or desc - :query page: int. default is 1 - :query filter: key value pair. format is k=v; - :query limit: limit number. default is 10 + :query page: int default is 1 + :query filter: key value pair format is k;v + :query limit: limit number default is 10 :reqheader Authorization: OAuth token to authenticate :statuscode 200: no error :statuscode 403: unauthenticated @@ -367,9 +367,9 @@ class UserRolesList(AuthenticatedResource): :query sortBy: field to sort on :query sortDir: acs or desc - :query page: int. default is 1 - :query filter: key value pair. format is k=v; - :query limit: limit number. default is 10 + :query page: int default is 1 + :query filter: key value pair format is k;v + :query limit: limit number default is 10 :reqheader Authorization: OAuth token to authenticate :statuscode 200: no error """ @@ -426,9 +426,9 @@ class AuthorityRolesList(AuthenticatedResource): :query sortBy: field to sort on :query sortDir: acs or desc - :query page: int. default is 1 - :query filter: key value pair. format is k=v; - :query limit: limit number. default is 10 + :query page: int default is 1 + :query filter: key value pair format is k;v + :query limit: limit number default is 10 :reqheader Authorization: OAuth token to authenticate :statuscode 200: no error """ diff --git a/lemur/sources/views.py b/lemur/sources/views.py index 7e828f83..6a94bf2f 100644 --- a/lemur/sources/views.py +++ b/lemur/sources/views.py @@ -83,9 +83,9 @@ class SourcesList(AuthenticatedResource): :query sortBy: field to sort on :query sortDir: acs or desc - :query page: int. default is 1 - :query filter: key value pair. format is k=v; - :query limit: limit number. default is 10 + :query page: int default is 1 + :query filter: key value pair format is k;v + :query limit: limit number default is 10 :reqheader Authorization: OAuth token to authenticate :statuscode 200: no error """ @@ -349,9 +349,9 @@ class CertificateSources(AuthenticatedResource): :query sortBy: field to sort on :query sortDir: acs or desc - :query page: int. default is 1 - :query filter: key value pair. format is k=v; - :query limit: limit number. default is 10 + :query page: int default is 1 + :query filter: key value pair format is k;v + :query limit: limit number default is 10 :reqheader Authorization: OAuth token to authenticate :statuscode 200: no error """ diff --git a/lemur/users/views.py b/lemur/users/views.py index 85093997..2df6e8d7 100644 --- a/lemur/users/views.py +++ b/lemur/users/views.py @@ -96,9 +96,9 @@ class UsersList(AuthenticatedResource): :query sortBy: field to sort on :query sortDir: acs or desc - :query page: int. default is 1 - :query filter: key value pair. format is k=v; - :query limit: limit number. default is 10 + :query page: int default is 1 + :query filter: key value pair format is k;v + :query limit: limit number default is 10 :reqheader Authorization: OAuth token to authenticate :statuscode 200: no error """