Skip to content

Commit

Permalink
Deploying to gh-pages from @ c7cd5e4 🚀
Browse files Browse the repository at this point in the history
  • Loading branch information
mbwhite committed Oct 18, 2024
1 parent c2b65c9 commit 4da7fe8
Show file tree
Hide file tree
Showing 89 changed files with 429 additions and 315 deletions.
Binary file modified .doctrees/environment.pickle
Binary file not shown.
Binary file modified .doctrees/modules/approved_chaincode.doctree
Binary file not shown.
Binary file modified .doctrees/modules/certificate_authority.doctree
Binary file not shown.
Binary file modified .doctrees/modules/certificate_authority_action.doctree
Binary file not shown.
Binary file modified .doctrees/modules/certificate_authority_info.doctree
Binary file not shown.
Binary file modified .doctrees/modules/certificate_authority_metadata.doctree
Binary file not shown.
Binary file modified .doctrees/modules/chaincode_list_info.doctree
Binary file not shown.
Binary file modified .doctrees/modules/channel_acl.doctree
Binary file not shown.
Binary file modified .doctrees/modules/channel_block.doctree
Binary file not shown.
Binary file modified .doctrees/modules/channel_capabilities.doctree
Binary file not shown.
Binary file modified .doctrees/modules/channel_config.doctree
Binary file not shown.
Binary file modified .doctrees/modules/channel_consenter.doctree
Binary file not shown.
Binary file modified .doctrees/modules/channel_consenters.doctree
Binary file not shown.
Binary file modified .doctrees/modules/channel_member.doctree
Binary file not shown.
Binary file modified .doctrees/modules/channel_member_info.doctree
Binary file not shown.
Binary file modified .doctrees/modules/channel_members.doctree
Binary file not shown.
Binary file modified .doctrees/modules/channel_parameters.doctree
Binary file not shown.
Binary file modified .doctrees/modules/channel_policy.doctree
Binary file not shown.
Binary file modified .doctrees/modules/committed_chaincode.doctree
Binary file not shown.
Binary file modified .doctrees/modules/connection_profile.doctree
Binary file not shown.
Binary file modified .doctrees/modules/console_user.doctree
Binary file not shown.
Binary file modified .doctrees/modules/consortium_member.doctree
Binary file not shown.
Binary file modified .doctrees/modules/consortium_member_info.doctree
Binary file not shown.
Binary file modified .doctrees/modules/enrolled_identity.doctree
Binary file not shown.
Binary file modified .doctrees/modules/external_certificate_authority.doctree
Binary file not shown.
Binary file modified .doctrees/modules/external_ordering_service.doctree
Binary file not shown.
Binary file modified .doctrees/modules/external_ordering_service_node.doctree
Binary file not shown.
Binary file modified .doctrees/modules/external_organization.doctree
Binary file not shown.
Binary file modified .doctrees/modules/external_peer.doctree
Binary file not shown.
Binary file modified .doctrees/modules/installed_chaincode.doctree
Binary file not shown.
Binary file modified .doctrees/modules/instantiated_chaincode.doctree
Binary file not shown.
Binary file modified .doctrees/modules/membership_service_provider_local.doctree
Binary file not shown.
Binary file modified .doctrees/modules/ordering_service.doctree
Binary file not shown.
Binary file modified .doctrees/modules/ordering_service_admin.doctree
Binary file not shown.
Binary file modified .doctrees/modules/ordering_service_info.doctree
Binary file not shown.
Binary file modified .doctrees/modules/ordering_service_node.doctree
Binary file not shown.
Binary file modified .doctrees/modules/ordering_service_node_info.doctree
Binary file not shown.
Binary file modified .doctrees/modules/organization.doctree
Binary file not shown.
Binary file modified .doctrees/modules/organization_info.doctree
Binary file not shown.
Binary file modified .doctrees/modules/organization_list_info.doctree
Binary file not shown.
Binary file modified .doctrees/modules/peer.doctree
Binary file not shown.
Binary file modified .doctrees/modules/peer_channel.doctree
Binary file not shown.
Binary file modified .doctrees/modules/peer_info.doctree
Binary file not shown.
Binary file modified .doctrees/modules/registered_identity.doctree
Binary file not shown.
22 changes: 11 additions & 11 deletions _sources/modules/approved_chaincode.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Parameters
| **Type**: str
api_authtype (required)
\ :literal:`basic`\ - Authenticate to the Fabric operations console using basic authentication. You must provide both a valid API key using \ :emphasis:`api\_key`\ and API secret using \ :emphasis:`api\_secret`\ .
:literal:`basic` - Authenticate to the Fabric operations console using basic authentication. You must provide both a valid API key using :emphasis:`api\_key` and API secret using :emphasis:`api\_secret`.

