Site configuration

The file raw-site.yml must be placed at the GitHub repository root folder and defines global settings.

Example

This file configures the API endpoint to be enabled (i.e. published by RAW) and to be prefixed by the path /hello-world, which is defined by publishUrl.

raw-site.yml example

raw: "0.10" # Site spec file version (required).
publishUrl: hello-world # If defined, adds this as base path
                        # to all endpoints in this repository/branch (optional)
enabled: true # If not specified, defaults to true (optional).
              # If false, the branch will remain as inactive and will not be published.
prefixWithBranchName: true  # If set to true the branch name will be prepended
                            # to the endpoint url (optional).
skipPrefixForBranches:  # List of branch names to not be prefixed in the path (optional).
  - main
  - master

Definition

Field	Type	Required	Description
raw	string	yes	Site spec version. Accepted values: "0.10"(default), 0.9(deprecated), "0.9"(deprecated).
publishURL	string	no	Adds a base path to all endpoints. If defined, all endpoints in this branch will be published at: https://<youraccount>.raw-labs.com/<publishURL>/path/to/endpoint. If not defined, all endpoints in this branch will be published at: https://<youraccount>.raw-labs.com/path/to/endpoint
prefixWithBranchName	boolean	no	If set to true, the branch name will be prepended to the endpoint url. For example: https://....raw-labs.com/<publishURL>/<branch>/endpoint
skipPrefixForBranches	array[string]	no	Contains the list of branches that should not be prefixed with the branch name. Default is 'main' and 'master'.
enabled	boolean	no	Indicates if the repository/branch is enabled for publication. If false, the branch will be rendered as Inactive in the branches section