Skip to content

Commit

Permalink
Rename: drop Objects from the name of the registry
Browse files Browse the repository at this point in the history
Signed-off-by: Stephen Curran <[email protected]>
  • Loading branch information
swcurran committed Sep 22, 2022
1 parent f0bd521 commit cd2d4be
Show file tree
Hide file tree
Showing 17 changed files with 96 additions and 91 deletions.
10 changes: 5 additions & 5 deletions Contributing.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,15 +5,15 @@ Contributions to this repository are welcome.
All contributions must be submitted as pull requests. The handling of the pull
requests by the maintainers (Editors) of this repository are as defined in the
[Governance
section](https://anoncreds-wg.github.io/anoncreds-objects-methods-registry/) of
section](https://anoncreds-wg.github.io/anoncreds-methods-registry/) of
the [AnonCreds Objects Methods
Registry](https://anoncreds-wg.github.io/anoncreds-objects-methods-registry/).
Registry](https://anoncreds-wg.github.io/anoncreds-methods-registry/).

If you are adding an AnonCreds Objects Methods Registry entry, please follow
If you are adding an AnonCreds Methods Registry entry, please follow
[this
guidance](https://anoncreds-wg.github.io/anoncreds-objects-methods-registry/#adding-a-registry-entry)
guidance](https://anoncreds-wg.github.io/anoncreds-methods-registry/#adding-a-registry-entry)
on the registry webpage for doing that.

Questions, comments and suggestions are welcome via the [GitHub
issues](https://github.com/AnonCreds-WG/anoncreds-objects-methods-registry/issues)
issues](https://github.com/AnonCreds-WG/anoncreds-methods-registry/issues)
section of this repository.
8 changes: 4 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
# The AnonCreds Objects Methods Registry
# The AnonCreds Methods Registry

![AnonCreds Logo](https://raw.githubusercontent.com/AnonCreds-WG/anoncreds-spec/main/spec/images/logo/anoncreds_logo_horizontal.svg)

This repository contains the source documents for the [AnonCreds Objects Methods
Registry](https://anoncreds-wg.github.io/anoncreds-objects-methods-registry).
This repository contains the source documents for the [AnonCreds Methods
Registry](https://anoncreds-wg.github.io/anoncreds-methods-registry).
The registry is referenced in the [AnonCreds
Specification](https://anoncreds-wg.github.io/anoncreds-spec/). AnonCreds
Objects Methods are ways of registering and resolving AnonCreds objects on
Methods are ways of registering and resolving AnonCreds objects on
specific Verifiable Data Registries (VDRs).

This repository and the registry are managed by the AnonCreds Specification Working Group. For more
Expand Down
42 changes: 21 additions & 21 deletions docs/index.html

Large diffs are not rendered by default.

2 changes: 1 addition & 1 deletion package-lock.json

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

6 changes: 3 additions & 3 deletions package.json
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
{
"name": "anoncreds-objects-methods-registry",
"description": "AnonCreds Objects Methods Registry",
"name": "anoncreds-methods-registry",
"description": "AnonCreds Methods Registry",
"version": "1.0.0",
"homepage": "http://github.com/AnonCreds-WG",
"license": "Apache 2",
"repository": {
"type": "git",
"url": "git://github.com/AnonCreds-WG/anoncreds-objects-methods-registry"
"url": "git://github.com/AnonCreds-WG/anoncreds-methods-registry"
},
"dependencies": {
"spec-up": "^0.10.3"
Expand Down
8 changes: 4 additions & 4 deletions registry/adding_a_registry_entry.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,13 @@
## Adding a Registry Entry

To add a new AnonCreds Objects Methods Registry entry please:
To add a new AnonCreds Methods Registry entry please:

- Review the [Governance](#governance) section of this document that describes
who can add/update registry entries, how such updates get approved and
applied.
- Create a pull request in the GitHub repository ([https://github.com/AnonCreds-WG/anoncreds-objects-methods-registry](https://github.com/AnonCreds-WG/anoncreds-objects-methods-registry)) that is the source for generating this webpage, by following these steps:
- Fork [the repository](https://github.com/AnonCreds-WG/anoncreds-objects-methods-registry).
- In your local fork, copy the [`registry/method_template.md`](https://github.com/AnonCreds-WG/anoncreds-objects-methods-registry/blob/main/registry/method_template.md) file
- Create a pull request in the GitHub repository ([https://github.com/AnonCreds-WG/anoncreds-methods-registry](https://github.com/AnonCreds-WG/anoncreds-methods-registry)) that is the source for generating this webpage, by following these steps:
- Fork [the repository](https://github.com/AnonCreds-WG/anoncreds-methods-registry).
- In your local fork, copy the [`registry/method_template.md`](https://github.com/AnonCreds-WG/anoncreds-methods-registry/blob/main/registry/method_template.md) file
to a new file in the same `registry` folder, named as appropriate for the new
registry entry, prefix `method_`, and `.md` extension.
- Update the new file for the AnonCreds Objects Methods
Expand Down
19 changes: 10 additions & 9 deletions registry/governance.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
This registry is managed by the [AnonCreds Specification Working
Group](https://github.com/AnonCreds-WG). The contents of the registry is
maintained in a [GitHub
repository](https://github.com/AnonCreds-WG/anoncreds-objects-methods-registry)
repository](https://github.com/AnonCreds-WG/anoncreds-methods-registry)
and managed through a pull request submission, review and approval process. The
details of how pull requests are managed is outlined in this Governance section
of the registry.
Expand All @@ -24,7 +24,7 @@ roles](https://docs.github.com/en/organizations/managing-access-to-your-organiza
in the repository to manage their work.

- **Implementers** are individuals or organizations that add their AnonCreds
objects method to the registry. Implementers MUST follow the guidelines in the
method to the registry. Implementers MUST follow the guidelines in the
[Adding a Registry Entry](#adding-a-registry-entry) documentation in
submitting pull requests to add or update their method.

Expand All @@ -35,20 +35,21 @@ registry. Anyone with a GitHub account can be a contributor.
- **Readers** are individuals that read the registry and use the information
there in to move forward their use of AnonCreds.

### Types of Repository Content
### Types of Content

There are two types of content in the source repository for the registry:

- The entries in the [AnonCreds Objects Methods Registry](#registry).
- The content of the entries are managed by the implementers of the AnonCreds
Objects methods.
- The entries in the [AnonCreds Methods Registry](#registry).
- The content of the entries are managed by the implementers of specific
AnonCreds methods.
- The format of the entries MUST adhere to the guidelines defined in the
[Method
Template](https://github.com/AnonCreds-WG/anoncreds-objects-methods-registry/blob/main/registry/method_template.md), as defined by the [AnonCreds Specification Working
Template](https://github.com/AnonCreds-WG/anoncreds-methods-registry/blob/main/registry/method_template.md),
as defined by the [AnonCreds Specification Working
Group](https://github.com/AnonCreds-WG).

- All other content in the registry and [registry
repository](https://github.com/AnonCreds-WG/anoncreds-objects-methods-registry)
repository](https://github.com/AnonCreds-WG/anoncreds-methods-registry)
- Such content is governed by the [AnonCreds Specification Working
Group](https://github.com/AnonCreds-WG), and
includes things like this Governance section of the registry, the format of
Expand All @@ -65,7 +66,7 @@ management (governance) of the registry.

The [AnonCreds Specification Working Group](https://github.com/AnonCreds-WG) has
delegated to the Editors the authority to merge pull requests of any [type of
content](#types-of-repository-content) as follows:
content](#types-of-content) as follows:

- Based on an explicit vote of the [AnonCreds Specification Working
Group](https://github.com/AnonCreds-WG) to merge the pull request; or
Expand Down
10 changes: 5 additions & 5 deletions registry/header.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,11 @@
AnonCreds Objects Methods Registry
AnonCreds Methods Registry
==================

**Registry Status**: v0.1 Draft

**Latest Draft:**
**Source Content:**

[https://github.com/AnonCreds-WG/anoncreds-objects-methods-registry](https://github.com/AnonCreds-WG/anoncreds-objects-methods-registry)
[https://github.com/AnonCreds-WG/anoncreds-methods-registry](https://github.com/AnonCreds-WG/anoncreds-methods-registry)

**Editors:**

Expand All @@ -18,8 +18,8 @@ AnonCreds Objects Methods Registry

**Participate:**

~ [GitHub repo](https://github.com/AnonCreds-WG/anoncreds-objects-methods-registry)
~ [Commit history](https://github.com/AnonCreds-WG/anoncreds-objects-methods-registry/commits/main)
~ [GitHub repo](https://github.com/AnonCreds-WG/anoncreds-methods-registry)
~ [Commit history](https://github.com/AnonCreds-WG/anoncreds-methods-registry/commits/main)
~ [Discord](https://discord.gg/hYmBNhTFY9)

------------------------------------
11 changes: 8 additions & 3 deletions registry/introduction.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,12 @@
## Introduction

The AnonCreds Objects Methods Registry contains a list of entries that point to specifications and implementations for the publishing (registering) and retrieving (resolving) AnonCreds Objects
as defined in the AnonCreds Specification. The registry is managed by the AnonCreds Working Group, and is governed by the rules outlined in the [Governance](#governance) section of this
The AnonCreds Methods Registry contains a list of entries that point to
specifications and implementations for the publishing (registering) and
retrieving (resolving) AnonCreds objects as defined in the AnonCreds
Specification. The registry is managed by the AnonCreds Working Group, and is
governed by the rules outlined in the [Governance](#governance) section of this
document.

For more information about AnonCreds ZKP verifiable credentials, please see the latest [AnonCreds Specification](https://anoncreds-wg.github.io/anoncreds-spec/).
For more information about AnonCreds ZKP verifiable credentials, please see the
latest [AnonCreds
Specification](https://anoncreds-wg.github.io/anoncreds-spec/).
10 changes: 5 additions & 5 deletions registry/method_cheqd.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,15 @@
### cheqd AnonCreds Objects Method
### cheqd AnonCreds Method

The cheqd AnonCreds objects method specifies how to register and resolve
AnonCreds objects as general purpose resources on the cheqd Verifiable Data
The cheqd AnonCreds method specifies how to register and resolve
AnonCreds objects as general purpose resources on the [cheqd.io](https://cheqd.io) Verifiable Data
Registry. The identifiers for the resources are DID URLs that are dereferenced
to return the AnonCreds objects.

The "In Development" below is the AnonCreds Objects Method status. The cheqd
The "In Development" below is the AnonCreds Method status. The [cheqd.io](https://cheqd.io)
network itself is fully deployed and operational.

- Status: In Development
- Verifiable Data Registry: [cheqd Data Network](https://cheqd.io)
- Verifiable Data Registry: [cheqd.io Data Network](https://cheqd.io)
- Contact Name: Ankur Banerjee
- Contact Email: [email protected]
- Contact Website: [https://cheqd.io](https://cheqd.io)
Expand Down
16 changes: 8 additions & 8 deletions registry/method_did_indy.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
### `did:indy` AnonCreds Objects Method
### `did:indy` AnonCreds Method

The `did:indy` AnonCreds objects method uses registration and resolution methods
The `did:indy` AnonCreds method uses registration and resolution methods
implemented in later Hyperledger Indy clients (such as those based on [Indy
VDR](https://github.com/hyperledger/indy-vdr)). The `did:indy` AnonCreds objects
VDR](https://github.com/hyperledger/indy-vdr)). The `did:indy` AnonCreds
identifiers are URIs (to be precise DID URLs with path elements to identify the
specific AnonCreds object), evolved from the identifiers used initially in
Hyperledger Indy. The objects are registered and resolved using the same tools
as the [Hyperledger Indy AnonCreds objects
method](#hyperledger-indy-anoncreds-object-method), with the primary difference
being the AnonCreds objects identifiers within the objects themselves.
specific AnonCreds object type), evolved from the identifiers used in the initial
Hyperledger Indy AnonCreds implementatation. The objects are registered and resolved using the same tools
as the [Hyperledger Indy AnonCreds
method](#hyperledger-indy-legacy-anoncreds-method), with the primary difference
being the AnonCreds identifiers within the objects themselves.

- Status: Not deployed
- Verifiable Data Registry: Hyperledger Indy instances
Expand Down
11 changes: 5 additions & 6 deletions registry/method_http.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
### HTTP AnonCreds Objects Method
### HTTP AnonCreds Method

The HTTP AnonCreds objects method uses HTTP URLs as AnonCreds object
The HTTP AnonCreds method uses HTTP URLs as AnonCreds object
identifiers. For this method, the resolution is simple: dereference the URL
to retrieve the published object. While this approach is fairly simple, it
is not recommended for production use for a number of reasons:
Expand All @@ -13,15 +13,14 @@ is not recommended for production use for a number of reasons:
surveillance by the web service operator,
- the possibility of rendering the issued credentials useless because the web
service is removed by its operator, making the AnonCreds objects unresolvable.
- the challenge/impossibility of implementing the AnonCreds Revocation scheme.

The simplicity of this AnonCreds objects method may make it useful for testing.
The simplicity of this AnonCreds method may make it useful for testing.
Those considering using a web server as a Verifiable Data Registry would likely
be better to use an AnonCreds objects method based on
be better to use an AnonCreds method based on
[`did:web`](https://w3c-ccg.github.io/did-method-web/).

- Status: In Development
- Verifiable Data Registry: HTTP File Servers
- Verifiable Data Registry: HTTP Web Servers
- Contact Name: Stephen Curran
- Contact Email: [email protected]
- Contact Website: To Be Added
Expand Down
12 changes: 6 additions & 6 deletions registry/method_legacy_indy.md
Original file line number Diff line number Diff line change
@@ -1,18 +1,18 @@
### Hyperledger Indy Legacy AnonCreds Objects Method
### Hyperledger Indy Legacy AnonCreds Method

The Hyperledger Indy Legacy AnonCreds objects method is the mechanism implemented in
the early Hyperledger Indy instances, prior to the implementation of `did:indy`
The Hyperledger Indy Legacy AnonCreds method is the mechanism implemented in
early Hyperledger Indy instances, prior to the implementation of `did:indy`
support. It is unique in this registry in that its identifiers are **not** URIs,
but instead are as defined by the original open source developers of Indy. This
method is deprecated and issuers using Hyperledger Indy ledgers are recommended
to use the [`did:indy` AnonCreds Objects
method](#didindy-anoncreds-objects-method) wherever possible.
to use the [`did:indy` AnonCreds
method](#didindy-anoncreds-method) wherever possible.

- Status: Deployed
- Verifiable Data Registry: Hyperledger Indy instances
- Contact Name: Stephen Curran
- Contact Email: [email protected]
- Contact Website: [Hyperledger Indy documentation](https://hyperledger-indy.readthedocs.io)
- Specification: Details can be found in [Hyperledger Indy documentation on
registering/retrieve AnonCreds
registering/retrieving AnonCreds
objects](https://hyperledger-indy.readthedocs.io/projects/node/en/latest/requests.html#requests)
6 changes: 3 additions & 3 deletions registry/method_template.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
### \<NAME OF METHOD\> AnonCreds Objects Method
### \<NAME OF METHOD\> AnonCreds Method

Replace this with a note about the AnonCreds Object Method.
Replace this with a note about the AnonCreds Method.
The details can be as much or as little as needed, but this
is not the specification itself, just an overview and context
about the method.

- Status: \<In Development, Deployed>
- Verifiable Data Registry: \<Where the AnonCreds Objects are stored>
- Verifiable Data Registry: \<Where the AnonCreds objects are stored>
- Contact Name: \<Name of Contact>
- Contact Email: \<Email Address of Contact>
- Contact Website: \<Website (perhaps git repo of spec) for method or VDR --
Expand Down
8 changes: 4 additions & 4 deletions registry/registry.md
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
## Registry

This section summarizes the AnonCreds Objects methods currently in available.
This section summarizes the AnonCreds methods currently in available.
The links and status are updated by their respective implementers as they
evolved, as per the [registry governance rules](#governance).

The normative requirements for AnonCreds Objects method specifications can be
The normative requirements for AnonCreds method specifications can be
found in the [AnonCreds
Specification](https://anoncreds-wg.github.io/anoncreds-spec/). AnonCreds
Objects methods that do not meet the guidelines as outlined in the [method entry
template](https://github.com/AnonCreds-WG/anoncreds-objects-methods-registry)
methods that do not meet the guidelines as outlined in the [method entry
template](https://github.com/AnonCreds-WG/anoncreds-methods-registry)
will not be accepted.
2 changes: 1 addition & 1 deletion registry/status_copyright_toc.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,7 +5,7 @@ It represents the consensus of the AnonCreds community.

Information about the current status of this document, any errata,
and how to provide feedback on it may be obtained at
[https://github.com/AnonCreds-WG/anoncreds-objects-methods-registry](https://github.com/AnonCreds-WG/anoncreds-objects-methods-registry).
[https://github.com/AnonCreds-WG/anoncreds-methods-registry](https://github.com/AnonCreds-WG/anoncreds-methods-registry).

## Copyright Notice

Expand Down
6 changes: 3 additions & 3 deletions specs.json
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
{
"specs": [
{
"title": "AnonCreds Objects Methods Registry",
"title": "AnonCreds Methods Registry",
"spec_directory": "./registry",
"output_path": "./docs",
"markdown_paths": [
Expand All @@ -17,11 +17,11 @@
"governance.md"
],
"logo": "https://raw.githubusercontent.com/AnonCreds-WG/anoncreds-spec/main/spec/images/logo/anoncreds_logo_horizontal.svg",
"logo_link": "https://github.com/AnonCreds-WG/anoncreds-objects-methods-registry",
"logo_link": "https://github.com/AnonCreds-WG/anoncreds-methods-registry",
"source": {
"host": "github",
"account": "AnonCreds-WG",
"repo": "anoncreds-objects-methods-registry"
"repo": "anoncreds-methods-registry"
}
}
]
Expand Down

0 comments on commit cd2d4be

Please sign in to comment.