Document error

If 'Description' field is omitted in manifest.yaml file, the following
exception will be raised.

murano package-import ./HelloWorld/hello_world.zip
Failed to create package for './HelloWorld/hello_world.zip',
reason: Invalid Murano package E020 Missing required key
"Description" (HTTP 400)

Change-Id: I9096bf1a3dc56e2d9e5c335f4bfefddf0fd60108
This commit is contained in:
chenaidong1 2017-09-27 09:23:23 +08:00 committed by Felipe Monteiro
parent 1ea1cda5d4
commit a024fa6936
2 changed files with 10 additions and 4 deletions

View File

@ -56,6 +56,8 @@ domain-specific prefix.
Murano, while a ``Library`` is bundle of reusable scenarios which may be used
by other packages. For now we just need a single standalone app, so let's
choose an ``Application`` type.
The ``Description`` is a text attribute, providing detailed info about your
package.
Enter these values and save the file. You should have something like this:
@ -64,7 +66,10 @@ Enter these values and save the file. You should have something like this:
FullName: com.yourdomain.HelloWorld
Type: Application
Description: |
A package which demonstrates
development for Murano
by greeting the user.
This is the minimum required to start. We'll add more manifest data later.

View File

@ -392,6 +392,10 @@ part contained only mandatory fields. This is how it should look by now:
FullName: com.yourdomain.HelloWorld
Type: Application
Description: |
A package which demonstrates
development for Murano
by greeting the user.
Classes:
com.yourdomain.HelloWorld: HelloWorld.yaml
@ -401,9 +405,6 @@ First, you can add a ``Name`` attribute. Unlike ``FullName``, it is not a
unique identifier of the package. But, if specified, it overrides the name of
the package that is displayed in the catalog.
Then there is a ``Description`` field. This is a multi-line text attribute,
providing detailed info about your package.
Then an ``Author`` field: here you can put your name or the name of your
company, so it will be displayed in catalog as the name of the package
developer. If this field is omitted, the catalog will consider the package to