src/dirbs/api/common/apidoc.py
def top_level_description(self) -> str:
        """Generate text for top level API document description."""
        description = 'The document lists the APIs exposed by DIRBS Core system. ' \
                      'The APIs provide programmatic access to read data from DIRBS Core. ' \
                      'This documentation was built using Swagger UI. ' \
                      "Swagger UI allows users to visualize and interact with the API\'s resources " \
                      'without having any of the implementation logic in place. ' \
                      '\n' \
                      '## MIME Types ' \
                      '\n' \
                      'The Core API supports [RFC 6838](https://tools.ietf.org/html/rfc6838) ' \
                      'compliant media types:' \
                      '\n\t * application/json' \
                      '\n' \
                      '## HTML Status Codes and Error Handling ' \
                      '\n' \
                      'The Core API will attempt to send the appropriate HTML status codes. ' \
                      'On error, the request response will contain details about the error cause when possible.' \
                      '\n\n' \
                      'Copyright \xA9 2019 Qualcomm Technologies, Inc. All rights reserved.'
        return description
Generate text for top level API document description.
Generate text for top level API document description.
Generate text for top level API document description .
def top_level_description(self) -> str:
        description = 'The document lists the APIs exposed by DIRBS Core system. ' \
                      'The APIs provide programmatic access to read data from DIRBS Core. ' \
                      'This documentation was built using Swagger UI. ' \
                      "Swagger UI allows users to visualize and interact with the API\'s resources " \
                      'without having any of the implementation logic in place. ' \
                      '\n' \
                      '## MIME Types ' \
                      '\n' \
                      'The Core API supports [RFC 6838](https://tools.ietf.org/html/rfc6838) ' \
                      'compliant media types:' \
                      '\n\t * application/json' \
                      '\n' \
                      '## HTML Status Codes and Error Handling ' \
                      '\n' \
                      'The Core API will attempt to send the appropriate HTML status codes. ' \
                      'On error, the request response will contain details about the error cause when possible.' \
                      '\n\n' \
                      'Copyright \xA9 2019 Qualcomm Technologies, Inc. All rights reserved.'
        return description
def top_level_description ( self ) -> str : description = 'The document lists the APIs exposed by DIRBS Core system. ' 'The APIs provide programmatic access to read data from DIRBS Core. ' 'This documentation was built using Swagger UI. ' "Swagger UI allows users to visualize and interact with the API\'s resources " 'without having any of the implementation logic in place. ' '\n' '## MIME Types ' '\n' 'The Core API supports [RFC 6838](https://tools.ietf.org/html/rfc6838) ' 'compliant media types:' '\n\t * application/json' '\n' '## HTML Status Codes and Error Handling ' '\n' 'The Core API will attempt to send the appropriate HTML status codes. ' 'On error, the request response will contain details about the error cause when possible.' '\n\n' 'Copyright \xA9 2019 Qualcomm Technologies, Inc. All rights reserved.' return description
Generate text for top level API document description.
Generate text for top level API document description .
"""Generate text for top level API document description."""
self