Root Object

Shares

Defines one or more UNC shares to be exposed to network clients.

version: 1.0
shares:
  - share-name: share-name
    file-name: "{{dog}}\\{{colour}}.txt"
    target-api:
      ...
    variables:
    - name: colour
      type: enum
      options:
        - Red
        - Blue
        - Green
    - name: dog
      type: enum
      options:
        - Lab
        - Pug
                            

\\server\share-name\Lab\Red.txt
\\server\share-name\Lab\Blue.txt
\\server\share-name\Lab\Green.txt
\\server\share-name\Pug\Red.txt
\\server\share-name\Pug\Blue.txt
\\server\share-name\Pug\Green.txt

Variables

Defines one or more variables to be used when constructing the data path.

Target API

Defines connectivity options for the API that will be the source of the data.

version: 1.0
shares:
  - share-name: share-name
    file-name: "{{colour}}.txt"
    target-api:
      ...
      path: v1/{{colour}}/data
    variables:
    - name: colour
      type: enum
      options:
        - Red
        - Orange
        - Pink

Headers

Allows HTTP headers to be sent to the API as part of the request for data.

The Headers object is a map of header name to static or dynamic data. A template string allows use of fixed text or dynamic information in generating the field value.

    headers:
      accept: application/json
      x-custom-header: myHeaderValue

Braces {{}} variable substitution can be used in headers. The value of the variable set will correspond to the variables utilised to build the selected file path.

version: 1.0
shares:
  - share-name: share-name
    file-name: "{{colour}}.txt"
    target-api:
      method: GET
      scheme: https
      host: www.example.com
      port: 443
      path: v1/data
      headers:
        accept: text/plain
        x-custom-color: {{colour}}
    variables:
    - name: colour
      type: enum
      options:
        - Red
        - Blue
        - Green
        - Orange
        - Pink

User Authentication

Defines users or groups of users and the manner in which they are authorised to interact with the API data on the UNC shares.

The value of the key for each sub object under the user-auth: section is the local domain\user for whom the API credentials will apply.

Omitting the domain\ will match the username across all local domains. More fine-grained control over domain and username matching can be achieved using wildcard characters.

Basic Authentication Object

Defines properties of the Basic authentication headers that are delivered to the API.

ApiKey Authentication Object

Defines properties of the ApiKey authentication headers that are delivered to the API.

  type: apikey
  apikey:
    in: header
    name: x-apikey
    apikey: 1234-abcd-7890

Bearer Authentication Object

Defines properties of the Bearer authentication headers that are delivered to the API.

Oauth2 Authentication Object

Defines properties of the Oauth2 authentication headers that are delivered to the API.

A standardised Oauth2 authentication call will be made to the defined token endpoint. Any generated tokens are only used once and new tokens will be generated for any subsequent requests to the API.

Line Transform

Defines the structure of the file to be delivered to the UNC client based on the API data. Utilises .net Razor templates.

    transform:
    - line: "COLUMN,VALUE"
    - line: |
        @foreach(var bodyItem in Model.Content.GetItems("$.items.[::1]")){
            <text>body,@(bodyItem.GetValue(""))@(System.Environment.NewLine)<text>
        }

Each line template can utilise several built-in functions to access data from the API response. The content is automatically parsed based on the Content-Type header provided by the API. Supported values include application/json and application/xml.

For more information see the Template documentation.

Cache Override

Allows overriding of API defined cache settings. Normally the response header Cache-Control will be parsed and the rules it contains applied to the data caching, however supplying overrides in the cache-override section allows these headers to be overridden.