Skip to content

Commit

Permalink
Update doc references for main branch
Browse files Browse the repository at this point in the history
Update doc references for main branch.

Signed-off-by: David Enyeart <enyeart@us.ibm.com>
  • Loading branch information
denyeart committed Mar 14, 2021
1 parent 99187d5 commit 7fd582b
Show file tree
Hide file tree
Showing 5 changed files with 11 additions and 11 deletions.
2 changes: 1 addition & 1 deletion MAINTAINERS.md
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,6 @@ Retired Maintainers
| Keith Smith | smithbk | smithbk | <bksmith@us.ibm.com> |


Also: Please see the [Release Manager section](https://github.com/hyperledger/fabric/blob/master/MAINTAINERS.md)
Also: Please see the [Release Manager section](https://github.com/hyperledger/fabric/blob/main/MAINTAINERS.md)

<a rel="license" href="http://creativecommons.org/licenses/by/4.0/"><img alt="Creative Commons License" style="border-width:0" src="https://i.creativecommons.org/l/by/4.0/88x31.png" /></a><br />This work is licensed under a <a rel="license" href="http://creativecommons.org/licenses/by/4.0/">Creative Commons Attribution 4.0 International License</a>.
8 changes: 4 additions & 4 deletions docs/source/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -27,7 +27,7 @@
import sphinx_rtd_theme

placeholder_replacements = {
"{BRANCH}": "master"
"{BRANCH}": "main"
}

# -- General configuration ------------------------------------------------
Expand Down Expand Up @@ -64,7 +64,7 @@
# You can specify multiple suffix as a list of string:
source_suffix = ['.rst', '.md']

# The master toctree document.
# The main toctree document.
master_doc = 'index'

# General information about the project.
Expand All @@ -77,9 +77,9 @@
# built documents.
#
# The short X.Y version.
version = u'master'
version = u'main'
# The full version, including alpha/beta/rc tags.
release = u'master'
release = u'main'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
2 changes: 1 addition & 1 deletion docs/source/metrics_reference.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ characteristics of the item being measured. Five different labels are used.
api_name
For API requests, this is the path of the requested resource with the version
prefix removed. The list of resource paths can be found in the
`Swagger API Documentation <https://github.com/hyperledger/fabric-ca/blob/master/swagger/swagger-fabric-ca.json>`_.
`Swagger API Documentation <https://github.com/hyperledger/fabric-ca/blob/main/swagger/swagger-fabric-ca.json>`_.
Examples include ``cainfo``, register``, and ``enroll``.

ca_name
Expand Down
2 changes: 1 addition & 1 deletion docs/source/metrics_reference.rst.tmpl
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@ characteristics of the item being measured. Five different labels are used.
api_name
For API requests, this is the path of the requested resource with the version
prefix removed. The list of resource paths can be found in the
`Swagger API Documentation <https://github.com/hyperledger/fabric-ca/blob/master/swagger/swagger-fabric-ca.json>`_.
`Swagger API Documentation <https://github.com/hyperledger/fabric-ca/blob/main/swagger/swagger-fabric-ca.json>`_.
Examples include ``cainfo``, register``, and ``enroll``.

ca_name
Expand Down
8 changes: 4 additions & 4 deletions docs/source/users-guide.rst
Original file line number Diff line number Diff line change
Expand Up @@ -87,7 +87,7 @@ via the Hyperledger Fabric CA client or through one of the Fabric SDKs.
All communication to the Hyperledger Fabric CA server is via REST APIs.
See `fabric-ca/swagger/swagger-fabric-ca.json` for the swagger documentation
for these REST APIs.
You may view this documentation via the `Swagger online editor <http://editor.swagger.io>`_.
You may view this documentation via the `Swagger online editor <http://editor.swagger.io>`_.

The Hyperledger Fabric CA client or SDK may connect to a server in a cluster
of Hyperledger Fabric CA servers. This is illustrated in the top right section
Expand Down Expand Up @@ -142,7 +142,7 @@ in $GOPATH/bin.
go get -u github.com/hyperledger/fabric-ca/cmd/...
Note: If you have already cloned the fabric-ca repository, make sure you are on the
master branch before running the 'go get' command above. Otherwise, you might see the
main branch before running the 'go get' command above. Otherwise, you might see the
following error:

::
Expand Down Expand Up @@ -1563,7 +1563,7 @@ that are required by the verifier and can do so without being linkable across th

Fabric CA server can issue Idemix credentials in addition to X509 certificates. An Idemix credential can be requested by sending the request to
the ``/api/v1/idemix/credential`` API endpoint. For more information on this and other Fabric CA server API endpoints, please refer to
`swagger-fabric-ca.json <https://github.com/hyperledger/fabric-ca/blob/master/swagger/swagger-fabric-ca.json>`_.
`swagger-fabric-ca.json <https://github.com/hyperledger/fabric-ca/blob/main/swagger/swagger-fabric-ca.json>`_.

The Idemix credential issuance is a two step process. First, send a request with an empty body to the ``/api/v1/idemix/credential``
API endpoint to get a nonce and CA's Idemix public key. Second, create a credential request using the nonce and CA's Idemix public key and
Expand All @@ -1574,7 +1574,7 @@ Credential Revocation Information (CRI), and attribute names and values. Current
- **IsAdmin** - if the identity is an admin or not. The value of this attribute is set to the value of `isAdmin` registration attribute.
- **EnrollmentID** - enrollment ID of the identity

You can refer to the `handleIdemixEnroll` function in https://github.com/hyperledger/fabric-ca/blob/master/lib/client.go for reference implementation
You can refer to the `handleIdemixEnroll` function in https://github.com/hyperledger/fabric-ca/blob/main/lib/client.go for reference implementation
of the two step process for getting Idemix credential.

The ``/api/v1/idemix/credential`` API endpoint accepts both basic and token authorization headers. The basic authorization header should
Expand Down

0 comments on commit 7fd582b

Please sign in to comment.