Naming Standards

Contents

Naming standards

Currently, a lot of flexibility is provided as to how entities in SingularityNET are defined by naming standards.

Initially, the naming standard can result in difficulty to recognize between capitalization and separation of words in names. But these named standard is proposed to be implemented within the code, so that the smart contracts and the software can enforce the named standard definition efficiently in SingularityNET.

This following section describes the naming standards for your reference.

Service URI

A service URI consists of three things:

  • Organization name
  • Service name

e.g. snet/face-detect

Here snet is the organization, and face-detect is the service name.

Service authors should use lowercase alphanumerics, for each of these components. Multiple word components should be slugified with dashes (wikipedia definition of “slug”) (i.e. dashes should separate the words).

This is analogous to a URL on the web. A domain name is case insensitive, and while a URL path can use capitalisation, many web applications will treat these paths as case insensitive.

Service Display Name

The service metadata can specify a display name for showing in the Marketplace and in other UIs and it should remain similar to the service name used in the URI.

Internationalization and UTF-8

These fields are 8bit characters compliance, and can support UTF-8. These fields are not currently tested and supported in the tooling yet.

Note Naming standard for other languages are required, when you attempt to support these fields.

Service Tags

Tags should follow the style of popular sites like Stack Overflow). The service tags are defined in lowercase slugified words, e.g. example-tag tags-are-great opencog artificial-neural-network etc.

Last modified on : 26-May-20

Sign up for developer updates

×