Skip to main content Link Search Menu Expand Document (external link)
Simple Configuration Server

Endpoints Directory

Use the ‘directories.endpoints’ variable inside scs-configuration.yaml to set the location of this directory

The contents of this directory are served by the SCS, with the exception of files with names that end with ‘scs-env.yaml’. These files contain configuration variables for specific endpoints, or entire directories. The URL structure of your SCS deployment is derived from the folder structure inside the endpoints directory.

1 *scs-env.yaml Files

Although scs-env.yaml files are optional, they allow you to configure the variables for the templating system and the validation of requests and responses of each endpoint. Below is a full example of all options that can be set in a *scs-env.yaml file:

template:
  context:  # Variables available inside templates
    variable: value
    common_variable: !scs-common 'global.yaml#var_array.[5]'
    secret: !scs-secret 'system-users.yaml#user.password'
  rendering_options:  # Override the default jinja rendering options from scs-configuration.yaml
    lstrip_blocks: false
  enabled: true  # To host simple files, templating can also be disabled

request:
  methods:  # Allowed methods
    - GET
    - POST
  schema:   # Schema used to validate POST request JSON body
    type: object
    additionalProperties: false
    required:
      - memory_size
    properties:
      memory_size:
        type: integer

response:
  status: 200  # Set the default status of the response
  headers:  # Set headers on the response
    Content-Type: text/plain

These files should adhere to the schema found here, which also includes more extensive descriptions of each property. Note that this schema also defines the defaults for each property, used when properties are missing. All properties in scs-env files are optional, but empty scs-env files should be omitted.

In case you simply want to host the files in your endpoints directory, without using any of the templating features, you can place the following scs-env.yaml file in the root of the endpoints directory:

template:
  enabled: false

As mentioned, *scs-env.yaml files can apply to entire directories or to specific endpoints (files) only. Multiple scs-env files can apply to same endpoint, in which case properties defined in the more specific scs-env.yaml file, override properties in the less specific one. For example, consider the following example:

.
├── root_endpoint.json
├── root_endpoint.json.scs-env.yaml
├── scs-env.yaml
└── subdirectory
    ├── scs-env.yaml
    ├── sub_endpoint2
    ├── sub_endpoint2.scs-env.yaml
    └── sub_enpoint

The ‘./scs-env.yaml’ applies to all endpoints and the ‘./subdirectory/scs-env.yaml’ applies to all endpoints in the subdirectory. For example for ‘./root_endpoint.json’ the following scs-env files are used:

  1. ’./scs-env.yaml’
  2. ’./root_endpoint.json.scs-env.yaml’

Similairly, the following apply to ‘./subdirectory/sub_endpoint2’:

  1. ’./scs-env.yaml’
  2. ’./subdirectory/scs-env.yaml’
  3. ’./subdirectory/sub_endpoint2.scs-env.yaml’

Values of type object (dict in python) of more specific scs-env files update the contents of less specific ones. Values with other data types are replaced, in case more specific scs-env files define them also. For example, considering the scs-env files for ‘./root_endpoint.json’ have the following contents:

  1. ./scs-env.yaml
    template:
  context:
    key1: general
    key2: general
response:
  status: 200
  headers:
    Content-Type: text/plain
  2. ./root_endpoint.json.scs-env.yaml
    template:
  context:
    key2: specific
response:
  status: 418
  headers:
   X-TeaType: Rooibos

Then the configuration for the endpoint would look like (excluding default values):

template:
  context:
    key1: general
    key2: specific
response:
  status: 418
  headers:
    Content-Type: text/plain
    X-TeaFlavor: Rooibos

2 URL structure

All files inside the endpoints directory of which the names do not end with ‘scs-env.yaml’, are used as server endpoints. These files are served under the /configs/ url path. The example file structure above would expose the following endpoints:

/configs/root_endpoint.json
/configs/subdirectory/sub_endpoint
/configs/subdirectory/sub_endpoint2