Skip to content

Commit

Permalink
Provide some guidance for CLI-friendly names
Browse files Browse the repository at this point in the history
Closes openservicebrokerapi#305

Signed-off-by: Doug Davis <dug@us.ibm.com>
  • Loading branch information
Doug Davis authored and mihnjong-l committed Jan 29, 2018
1 parent f38ab16 commit 7534804
Showing 1 changed file with 5 additions and 0 deletions.
5 changes: 5 additions & 0 deletions spec.md
Original file line number Diff line number Diff line change
Expand Up @@ -338,6 +338,11 @@ defines a "CLI-friendly" string as a short string that MUST only use lowercase
characters, numbers and hyphens, with no spaces. This will make it easier for
users when they have to type it as an argument on the command line.

For backwards compatibility reasons, this specification does not preclude
the use of CLI-unfriendly strings that might cause problems for command line
parsers (or that are not very meaningful to users), such as `-`.
It is therefore RECOMMENDED that implementations avoid such strings.

| Response field | Type | Description |
| --- | --- | --- |
| services* | array-of-service-objects | Schema of service objects defined below. MAY be empty. |
Expand Down

0 comments on commit 7534804

Please sign in to comment.