Merge pull request #962 from joyent/ether/v3-b3-misc-fixes

v3 b3 misc fixes

docs/json-schema/request.json

@@ -233,7 +233,7 @@
       "additionalProperties" : false,
       "properties" : {
         "alias" : {
-          "$ref" : "common.json#/definitions/non_empty_string"
+          "$ref" : "common.json#/definitions/mojo_standard_placeholder"
         },
         "az" : {
           "$ref" : "common.json#/definitions/non_empty_string"
@@ -257,7 +257,7 @@
       "minProperties" : 1,
       "properties" : {
         "alias" : {
-          "$ref" : "common.json#/definitions/non_empty_string"
+          "$ref" : "common.json#/definitions/mojo_standard_placeholder"
         },
         "az" : {
           "$ref" : "common.json#/definitions/non_empty_string"
@@ -872,7 +872,7 @@
           "$ref" : "common.json#/definitions/uuid"
         },
         "name" : {
-          "$ref" : "common.json#/definitions/non_empty_string"
+          "$ref" : "common.json#/definitions/mojo_relaxed_placeholder"
         },
         "phase" : {
           "$ref" : "common.json#/definitions/device_phase"
@@ -982,7 +982,7 @@
       "minProperties" : 1,
       "properties" : {
         "name" : {
-          "$ref" : "common.json#/definitions/non_empty_string"
+          "$ref" : "common.json#/definitions/mojo_standard_placeholder"
         },
         "rack_size" : {
           "$ref" : "common.json#/definitions/positive_integer"
@@ -1011,7 +1011,7 @@
           "$ref" : "common.json#/definitions/uuid"
         },
         "name" : {
-          "$ref" : "common.json#/definitions/non_empty_string"
+          "$ref" : "common.json#/definitions/mojo_relaxed_placeholder"
         },
         "phase" : {
           "$ref" : "common.json#/definitions/device_phase"

docs/json-schema/response.json

@@ -63,7 +63,7 @@
           "$ref" : "common.json#/definitions/uuid"
         },
         "name" : {
-          "$ref" : "common.json#/definitions/mojo_relaxed_placeholder"
+          "$ref" : "common.json#/definitions/mojo_standard_placeholder"
         },
         "started" : {
           "oneOf" : [
@@ -219,7 +219,7 @@
       "additionalProperties" : false,
       "properties" : {
         "alias" : {
-          "type" : "string"
+          "$ref" : "common.json#/definitions/mojo_standard_placeholder"
         },
         "az" : {
           "type" : "string"
@@ -785,7 +785,7 @@
         "rack_name" : {
           "oneOf" : [
             {
-              "type" : "string"
+              "$ref" : "common.json#/definitions/mojo_relaxed_placeholder"
             },
             {
               "type" : "null"
@@ -1862,7 +1862,7 @@
           "$ref" : "common.json#/definitions/uuid"
         },
         "name" : {
-          "$ref" : "common.json#/definitions/mojo_relaxed_placeholder"
+          "$ref" : "common.json#/definitions/mojo_standard_placeholder"
         },
         "users" : {
           "items" : {
@@ -2016,7 +2016,7 @@
           "$ref" : "common.json#/definitions/uuid"
         },
         "name" : {
-          "type" : "string"
+          "$ref" : "common.json#/definitions/mojo_relaxed_placeholder"
         },
         "phase" : {
           "$ref" : "common.json#/definitions/device_phase"
@@ -2158,7 +2158,7 @@
           "$ref" : "common.json#/definitions/uuid"
         },
         "name" : {
-          "type" : "string"
+          "$ref" : "common.json#/definitions/mojo_standard_placeholder"
         },
         "rack_size" : {
           "$ref" : "common.json#/definitions/positive_integer"
@@ -2415,7 +2415,7 @@
                 "$ref" : "common.json#/definitions/uuid"
               },
               "name" : {
-                "$ref" : "common.json#/definitions/mojo_relaxed_placeholder"
+                "$ref" : "common.json#/definitions/mojo_standard_placeholder"
               },
               "role" : {
                 "$ref" : "common.json#/definitions/role"
@@ -3146,13 +3146,13 @@
               "$ref" : "common.json#/definitions/uuid"
             },
             "name" : {
-              "type" : "string"
+              "$ref" : "common.json#/definitions/mojo_relaxed_placeholder"
             },
             "phase" : {
               "$ref" : "common.json#/definitions/device_phase"
             },
             "rack_role_name" : {
-              "type" : "string"
+              "$ref" : "common.json#/definitions/mojo_standard_placeholder"
             },
             "rack_size" : {
               "$ref" : "common.json#/definitions/positive_integer"
@@ -3213,10 +3213,10 @@
                 "$ref" : "common.json#/definitions/uuid"
               },
               "rack_name" : {
-                "type" : "string"
+                "$ref" : "common.json#/definitions/mojo_relaxed_placeholder"
               },
               "rack_role_name" : {
-                "type" : "string"
+                "$ref" : "common.json#/definitions/mojo_standard_placeholder"
               },
               "rack_unit_start" : {
                 "$ref" : "common.json#/definitions/positive_integer"

docs/modules/Conch::Command::fix_usernames.md

@@ -11,3 +11,11 @@ bin/conch fix_usernames [long options...]
 
     --help        print usage message and exit
 ```
+
+# LICENSING
+
+Copyright Joyent, Inc.
+
+This Source Code Form is subject to the terms of the Mozilla Public License,
+v.2.0. If a copy of the MPL was not distributed with this file, You can obtain
+one at [http://mozilla.org/MPL/2.0/](http://mozilla.org/MPL/2.0/).

docs/modules/Conch::Command::force_password_change.md

@@ -12,3 +12,11 @@ bin/conch force_password_change [long options...]
 
     --help          print usage message and exit
 ```
+
+# LICENSING
+
+Copyright Joyent, Inc.
+
+This Source Code Form is subject to the terms of the Mozilla Public License,
+v.2.0. If a copy of the MPL was not distributed with this file, You can obtain
+one at [http://mozilla.org/MPL/2.0/](http://mozilla.org/MPL/2.0/).

docs/modules/Conch::Command::workspace_to_build.md

@@ -11,3 +11,11 @@ bin/conch workspace_to_build [long options...] <workspace name> [workspace name]
 
     --help        print usage message and exit
 ```
+
+# LICENSING
+
+Copyright Joyent, Inc.
+
+This Source Code Form is subject to the terms of the Mozilla Public License,
+v.2.0. If a copy of the MPL was not distributed with this file, You can obtain
+one at [http://mozilla.org/MPL/2.0/](http://mozilla.org/MPL/2.0/).

docs/modules/Conch::Controller::Build.md

@@ -19,11 +19,11 @@ Requires the user to be a system admin.
 
 ## find\_build
 
-Chainable action that validates the `build_id` or `build_name` provided in the
-path, and stashes the query to get to it in `build_rs`.
+Chainable action that uses the `build_id_or_name` value provided in the stash (usually via the
+request URL) to look up a build, and stashes the query to get to it in `build_rs`.
 
 If `require_role` is provided, it is used as the minimum required role for the user to
-continue; otherwise the user must be a system admin.
+continue; otherwise the user must have the 'admin' role.
 
 ## get
 

docs/modules/Conch::Controller::Datacenter.md

@@ -6,7 +6,8 @@ Conch::Controller::Datacenter
 
 ## find\_datacenter
 
-Handles looking up the object by id.
+Chainable action that uses the `datacenter_id` value provided in the stash (usually via the
+request URL) to look up a datacenter, and stashes the result in `datacenter`.
 
 ## get\_all
 

docs/modules/Conch::Controller::DatacenterRoom.md

@@ -6,7 +6,9 @@ Conch::Controller::DatacenterRoom
 
 ## find\_datacenter\_room
 
-Handles looking up the object by id or alias.
+Chainable action that uses the `datacenter_room_id_or_alias` value provided in the stash
+(usually via the request URL) to look up a datacenter\_room, and stashes the result in
+`datacenter_room`.
 
 ## get\_all
 

docs/modules/Conch::Controller::Device.md

@@ -6,11 +6,12 @@ Conch::Controller::Device
 
 ## find\_device
 
-Chainable action that uses the `device_id_or_serial_number` provided in the path
-to find the device and verify the user has the required role to operate on it.
+Chainable action that uses the `device_id`, `device_serial_number` or
+`device_id_or_serial_number` provided in the stash (usually via the request URL) to look up a
+device, and stashes the query to get to it in `device_rs`.
 
 If `require_role` is provided, it is used as the minimum required role for the user to
-continue.
+continue; otherwise the user must be a registered relay user or a system admin.
 
 If `phase_earlier_than` is provided, `409 CONFLICT` is returned if the device is in the
 provided phase (or later).

docs/modules/Conch::Controller::DeviceInterface.md

@@ -6,7 +6,9 @@ Conch::Controller::Device
 
 ## find\_device\_interface
 
-Chainable action that looks up the device interface by its id or name.
+Chainable action that uses the `interface_name` value provided in the stash (usually via the
+request URL) to look up a device interface, and stashes the query to get to it in
+`device_interface_rs`.
 
 ## get\_one\_field
 

docs/modules/Conch::Controller::DeviceReport.md

@@ -21,8 +21,11 @@ Uses a device report to populate configuration information about the given devic
 
 ## find\_device\_report
 
-Chainable action that validates the 'device\_report\_id' provided in the path.
-Stores the device\_id and device\_report resultset to the stash for later retrieval.
+Chainable action that uses the `device_report_id` value provided in the stash (usually via the
+request URL) to look up a device report, and stashes the query to get to it in
+`device_report_rs`.
+
+`device_id` is also saved to the stash.
 
 Role checks are done in the next controller action in the chain.
 

docs/modules/Conch::Controller::HardwareProduct.md

@@ -12,8 +12,11 @@ Response uses the HardwareProducts json schema.
 
 ## find\_hardware\_product
 
-Chainable action that looks up the object by id, sku, name or alias depending on the url
-pattern, stashing the query to get to it in `hardware_product_rs`.
+Chainable action that uses the `hardware_product_id` or `hardware_product_key` and
+`hardware_product_value` values provided in the stash (usually via the request URL) to look up
+a hardware\_product, and stashes the query to get to it in `hardware_product_rs`.
+
+Supported keys are: `sku`, `name`, and `alias`.
 
 ## get
 

docs/modules/Conch::Controller::HardwareVendor.md

@@ -1,12 +1,13 @@
 # NAME
 
-Conch::Controller::User
+Conch::Controller::HardwareVendor
 
 # METHODS
 
 ## find\_hardware\_vendor
 
-Handles looking up the object by id or name.
+Chainable action that uses the `hardware_vendor_id_or_name` value provided in the stash
+(usually via the request URL) to look up a build, and stashes the result in `hardware_vendor`.
 
 ## get\_all
 

docs/modules/Conch::Controller::Organization.md

@@ -24,10 +24,12 @@ Requires the user to be a system admin.
 
 ## find\_organization
 
-Chainable action that validates the `organization_id` or `organization_name` provided in the
-path, and stashes the query to get to it in `organization_rs`.
+Chainable action that uses the `organization_id_or_name` value provided in the stash (usually
+via the request URL) to look up a build, and stashes the query to get to it in
+`organization_rs`.
 
-Requires the 'admin' role on the organization (or the user to be a system admin).
+If `require_role` is provided, it is used as the minimum required role for the user to
+continue; otherwise the user must have the 'admin' role.
 
 ## get
 

docs/modules/Conch::Controller::Rack.md

@@ -6,7 +6,11 @@ Conch::Controller::Rack
 
 ## find\_rack
 
-Supports rack lookups by uuid.
+Chainable action that uses the `rack_id` value provided in the stash (usually via the
+request URL) to look up a rack, and stashes the query to get to it in `rack_rs`.
+
+If `require_role` is provided, it is used as the minimum required role for the user to
+continue; otherwise the user must be a system admin.
 
 ## create
 
@@ -55,8 +59,8 @@ Assigns devices to rack layouts, also optionally updating serial\_numbers and as
 creating the device if needed). Existing devices in referenced slots will be unassigned as needed.
 
 Note: the assignment is still performed even if there is no physical room in the rack
-for the new hardware (its rack\_unit\_size overlaps into a subsequent layout), or that
-the device's hardware matches what the layout specifies.
+for the new hardware (its rack\_unit\_size overlaps into a subsequent layout), or if the device's
+hardware doesn't match what the layout specifies.
 
 ## delete\_assignment
 

docs/modules/Conch::Controller::RackLayout.md

@@ -6,7 +6,8 @@ Conch::Controller::RackLayout
 
 ## find\_rack\_layout
 
-Supports rack layout lookups by id.
+Chainable action that uses the `layout_id` value provided in the stash (usually via the
+request URL) to look up a build, and stashes the query to get to it in `layout_rs`.
 
 ## create
 

docs/modules/Conch::Controller::RackRole.md

@@ -6,7 +6,8 @@ Conch::Controller::RackRole
 
 ## find\_rack\_role
 
-Supports rack role lookups by uuid and name.
+Chainable action that uses the `rack_role_id_or_name` value provided in the stash (usually via
+the request URL) to look up a build, and stashes the result in `rack_role`.
 
 ## create
 

docs/modules/Conch::Controller::Relay.md

@@ -17,8 +17,11 @@ Response uses the Relays json schema.
 
 ## find\_relay
 
-Chainable action that looks up the relay by id or serial\_number,
-stashing the query to get to it in `relay_rs`.
+Chainable action that uses the `relay_id_or_serial_number` provided in the stash (usually
+via the request URL), and stashes the query to get to it in `relay_rs`.
+
+The relay must have been registered by the user to continue; otherwise the user must be a
+system admin.
 
 ## get
 

docs/modules/Conch::Controller::User.md

@@ -6,8 +6,8 @@ Conch::Controller::User
 
 ## find\_user
 
-Chainable action that validates the `target_user_id_or_email` provided in the path, and
-stashes the corresponding user row in `target_user`.
+Chainable action that uses the `target_user_id_or_email` value provided in the stash (usually
+via the request URL) to look up a user, and stashes the result in `target_user`.
 
 ## revoke\_user\_tokens
 

docs/modules/Conch::Controller::Validation.md

@@ -14,7 +14,8 @@ Response uses the Validations json schema (including deactivated ones).
 
 ## find\_validation
 
-Find the Validation specified by uuid or name, and stashes the query to get to it in
+Chainable action that uses the `validation_id_or_name` value provided in the stash (usually
+via the request URL) to look up a validation, and stashes the query to get to it in
 `validation_rs`.
 
 ## get

docs/modules/Conch::Controller::ValidationPlan.md

@@ -14,7 +14,8 @@ Response uses the ValidationPlans json schema.
 
 ## find\_validation\_plan
 
-Find the Validation Plan specified by uuid or name and put it in the stash as
+Chainable action that uses the `validation_plan_id_or_name` provided in the stash
+(usually via the request URL) to look up a validation\_plan, and stashes the result in
 `validation_plan`.
 
 ## get