daiedge-middleware-client-api-v2 1.2.0

dAIEDGE-DLT

daiedge-middleware-client-api-v2

API documentation

This Python package is automatically generated by the OpenAPI Generator project:

• API version: 1.0.0
• Package version: 1.0.0
• Generator version: 7.24.0-SNAPSHOT
• Build package: org.openapitools.codegen.languages.PythonClientCodegen

Requirements.

Python 3.10+

Installation & Usage

pip install

If the python package is hosted on a repository, you can install directly using:

pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git

(you may need to run pip with root permission: sudo pip install git+https://github.com/GIT_USER_ID/GIT_REPO_ID.git)

Then import the package:

import daiedge_middleware_client_api_v2

Setuptools

Install via Setuptools.

python setup.py install --user

(or sudo python setup.py install to install the package for all users)

Then import the package:

import daiedge_middleware_client_api_v2

Tests

Execute pytest to run the tests.

Getting Started

Please follow the installation procedure and then run the following:

import daiedge_middleware_client_api_v2
from daiedge_middleware_client_api_v2.rest import ApiException
from pprint import pprint

# Defining the host is optional and defaults to https://localhost/api/v1
# See configuration.py for a list of all supported configuration parameters.
configuration = daiedge_middleware_client_api_v2.Configuration(
    host = "https://localhost/api/v1"
)

# The client must configure the authentication and authorization parameters
# in accordance with the API server security policy.
# Examples for each auth method are provided below, use the example that
# satisfies your auth use case.

# Configure API key authorization: BearerAuth
configuration.api_key['BearerAuth'] = os.environ["API_KEY"]

# Uncomment below to setup prefix (e.g. Bearer) for API key, if needed
# configuration.api_key_prefix['BearerAuth'] = 'Bearer'


# Enter a context with an instance of the API client
async with daiedge_middleware_client_api_v2.ApiClient(configuration) as api_client:
    # Create an instance of the API class
    api_instance = daiedge_middleware_client_api_v2.AccessControlApi(api_client)
    did = 'did_example' # str | User DID
    resource_id = 3.4 # float | Resource ID

    try:
        api_response = await api_instance.access_get(did, resource_id)
        print("The response of AccessControlApi->access_get:\n")
        pprint(api_response)
    except ApiException as e:
        print("Exception when calling AccessControlApi->access_get: %s\n" % e)

Documentation for API Endpoints

All URIs are relative to https://localhost/api/v1

Class	Method	HTTP request	Description
AccessControlApi	access_get	GET /access
AccessControlApi	access_grant_access_post	POST /access/grant-access
AccessControlApi	access_register_access_post	POST /access/register-access
AccessControlApi	access_revoke_access_post	POST /access/revoke-access
AuthApi	auth_challenge_post	POST /auth/challenge
AuthApi	auth_verify_post	POST /auth/verify
BlockchainApi	blockchain_transactions_register_post	POST /blockchain/transactions/register
IdentityApi	identities_did_add_delegate_post	POST /identities/{did}/add-delegate
IdentityApi	identities_did_change_owner_post	POST /identities/{did}/change-owner
IdentityApi	identities_did_generate_key_pair_post	POST /identities/{did}/generate-key-pair
IdentityApi	identities_did_identity_owner_get	GET /identities/{did}/identity-owner
IdentityApi	identities_did_resolve_get	GET /identities/{did}/resolve
IdentityApi	identities_did_revoke_delegate_post	POST /identities/{did}/revoke-delegate
IdentityApi	identities_get	GET /identities
LicenseApi	licenses_devices_get	GET /licenses/devices
LicenseApi	licenses_get	GET /licenses
LicenseApi	licenses_id_delete	DELETE /licenses/{id}
LicenseApi	licenses_id_get	GET /licenses/{id}
LicenseApi	licenses_requests_get	GET /licenses/requests
LicenseApi	licenses_requests_id_validate_post	POST /licenses/requests/{id}/validate
LicenseApi	licenses_requests_post	POST /licenses/requests
MarketplaceApi	marketplace_buy_post	POST /marketplace/buy
MarketplaceApi	marketplace_delete	DELETE /marketplace
MarketplaceApi	marketplace_get	GET /marketplace
MarketplaceApi	marketplace_sell_post	POST /marketplace/sell
PolicyApi	policies_dids_did_delete	DELETE /policies/dids/{did}
PolicyApi	policies_dids_did_get	GET /policies/dids/{did}
PolicyApi	policies_dids_did_post	POST /policies/dids/{did}
PolicyApi	policies_dids_did_put	PUT /policies/dids/{did}
PolicyApi	policies_hardware_id_delete	DELETE /policies/hardware/{id}
PolicyApi	policies_hardware_id_get	GET /policies/hardware/{id}
PolicyApi	policies_hardware_id_post	POST /policies/hardware/{id}
PolicyApi	policies_hardware_id_put	PUT /policies/hardware/{id}
RegisterAiModelApi	model_get	GET /ai-model
RegisterAiModelApi	model_id_get	GET /ai-model/{id}
RegisterAiModelApi	model_id_post	POST /ai-model/{id}
RegisterAiModelApi	model_post	POST /ai-model
RegisterBenchmarkApi	benchmark_get	GET /benchmark
RegisterBenchmarkApi	benchmark_id_get	GET /benchmark/{id}
RegisterBenchmarkApi	benchmark_id_set_hardware_post	POST /benchmark/{id}/set-hardware
RegisterBenchmarkApi	benchmark_id_set_result_post	POST /benchmark/{id}/set-result
RegisterBenchmarkApi	benchmark_post	POST /benchmark
RegisterDatasetApi	dataset_get	GET /dataset
RegisterDatasetApi	dataset_id_get	GET /dataset/{id}
RegisterDatasetApi	dataset_id_post	POST /dataset/{id}
RegisterDatasetApi	dataset_post	POST /dataset
RegisterHardwareApi	hardware_get	GET /hardware
RegisterHardwareApi	hardware_id_delete	DELETE /hardware/{id}
RegisterHardwareApi	hardware_id_get	GET /hardware/{id}
RegisterHardwareApi	hardware_id_post	POST /hardware/{id}
RegisterHardwareApi	hardware_post	POST /hardware
RewardManagerApi	rewards_get	GET /rewards
RewardManagerApi	rewards_get_reward_by_rule_aid_get	GET /rewards/get-reward-by-rule/{aid}
RewardManagerApi	rewards_remove_reward_rule_post	POST /rewards/remove-reward-rule
RewardManagerApi	rewards_reward_manual_post	POST /rewards/reward-manual
RewardManagerApi	rewards_reward_off_chain_post	POST /rewards/reward-off-chain
RewardManagerApi	rewards_reward_on_chain_post	POST /rewards/reward-on-chain
RewardManagerApi	rewards_set_reward_rule_post	POST /rewards/set-reward-rule
RoleManagementApi	roles_get	GET /roles
RoleManagementApi	roles_grant_role_post	POST /roles/grant-role
RoleManagementApi	roles_has_role_get	GET /roles/has-role
RoleManagementApi	roles_post	POST /roles
RoleManagementApi	roles_revoke_role_post	POST /roles/revoke-role
SystemPauseApi	system_contract_pause_post	POST /system/contract/pause
SystemPauseApi	system_contract_unpause_post	POST /system/contract/unpause
SystemPauseApi	system_get	GET /system
SystemPauseApi	system_pause_post	POST /system/pause
SystemPauseApi	system_unpause_post	POST /system/unpause
TokensApi	tokens_balance_get	GET /tokens/balance
TokensApi	tokens_mint_post	POST /tokens/mint
UsersApi	vcs_grant_issuer_role_post	POST /vcs/grant-issuer-role
UsersApi	vcs_revoke_issuer_role_post	POST /vcs/revoke-issuer-role
VcApi	vcs_active_id_post	POST /vcs/active/{id}
VcApi	vcs_decode_credential_post	POST /vcs/decode-credential
VcApi	vcs_get	GET /vcs
VcApi	vcs_requests_get	GET /vcs/requests
VcApi	vcs_requests_id_accept_post	POST /vcs/requests/{id}/accept
VcApi	vcs_requests_post	POST /vcs/requests
VcApi	vcs_revoke_id_post	POST /vcs/revoke/{id}
VcApi	vcs_verify_credential_post	POST /vcs/verify-credential
VcApi	vcs_verify_presentation_post	POST /vcs/verify-presentation

Documentation For Models

• Accelerator
• AcceptVCRequestBody
• AddDelegateBody
• AuthChallengeBadRequest
• AuthChallengeBody
• AuthChallengeResponse
• AuthVerifyBadRequest
• AuthVerifyBody
• AuthVerifyForbidden
• AuthVerifyResponse
• BuyResourceBody
• CPU
• CPUSpecsItem
• ChangeOwnerBody
• CheckAccessResponse
• Cost
• CreateDIDPolicyBody
• CreateHardwarePolicyBody
• CreateRoleBody
• CreateRoleResponse
• DecodeCredentialBody
• DefaultSpecItem
• DefaultSpecsMemory
• DeleteHardwareBody
• EditDIDPolicyBody
• EditHardwarePolicyBody
• Engine
• ErrorResponse
• GenerateKeyPairBody
• GetRegisterAIModelItem
• GetRegisterBenchmarkItem
• GetRegisterDatasetItem
• GetRegisterHardwareItem
• GetRewardByRule
• GranRoleBody
• GrantAccessBody
• GrantRevokeIssuerRoleBody
• HardwareAccessItem
• HardwareAccessList
• HardwarePolicyResponse
• HardwareSpec
• HasRoleResponse
• IdentityOwnerResponse
• LicenseRequestItem
• LicenseRequestList
• ListedResourceItem
• ListedResourceList
• Memory
• MintTokensBody
• NamedTxBuildDetail
• PauseContractBody
• PauseSystemBody
• Power
• PowerItemDetails
• PreparedTransactionListResponse
• PreparedTransactionListResponseTxsInner
• PreparedTransactionListResponseTxsInnerTx
• PreparedTransactionResponse
• PreparedTransactionResponseTx
• RegisterAIModelBody
• RegisterAIModelItem
• RegisterAIModelList
• RegisterAccessBody
• RegisterBenchmarkBody
• RegisterBenchmarkItem
• RegisterBenchmarkList
• RegisterDataSetItem
• RegisterDataSetList
• RegisterDatasetBody
• RegisterHardwareBody
• RegisterHardwareItem
• RegisterHardwareList
• RegisterTransactionBody
• RemoveDIDPolicyBody
• RemoveHardwarePolicyBody
• RemoveListedResourceBody
• RemoveRewardRuleBody
• RequestUserLicenseBody
• RequestVCBody
• RevokeAccessBody
• RevokeDelegateBody
• RevokeIssuerRoleBody
• RevokeLicenseBody
• RevokeRoleBody
• RewardHistoryItem
• RewardHistoryList
• RewardManualBody
• RewardOffChainBody
• RewardOnChainBody
• RoleManagementItem
• RoleManagementList
• SellResourceBody
• SetBenchmarkResultBody
• SetHardwareBody
• SetRewardRuleBody
• SoftwareSpec
• Storage
• StorageSpecsItem
• SupportedApplication
• SupportedApplicationDetails
• SystemStatus
• TxBuildDetail
• UnpauseContractBody
• UnpauseSystemBody
• UpdateAIModelBody
• UpdateDatasetBody
• UpdateHardwareBody
• UseLicenseItem
• UserDIDItem
• UserDIDResolveResponse
• UserLicenseList
• UserVCItem
• UserVCList
• VCClaim
• VCRequestItem
• VCRequestList
• ValidateLicenseRequestBody
• VerifyCredentialBody
• VerifyCredentialResponse
• VerifyPresentationBody

Documentation For Authorization

Authentication schemes defined for the API:

BearerAuth

• Type: API key
• API key parameter name: Authorization
• Location: HTTP header

Author