| **Type**: str
Expand All @@ -46,7 +46,7 @@ Parameters
api_secret
The API secret for the Fabric operations console.

Only required when \ :emphasis:`api\_authtype`\ is \ :literal:`basic`\ .
Only required when :emphasis:`api\_authtype` is :literal:`basic`.

| **Type**: str
Expand All @@ -57,9 +57,9 @@ Parameters
| **Default value**: ``60``
state
\ :literal:`absent`\ - If a chaincode definition matching the specified name, version and configuration is approved, then an error will be thrown, as it is not possible to unapprove a chaincode definition.
:literal:`absent` - If a chaincode definition matching the specified name, version and configuration is approved, then an error will be thrown, as it is not possible to unapprove a chaincode definition.

\ :literal:`present`\ - Asserts that a chaincode definition matching the specified name, version and configuration is approved on the specified channel. If it is not approved, then the chaincode definition with the specified name, version and configuration will be approved on the specified channel.
:literal:`present` - Asserts that a chaincode definition matching the specified name, version and configuration is approved on the specified channel. If it is not approved, then the chaincode definition with the specified name, version and configuration will be approved on the specified channel.

| **Type**: str
| **Default value**: ``present``
Expand All @@ -69,7 +69,7 @@ Parameters

You can pass a string, which is the display name of a peer registered with the Fabric operations console.

You can also pass a dict, which must match the result format of one of the \ :strong:`ERROR while parsing`\ : While parsing "M(peer\_info)" at index 76: Module name "peer\_info" is not a FQCN\ or \ :strong:`ERROR while parsing`\ : While parsing "M(peer)" at index 92: Module name "peer" is not a FQCN\ modules.
You can also pass a dict, which must match the result format of one of the :strong:`ERROR while parsing`\ : While parsing "M(peer\_info)" at index 76: Module name "peer\_info" is not a FQCN or :strong:`ERROR while parsing`\ : While parsing "M(peer)" at index 92: Module name "peer" is not a FQCN modules.

| **Type**: raw
Expand All @@ -78,7 +78,7 @@ Parameters

You can pass a string, which is the path to the JSON file where the enrolled identity is stored.

You can also pass a dict, which must match the result format of one of the \ :strong:`ERROR while parsing`\ : While parsing "M(enrolled\_identity\_info)" at index 76: Module name "enrolled\_identity\_info" is not a FQCN\ or \ :strong:`ERROR while parsing`\ : While parsing "M(enrolled\_identity)" at index 105: Module name "enrolled\_identity" is not a FQCN\ modules.
You can also pass a dict, which must match the result format of one of the :strong:`ERROR while parsing`\ : While parsing "M(enrolled\_identity\_info)" at index 76: Module name "enrolled\_identity\_info" is not a FQCN or :strong:`ERROR while parsing`\ : While parsing "M(enrolled\_identity)" at index 105: Module name "enrolled\_identity" is not a FQCN modules.

| **Type**: raw
Expand All @@ -90,7 +90,7 @@ Parameters
hsm
The PKCS #11 compliant HSM configuration to use for digital signatures.

Only required if the identity specified in \ :emphasis:`identity`\ was enrolled using an HSM.
Only required if the identity specified in :emphasis:`identity` was enrolled using an HSM.

