aries_cloudagent.messaging.schemas package¶
Submodules¶
aries_cloudagent.messaging.schemas.routes module¶
Credential schema admin routes.
-
class
aries_cloudagent.messaging.schemas.routes.
CreateSchemaTxnForEndorserOptionSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.openapi.OpenAPISchema
Class for user to input whether to create a transaction for endorser or not.
-
create_transaction_for_endorser
¶ Used by autodoc_mock_imports.
-
-
class
aries_cloudagent.messaging.schemas.routes.
SchemaConnIdMatchInfoSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.openapi.OpenAPISchema
Path parameters and validators for request taking connection id.
-
conn_id
¶ Used by autodoc_mock_imports.
-
-
class
aries_cloudagent.messaging.schemas.routes.
SchemaGetResultSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.openapi.OpenAPISchema
Result schema for schema get request.
-
schema
¶ Used by autodoc_mock_imports.
-
-
class
aries_cloudagent.messaging.schemas.routes.
SchemaIdMatchInfoSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.openapi.OpenAPISchema
Path parameters and validators for request taking schema id.
-
schema_id
¶ Used by autodoc_mock_imports.
-
-
class
aries_cloudagent.messaging.schemas.routes.
SchemaSendRequestSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.openapi.OpenAPISchema
Request schema for schema send request.
-
attributes
¶ Used by autodoc_mock_imports.
-
schema_name
¶ Used by autodoc_mock_imports.
-
schema_version
¶ Used by autodoc_mock_imports.
-
-
class
aries_cloudagent.messaging.schemas.routes.
SchemaSendResultSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.openapi.OpenAPISchema
Result schema content for schema send request with auto-endorse.
-
schema
¶ Used by autodoc_mock_imports.
-
schema_id
¶ Used by autodoc_mock_imports.
-
-
class
aries_cloudagent.messaging.schemas.routes.
SchemasCreatedResultSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.openapi.OpenAPISchema
Result schema for a schemas-created request.
-
schema_ids
¶ Used by autodoc_mock_imports.
-
-
class
aries_cloudagent.messaging.schemas.routes.
TxnOrSchemaSendResultSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.openapi.OpenAPISchema
Result schema for schema send request.
-
sent
¶ Used by autodoc_mock_imports.
-
txn
¶ Used by autodoc_mock_imports.
-
-
aries_cloudagent.messaging.schemas.routes.
add_schema_non_secrets_record
(profile: aries_cloudagent.core.profile.Profile, schema_id: str)[source]¶ Write the wallet non-secrets record for a schema (already written to the ledger).
Parameters: - profile – the current profile (used to determine storage)
- schema_id – The schema id (or stringified sequence number)
-
aries_cloudagent.messaging.schemas.routes.
on_schema_event
(profile: aries_cloudagent.core.profile.Profile, event: aries_cloudagent.core.event_bus.Event)[source]¶ Handle any events we need to support.
-
aries_cloudagent.messaging.schemas.routes.
post_process_routes
(app: <sphinx.ext.autodoc.importer._MockObject object at 0x7f3d84eeb820>)[source]¶ Amend swagger API.
-
aries_cloudagent.messaging.schemas.routes.
register
(app: <sphinx.ext.autodoc.importer._MockObject object at 0x7f3d84eeb820>)[source]¶ Register routes.
-
aries_cloudagent.messaging.schemas.routes.
register_events
(event_bus: aries_cloudagent.core.event_bus.EventBus)[source]¶ Subscribe to any events we need to support.
-
aries_cloudagent.messaging.schemas.routes.
schemas_created
(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7f3d84eeb820>)[source]¶ Request handler for retrieving schemas that current agent created.
Parameters: request – aiohttp request object Returns: The identifiers of matching schemas
-
aries_cloudagent.messaging.schemas.routes.
schemas_fix_schema_wallet_record
(request: <sphinx.ext.autodoc.importer._MockObject object at 0x7f3d84eeb820>)[source]¶ Request handler for fixing a schema’s wallet non-secrets records.
Parameters: request – aiohttp request object Returns: The schema details.
aries_cloudagent.messaging.schemas.util module¶
Schema utilities.
-
class
aries_cloudagent.messaging.schemas.util.
SchemaQueryStringSchema
(*args, **kwargs)[source]¶ Bases:
aries_cloudagent.messaging.models.openapi.OpenAPISchema
Query string parameters for schema searches.
-
schema_id
¶ Used by autodoc_mock_imports.
-
schema_issuer_did
¶ Used by autodoc_mock_imports.
-
schema_name
¶ Used by autodoc_mock_imports.
-
schema_version
¶ Used by autodoc_mock_imports.
-