Standardize documentation at Service Managers
Both file and Manager class documentation at **/core.py whose services are supported should follow the documentation pattern defined at keystone/contrib/example/core.py Change-Id: Ic775af85cad6deb290e8d55ab46077a2ec22767b
This commit is contained in:
parent
6a7c174fbd
commit
a4f89257e2
|
@ -12,7 +12,7 @@
|
|||
# License for the specific language governing permissions and limitations
|
||||
# under the License.
|
||||
|
||||
"""Main entry point into the assignment service."""
|
||||
"""Main entry point into the Assignment service."""
|
||||
|
||||
import abc
|
||||
|
||||
|
|
|
@ -12,6 +12,8 @@
|
|||
# License for the specific language governing permissions and limitations
|
||||
# under the License.
|
||||
|
||||
"""Main entry point into the Endpoint Filter service."""
|
||||
|
||||
import abc
|
||||
|
||||
from oslo_config import cfg
|
||||
|
|
|
@ -12,6 +12,8 @@
|
|||
# License for the specific language governing permissions and limitations
|
||||
# under the License.
|
||||
|
||||
"""Main entry point into this Example service."""
|
||||
|
||||
from oslo_log import log
|
||||
|
||||
from keystone.common import dependency
|
||||
|
@ -26,7 +28,7 @@ LOG = log.getLogger(__name__)
|
|||
|
||||
@dependency.provider('example_api')
|
||||
class ExampleManager(manager.Manager):
|
||||
"""Example Manager.
|
||||
"""Default pivot point for this Example backend.
|
||||
|
||||
See :mod:`keystone.common.manager.Manager` for more details on
|
||||
how this dynamically calls the backend.
|
||||
|
|
|
@ -12,7 +12,7 @@
|
|||
# License for the specific language governing permissions and limitations
|
||||
# under the License.
|
||||
|
||||
"""Extensions supporting OAuth1."""
|
||||
"""Main entry point into the OAuth1 service."""
|
||||
|
||||
from __future__ import absolute_import
|
||||
|
||||
|
|
|
@ -10,6 +10,8 @@
|
|||
# License for the specific language governing permissions and limitations
|
||||
# under the License.
|
||||
|
||||
"""Main entry point into the Revoke service."""
|
||||
|
||||
import abc
|
||||
import datetime
|
||||
|
||||
|
@ -64,10 +66,13 @@ def revoked_before_cutoff_time():
|
|||
|
||||
@dependency.provider('revoke_api')
|
||||
class Manager(manager.Manager):
|
||||
"""Revoke API Manager.
|
||||
"""Default pivot point for the Revoke backend.
|
||||
|
||||
Performs common logic for recording revocations.
|
||||
|
||||
See :mod:`keystone.common.manager.Manager` for more details on
|
||||
how this dynamically calls the backend.
|
||||
|
||||
"""
|
||||
|
||||
driver_namespace = 'keystone.revoke'
|
||||
|
|
|
@ -12,7 +12,7 @@
|
|||
# License for the specific language governing permissions and limitations
|
||||
# under the License.
|
||||
|
||||
"""Main entry point into the Credentials service."""
|
||||
"""Main entry point into the Credential service."""
|
||||
|
||||
import abc
|
||||
|
||||
|
|
|
@ -10,7 +10,7 @@
|
|||
# License for the specific language governing permissions and limitations
|
||||
# under the License.
|
||||
|
||||
"""Main entry point into the resource service."""
|
||||
"""Main entry point into the Resource service."""
|
||||
|
||||
import abc
|
||||
|
||||
|
@ -47,7 +47,7 @@ def calc_default_domain():
|
|||
@dependency.requires('assignment_api', 'credential_api', 'domain_config_api',
|
||||
'identity_api', 'revoke_api')
|
||||
class Manager(manager.Manager):
|
||||
"""Default pivot point for the resource backend.
|
||||
"""Default pivot point for the Resource backend.
|
||||
|
||||
See :mod:`keystone.common.manager.Manager` for more details on how this
|
||||
dynamically calls the backend.
|
||||
|
|
|
@ -12,7 +12,7 @@
|
|||
# License for the specific language governing permissions and limitations
|
||||
# under the License.
|
||||
|
||||
"""Main entry point into the Token persistence service."""
|
||||
"""Main entry point into the Token Persistence service."""
|
||||
|
||||
import abc
|
||||
import copy
|
||||
|
@ -40,7 +40,7 @@ REVOCATION_MEMOIZE = cache.get_memoization_decorator(
|
|||
@dependency.requires('assignment_api', 'identity_api', 'resource_api',
|
||||
'token_provider_api', 'trust_api')
|
||||
class PersistenceManager(manager.Manager):
|
||||
"""Default pivot point for the Token backend.
|
||||
"""Default pivot point for the Token Persistence backend.
|
||||
|
||||
See :mod:`keystone.common.manager.Manager` for more details on how this
|
||||
dynamically calls the backend.
|
||||
|
|
|
@ -12,7 +12,7 @@
|
|||
# License for the specific language governing permissions and limitations
|
||||
# under the License.
|
||||
|
||||
"""Main entry point into the Identity service."""
|
||||
"""Main entry point into the Trust service."""
|
||||
|
||||
import abc
|
||||
|
||||
|
|
Loading…
Reference in New Issue