Skip to content

Latest commit

 

History

History
229 lines (208 loc) · 6.59 KB

files_interface.md

File metadata and controls

229 lines (208 loc) · 6.59 KB
Raw

Files Interface

This interface give the possibility to manage the VNF images files of NFStore.

Upload file

This method allows to upload a file to NF Store.

The file should be inserted into HTML body as parts of a multipart/form-data Content.
The Content-Type field of the part should be configured to application/octet-stream.
The Content-Disposition field of the part should be configured setting name to file and filename with the name of file to upload.
The response header Location field report the URL to be used for the other request about this object.
The response body return the name of the file and the Id list of VNF Descriptors that use the files.

  • URL: /NFS/files
  • Method: POST
  • URL Parameters
    • Required Parameters:
    • Optional Parameters:
  • Header Parameters
    • Required Parameters:
    

    • 



Content-Type: multipart/form-data;
boundary=


- *Optional Parameters:*
 ```html
MD5SUM: <md5 checksum>
Provider-ID: <provider Id>
Image-Type: <image type>



    

  • Data Parameters
    

    

    • 



--uuid:
Content-Type: application/octet-stream
Content-Transfer-Encoding: binary
Content-Disposition: form-data; name="file"; filename=


   ```html
MD5SUM: <md5 checksum>
Provider-ID: <provider Id>
Image-Type: <image type>



<file data>
--uuid:<uuid code>--


    

  • Success Response:

      

    • Code: 201 Created
      • 

    • Content:
      • 

    

    {
"name": <filename>,
"vnfd_id": [<vnfd Id 1>, ..., <vnfd Id N>]
}
    

    • 



- **Error Response:**
  - *Code:* **`400 Bad Request`**
  - *Code:* **`404 Not Found `**
  - *Code:* **`500 Internal Server Error`**
- **Sample Call:**
- **Notes:**
MD5SUM, Provider-ID and Image-Type fields can be inserted either into html header or into multipart header.<br/>
  - **MD5SUM**      : mandatory - the value will be compared with the computed value on received file<br/>
  - **Image-Type**  : optional  - if not detected the default value *unknown* will be used.<br/>
  - **Provider-ID** : optional  - if not detected the field will be left empty.<br/>


## Download file
This method allows to get from NF Store the file specified into request.<br/>

The file is returned in the HTML body as raw file or as part of a *multipart/form-data* Content; to have the response with multipart/form-data the request should contain the optional parameter *contentType=multipart*<br/>

* **URL:** **```/NFS/files```**
* **Method:** GET
- **URL Parameters**
  - *Required Parameters:*  `/<filename>`
  - *Optional Parameters:* `&contentType=multipart`
- **Header Parameters**
  - *Required Parameters:* 
  - *Optional Parameters:*
- **Data Parameters**<br/>
- **Success Response:**
  - *Code:* **`200 OK`**
  - *Header with file:* 
   ```html
Content-Type: application/octet-stream
Content-Length: <file lenght>
Content-MD5: <md5 checksum>



    

  • Content with file:
    • 



<file data>


    

  • Header with multipart:
    • 



Content-Type: multipart/form-data;
boundary=<uuid code>


    

  • Content with multipart:
    • 



--uuid:<uuid-code> 
Content-Type: application/octet-stream
Content-Transfer-Encoding: binary
Content-Disposition: form-data; name="file"; filename=<filename>
MD5SUM: <md5 checksum>
Provider-ID: <provider-Id>
Image-Type: <image-type>

<file data>
--uuid:<uuid-code>--



Update file


This method allows to update a file already uploaded to NF Store.


The file should be inserted into HTML body as parts of a multipart/form-data Content.

The Content-Type field of the part should be configured to application/octet-stream.

The Content-Disposition field of the part should be configured setting name to file.

The response return the name of the file and the Id list of VNF Descriptors that use the files.


    

  • URL: /NFS/files
    • 

  • Method: PUT
    • 



    

  • URL Parameters

      

    • Required Parameters:  /<filename>
      • 

    • Optional Parameters:
      • 

    

    • 

  • Header Parameters

      

    • Required Parameters:
      • 

    

    

    • 



Content-Type: multipart/form-data;
boundary=


- *Optional Parameters:*
 ```html
MD5SUM: <md5 checksum>
Provider-ID: <provider Id>
Image-Type: <image type>



    

  • Data Parameters
    • 



--uuid:<uuid code> 
Content-Type: application/octet-stream
Content-Transfer-Encoding: binary
Content-Disposition: form-data; name="file"; filename=<filename>


MD5SUM: <md5 checksum>
Provider-ID: <provider Id>
Image-Type: <image type>


<file data>
--uuid:<uuid code>--


    

  • Success Response:

      

    • Code: 200 OK
      • 

    • Content:
      • 

    

    {
"name": <filename>,
"vnfd_id": [<vnfd Id1>, ..., <vnfd Idn>]
}
    

    • 



- **Error Response:**
  - *Code:* **`400 Bad Request`**
  - *Code:* **`404 Not Found `**
  - *Code:* **`500 Internal Server Error`**
- **Sample Call:**
  curl -k -X DELETE http://127.0.0.1:8080/NFS/files
- **Notes:**
  Response 503 is returned when another operation on same file is already in progress.


## Delete All files
This method allows to delete all files available into NF Store.

* **URL:** **```/NFS/files```**
* **Method:** DELETE
- **URL Parameters**
  - *Required Parameters:*  
  - *Optional Parameters:*
- **Header Parameters**
  - *Required Parameters:*
  - *Optional Parameters:*
- **Data Parameters**
- **Success Response:**
  - *Code:* **`204 No Content`**
- **Error Response:**
  - *Code:* **`500 Internal Server Error`**
- **Sample Call:**
  curl -k -X DELETE http://127.0.0.1:8080/NFS/files
- **Notes:**

## Delete file
This method allows to delete from NF Store the file specified into request.

* **URL:** **```/NFS/files```**
* **Method:** DELETE
- **URL Parameters**
  - *Required Parameters:*  `/<filename>`
  - *Optional Parameters:*
- **Header Parameters**
  - *Required Parameters:*
  - *Optional Parameters:*
- **Data Parameters**
- **Success Response:**
  - *Code:* **`204 No Content`**
- **Error Response:**
  - *Code:* **`400 Bad Request`**
  - *Code:* **`404 Not Found `**
  - *Code:* **`500 Internal Server Error`**
  - *Code:* **`503 Service Unavailable`**
- **Sample Call:**
  curl -k -X DELETE http://127.0.0.1:8080/NFS/files/file1.img
- **Notes:**
  Response 503 is returned when another operation on same file is already in progress.