| **Type**: dict
Expand Down Expand Up @@ -136,7 +136,7 @@ Parameters
| **Type**: int
endorsement_policy_ref
A reference to a channel policy to use as the endorsement policy for this chaincode definition, for example \ :emphasis:`/Channel/Application/MyEndorsementPolicy`\ .
A reference to a channel policy to use as the endorsement policy for this chaincode definition, for example :emphasis:`/Channel/Application/MyEndorsementPolicy`.

| **Type**: str
Expand All @@ -156,7 +156,7 @@ Parameters
| **Type**: str
init_required
True if this chaincode definition requires called the \ :emphasis:`Init`\ method before the \ :emphasis:`Invoke`\ method, false otherwise.
True if this chaincode definition requires called the :emphasis:`Init` method before the :emphasis:`Invoke` method, false otherwise.

| **Type**: bool
Expand Down Expand Up @@ -242,7 +242,7 @@ Return Values
approved_chaincode
The approved chaincode definition.

| **Returned**: when \ :emphasis:`state`\ is \ :literal:`present`\
| **Returned**: when :emphasis:`state` is :literal:`present`
| **Type**: dict
channel
Expand Down Expand Up @@ -297,7 +297,7 @@ Return Values
| **Type**: str
init_required
True if this chaincode definition requires called the \ :emphasis:`Init`\ method before the \ :emphasis:`Invoke`\ method, false otherwise.
True if this chaincode definition requires called the :emphasis:`Init` method before the :emphasis:`Invoke` method, false otherwise.

| **Type**: bool
Expand Down
14 changes: 7 additions & 7 deletions _sources/modules/certificate_authority.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Parameters
| **Type**: str
api_authtype (required)
\ :literal:`basic`\ - Authenticate to the Fabric operations console using basic authentication. You must provide both a valid API key using \ :emphasis:`api\_key`\ and API secret using \ :emphasis:`api\_secret`\ .
:literal:`basic` - Authenticate to the Fabric operations console using basic authentication. You must provide both a valid API key using :emphasis:`api\_key` and API secret using :emphasis:`api\_secret`.

| **Type**: str
Expand All @@ -46,7 +46,7 @@ Parameters
api_secret
The API secret for the Fabric operations console.

Only required when \ :emphasis:`api\_authtype`\ is \ :literal:`basic`\ .
Only required when :emphasis:`api\_authtype` is :literal:`basic`.

| **Type**: str
Expand All @@ -57,9 +57,9 @@ Parameters
| **Default value**: ``60``
state
\ :literal:`absent`\ - A certificate authority matching the specified name will be stopped and removed.
:literal:`absent` - A certificate authority matching the specified name will be stopped and removed.

\ :literal:`present`\ - Asserts that a certificate authority matching the specified name and configuration exists. If no certificate authority matches the specified name, a certificate authority will be created. If a certificate authority matches the specified name but the configuration does not match, then the certificate authority will be updated, if it can be. If it cannot be updated, it will be removed and re-created with the specified configuration.
:literal:`present` - Asserts that a certificate authority matching the specified name and configuration exists. If no certificate authority matches the specified name, a certificate authority will be created. If a certificate authority matches the specified name but the configuration does not match, then the certificate authority will be updated, if it can be. If it cannot be updated, it will be removed and re-created with the specified configuration.

| **Type**: str
| **Default value**: ``present``
Expand Down Expand Up @@ -192,9 +192,9 @@ Parameters

If you specify a new version, an existing certificate authority will be automatically upgraded.

The version can also be specified as a version range specification, for example \ :literal:`\>=2.2,\<3.0`\ , which will match Hyperledger Fabric v2.2 and greater, but not Hyperledger Fabric v3.0 and greater.
The version can also be specified as a version range specification, for example :literal:`\>=2.2,\<3.0`\ , which will match Hyperledger Fabric v2.2 and greater, but not Hyperledger Fabric v3.0 and greater.

