feat: only return register token against localhost, add descriptions to fields

[golanglemonade]

• We currently return the verify token on the register request to make dev easier, however, we shouldn't directly return the email verification token on the response in prod. This changes it to only return it when the server is running with dev:true and removes the field from the OpenAPI spec.

server.dev=true

(⎈ |default:default)➜  core-more git:(feat-verify) ✗ go run cmd/cli/main.go register --email="[email protected]" --first-name=sarah --last-name=funk -p test\!1234asd -z json
{
  "email": "[email protected]",
  "message": "Welcome to Openlane!",
  "success": true,
  "token": "eYPdf61gNyT6__OqT-_6eUwak7j9hkBKxI9z7gO4ZGM",
  "user_id": "01JJHTJA7DY351YM6DJH5N6VN3"
}

server.dev=false

(⎈ |default:default)➜  core-more git:(feat-verify) ✗ go run cmd/cli/main.go register --email="[email protected]" --first-name=sarah --last-name=funk -p test\!1234asd -z json
{
  "email": "[email protected]",
  "message": "Welcome to Openlane!",
  "success": true,
  "user_id": "01JJHTMJRVVAS50XE0VDS4PZJE"
}

• Adds description + examples to openAPI spec

Example updated api spec section:

  "RegisterReply": {
        "properties": {
          "email": {
            "description": "The email address of the user",
            "type": "string"
          },
          "error": {
            "description": "The error message if the request was unsuccessful",
            "type": "string"
          },
          "error_code": {
            "description": "The error code if the request was unsuccessful",
            "type": "string"
          },
          "message": {
            "type": "string"
          },
          "success": {
            "description": "Whether or not the request was successful or not",
            "type": "boolean"
          },
          "unverified": {
            "type": "boolean"
          },
          "user_id": {
            "description": "The ID of the user that was created",
            "example": "01J4EXD5MM60CX4YNYN0DEE3Y1",
            "type": "string"
          }
        },
        "type": "object"
      },
      "RegisterRequest": {
        "properties": {
          "email": {
            "description": "The email address of the user",
            "example": "[email protected]",
            "type": "string"
          },
          "first_name": {
            "description": "The first name of the user",
            "example": "Jon",
            "type": "string"
          },
          "last_name": {
            "description": "The last name of the user",
            "example": "Snow",
            "type": "string"
          },
          "password": {
            "description": "The password to be used for authentication after registration",
            "example": "Wint3rIsC0ming123!",
            "type": "string"
          }
        },
        "type": "object"
      },

[sonarqubecloud]

Quality Gate passed

Issues
0 New issues
0 Accepted issues

Measures
0 Security Hotspots
30.8% Coverage on New Code
0.0% Duplication on New Code

See analysis details on SonarQube Cloud