Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

  • GET - Lists all defined user workflows for the specified service id (positive integer)
    • Returned structure: simple JSON list with workflow names, e.g. '[ "install", "uninstall" ]'

/api/0.1/templates

  • POST - Validates a TOSCA template based on the JSON formatted POST body (content type = application/json)
    • POST body keys and usage:
      • service_template_path,  string, required, URL to template or CSAR
      • service_template_filename, string, optional, default to service-template.yaml
    • Example body:

...

  • GET - Returns JSON list of stored service templates.
    • Returned structure:
            [
                  {
                     "name": <service template name>,
                     "description": <service template description>,
                     "id": <service template id (positive integer)>

                             }

                             {

                                  ......

                              }

                        ]

/api/0.1/templates/<template_id> 

...

  • GET - Returns JSON formatted list of node template templates in specified template id (positive integer)
      • Returned structure:
             [
                {
                   "id": <node id>,
                   "name": <node name>,
                   "description": <node description>,

                                  "service_template_id": <service template id (positive integer)>,

                                  "type_name": <node type name>

                              }

                           {

                                ......

                            }

                      ]

/api/0.1/templates/<template_id>/services/<service_name>

  • POST  - Creates a service from the specified service template id (positive integer)
    • Body encoding:
             {
               "inputs": "input1=value1; input2=value2..."

                     }


/api/0.1/templates/<template_name>

  • PUT - Installed a service template in ARIA storage based on PUT body and encoding.
    • Body encoding based on content-type in request:
      • json encoding:
        {
                   "template_path": <url to stored template or CSAR>,

                                      "template_filename":  <name of main template file (optional, default = service-template.yaml)

                               }

      • application/zip encoding:  assumes body is a binary CSAR blob.  If custom service template filename needed, pass in URL request args as ?service_template_filename=name.
      • text/plain: assumes the body is a single file template.