Skip to navigation
DevelopmentDevelopment Standards

Resource Naming Conventions

We have to put names on a LOT of things. It will help us if we use consistent names for similar things. This document aims to describe what those things are and how we construct names for them. It is meant as a reference for developers and testers to record our agreed upon choices.

The names we choose are NOT intended to be parsed. We are choosing conventions to make it easier to know what kind of names to use and what they mean. We are not trying to make machine-readable names that can be parsed to tell a program what the resource is based on the name. We are making it so that a HUMAN can do that.

Pub-Sub

Topics

Says what kind of messages go in it. Use dashes to separate words like kind-of-messages. Does not include the word “topic”.

Subscriptions

Same as topic name but has the name of the service that is subscribed like file-intake-valid-external-file.

Message Types

All of our messages currently have a message type name. We should say how those are formed OR we should get rid of that from the system.

Database

Schema, Tables and Columns

This is waiting for our meetings with the DBA.

Indices, Constraints and Foreign Keys

This is waiting for our meetings with the DBA.

Storage Containers?

We cannot fully control this but I think we get to choose a suffix?

REST endpoints?

This may be specified in a different document. We should at least link that.

Server Names?

Service Names?

Status Names?

These are past tense names describing what part of the process is complete when a file has this status. Some examples include “created”, “copied” and “validated”.