See the \ :literal:`semantic\_version`\ Python module documentation for more information: https://python-semanticversion.readthedocs.io/en/latest/reference.html#semantic\_version.SimpleSpec
See the :literal:`semantic\_version` Python module documentation for more information: https://python-semanticversion.readthedocs.io/en/latest/reference.html#semantic\_version.SimpleSpec

| **Type**: str
Expand Down Expand Up @@ -325,7 +325,7 @@ Return Values
certificate_authority
The certificate authority.

| **Returned**: when \ :emphasis:`state`\ is \ :literal:`present`\
| **Returned**: when :emphasis:`state` is :literal:`present`
| **Type**: dict
name
Expand Down
4 changes: 2 additions & 2 deletions _sources/modules/certificate_authority_action.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Parameters
| **Type**: str
api_authtype (required)
\ :literal:`basic`\ - Authenticate to the the Fabric operations console using basic authentication. You must provide both a valid API key using \ :emphasis:`api\_key`\ and API secret using \ :emphasis:`api\_secret`\ .
:literal:`basic` - Authenticate to the the Fabric operations console using basic authentication. You must provide both a valid API key using :emphasis:`api\_key` and API secret using :emphasis:`api\_secret`.

| **Type**: str
Expand All @@ -46,7 +46,7 @@ Parameters
api_secret
The API secret for the the Fabric operations console.

Only required when \ :emphasis:`api\_authtype`\ is \ :literal:`basic`\ .
Only required when :emphasis:`api\_authtype` is :literal:`basic`.

| **Type**: str
Expand Down
4 changes: 2 additions & 2 deletions _sources/modules/certificate_authority_info.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Parameters
| **Type**: str
api_authtype (required)
\ :literal:`basic`\ - Authenticate to the the Fabric operations console using basic authentication. You must provide both a valid API key using \ :emphasis:`api\_key`\ and API secret using \ :emphasis:`api\_secret`\ .
:literal:`basic` - Authenticate to the the Fabric operations console using basic authentication. You must provide both a valid API key using :emphasis:`api\_key` and API secret using :emphasis:`api\_secret`.

| **Type**: str
Expand All @@ -46,7 +46,7 @@ Parameters
api_secret
The API secret for the the Fabric operations console.

Only required when \ :emphasis:`api\_authtype`\ is \ :literal:`basic`\ .
Only required when :emphasis:`api\_authtype` is :literal:`basic`.

| **Type**: str
Expand Down
4 changes: 2 additions & 2 deletions _sources/modules/certificate_authority_metadata.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Parameters
| **Type**: str
api_authtype (required)
\ :literal:`basic`\ - Authenticate to the the Fabric operations console using basic authentication. You must provide both a valid API key using \ :emphasis:`api\_key`\ and API secret using \ :emphasis:`api\_secret`\ .
:literal:`basic` - Authenticate to the the Fabric operations console using basic authentication. You must provide both a valid API key using :emphasis:`api\_key` and API secret using :emphasis:`api\_secret`.

| **Type**: str
Expand All @@ -46,7 +46,7 @@ Parameters
api_secret
The API secret for the the Fabric operations console.

Only required when \ :emphasis:`api\_authtype`\ is \ :literal:`basic`\ .
Only required when :emphasis:`api\_authtype` is :literal:`basic`.

| **Type**: str
Expand Down
12 changes: 6 additions & 6 deletions _sources/modules/chaincode_list_info.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Parameters
| **Type**: str
api_authtype (required)
\ :literal:`basic`\ - Authenticate to the Fabric operations console using basic authentication. You must provide both a valid API key using \ :emphasis:`api\_key`\ and API secret using \ :emphasis:`api\_secret`\ .
:literal:`basic` - Authenticate to the Fabric operations console using basic authentication. You must provide both a valid API key using :emphasis:`api\_key` and API secret using :emphasis:`api\_secret`.

| **Type**: str
Expand All @@ -44,7 +44,7 @@ Parameters
api_secret
The API secret for the Fabric operations console.

