Page History

...

• 3) REST API
  •    Installation nfv-toscaparser microservice, and run it;
  •    Use Restfual API
    
    •  List template versions
      
      • PATH: /v1/template_versions
      • METHOD:  GET
      • Decription: Lists all supported tosca template versions.
        

      • Response Codes

        Success

        Code	Reason
        200 - OK	Request was successful.

        Error

        Code	Reason
        400 - Bad Request	Some content in the request was invalid.
        404 - Not Found	The requested resource could not be found.
        500 - Internal Server Error	Something went wrong inside the service. This should not happen usually. If it does happen, it means the server has experienced some serious problems.

        Request Parameters

        Name	Type	Description
        No

        Response Parameters

        Name	Type	Description
        template_versions	array	A list of tosca template version object each describes the type name and version information for a template version.

    • Validates a service template
      • PATH: /v1/validate
      • METHOD:  POST
      • Decription: Validate a service template .and return the result
        
        

      • Response Codes

        Success

        Code	Reason
        200 - OK	Request was successful.

        Error

        Code	Reason
        400 - Bad Request	Some content in the request was invalid.
        500 - Internal Server Error	Something went wrong inside the service. This should not happen usually. If it does happen, it means the server has experienced some serious problems.

        Request Parameters

        Name	Type	Description
        environment (Optional)	object	A JSON environment for the template service.
        environment_files (Optional)	object	An ordered list of names for environment files found in the files dict.
        files (Optional)	object	Supplies the contents of files referenced in the template or the environment. The value is a JSON object, where each key is a relative or absolute URI which serves as the name of a file, and the associated value provides the contents of the file. The following code shows the general structure of this parameter. { ... "files": { "fileA.yaml": "Contents of the file", "file:///usr/fileB.template": "Contents of the file", "http://example.com/fileC.template": "Contents of the file" } ... }
        ignore_errors (Optional)	string	List of comma-separated error codes to ignore.
        show_nested (Optional)	boolean	Set to Set true to include nested template service in the list.
        template (Optional)	object	The service template on which to perform the operation. This parameter is always provided as a string in the JSON request body. The content of the string is a JSON- or YAML-formatted service template. For example: "template": { "tosca_definitions_version": "tosca_simple_yaml_1_0", ... } This parameter is required only when you omit the template_url parameter. If you specify both parameters, this value overrides thetemplate_url parameter value.
        template_url (Optional)	string	A URI to the location containing the service template on which to perform the operation. See the description of the template parameter for information about the expected template content located at the URI. This parameter is only required when you omit the template parameter. If you specify both parameters, this parameter is ignored.

        Request Example

        {
            "template_url": "/PATH_TO_TOSCA_TEMPLATES/HelloWord_Instance.csar"
        }

        Response Parameters

        Name	Type	Description
        Description	string	The description specified in the template.
        Error Information (Optional)	string	Error information

    • Parse a service template

      • PATH: /v1/parse
      • METHOD:  POST
      • Decription:  Validate Parse a service template .and return the parsed info
      • Response Code: same as "Validates a service template"
        
      • Request Parameters: same as "Validates a service template"
        
      • Response Parameters

      Name	Type	Description
      Description	string	The description specified in the template.
      Input parameters	object	Input parameter list.
      Service Template	object	Service template body
      Output parameters	object	Input parameter list.
      Error Information (Optional)	string	Error information

...