Only required when \ :emphasis:`api\_authtype`\ is \ :literal:`basic`\ .
Only required when :emphasis:`api\_authtype` is :literal:`basic`.

| **Type**: str
Expand All @@ -59,7 +59,7 @@ Parameters

You can pass a string, which is the display name of a peer registered with the Fabric operations console.

You can also pass a dict, which must match the result format of one of the \ :strong:`ERROR while parsing`\ : While parsing "M(peer\_info)" at index 76: Module name "peer\_info" is not a FQCN\ or \ :strong:`ERROR while parsing`\ : While parsing "M(peer)" at index 92: Module name "peer" is not a FQCN\ modules.
You can also pass a dict, which must match the result format of one of the :strong:`ERROR while parsing`\ : While parsing "M(peer\_info)" at index 76: Module name "peer\_info" is not a FQCN or :strong:`ERROR while parsing`\ : While parsing "M(peer)" at index 92: Module name "peer" is not a FQCN modules.

| **Type**: raw
Expand All @@ -68,7 +68,7 @@ Parameters

You can pass a string, which is the path to the JSON file where the enrolled identity is stored.

You can also pass a dict, which must match the result format of one of the \ :strong:`ERROR while parsing`\ : While parsing "M(enrolled\_identity\_info)" at index 76: Module name "enrolled\_identity\_info" is not a FQCN\ or \ :strong:`ERROR while parsing`\ : While parsing "M(enrolled\_identity)" at index 105: Module name "enrolled\_identity" is not a FQCN\ modules.
You can also pass a dict, which must match the result format of one of the :strong:`ERROR while parsing`\ : While parsing "M(enrolled\_identity\_info)" at index 76: Module name "enrolled\_identity\_info" is not a FQCN or :strong:`ERROR while parsing`\ : While parsing "M(enrolled\_identity)" at index 105: Module name "enrolled\_identity" is not a FQCN modules.

| **Type**: raw
Expand All @@ -80,7 +80,7 @@ Parameters
hsm
The PKCS #11 compliant HSM configuration to use for digital signatures.

Only required if the identity specified in \ :emphasis:`identity`\ was enrolled using an HSM.
Only required if the identity specified in :emphasis:`identity` was enrolled using an HSM.

| **Type**: dict
Expand Down Expand Up @@ -138,7 +138,7 @@ Return Values
committed_chaincode
The committed chaincode definition.

| **Returned**: when \ :emphasis:`state`\ is \ :literal:`present`\
| **Returned**: when :emphasis:`state` is :literal:`present`
| **Type**: dict
installed_chaincodes
Expand Down
6 changes: 3 additions & 3 deletions _sources/modules/channel_acl.rst.txt
Original file line number Diff line number Diff line change
Expand Up @@ -29,17 +29,17 @@ Parameters
----------

state
\ :literal:`absent`\ - An ACL matching the specified name will be removed from the channel.
:literal:`absent` - An ACL matching the specified name will be removed from the channel.

\ :literal:`present`\ - Asserts that an ACL matching the specified name and policy exists in the channel. If no ACL matches the specified name, the ACL will be added to the channel. If an ACL matches the specified name but the policy does not match, then the ACL in the channel will be updated.
:literal:`present` - Asserts that an ACL matching the specified name and policy exists in the channel. If no ACL matches the specified name, the ACL will be added to the channel. If an ACL matches the specified name but the policy does not match, then the ACL in the channel will be updated.

| **Type**: str
| **Default value**: ``present``
path (required)
Path to current the channel configuration file.

This file can be fetched by using the \ :strong:`ERROR while parsing`\ : While parsing "M(channel\_config)" at index 39: Module name "channel\_config" is not a FQCN\ module.
This file can be fetched by using the :strong:`ERROR while parsing`\ : While parsing "M(channel\_config)" at index 39: Module name "channel\_config" is not a FQCN module.

This file will be updated in place. You will need to keep a copy of the original file for computing the configuration update.

Expand Down
Loading

0 comments on commit 4da7fe8

Please sign in to comment.