Skip to main content
POST
/
models_yaml_lint
Lint model YAML
curl --request POST \
  --url https://app.gomangrove.com/api/v1/models_yaml_lint \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "yaml": "nexus:\n  - formula: input_1 - input_2\n    name: Net Carbon Removal\n"
}
'
import requests

url = "https://app.gomangrove.com/api/v1/models_yaml_lint"

payload = { "yaml": "nexus:
- formula: input_1 - input_2
name: Net Carbon Removal
" }
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)
const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({yaml: 'nexus:\n - formula: input_1 - input_2\n name: Net Carbon Removal\n'})
};

fetch('https://app.gomangrove.com/api/v1/models_yaml_lint', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));
<?php

$curl = curl_init();

curl_setopt_array($curl, [
CURLOPT_URL => "https://app.gomangrove.com/api/v1/models_yaml_lint",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'yaml' => 'nexus:
- formula: input_1 - input_2
name: Net Carbon Removal
'
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}
package main

import (
"fmt"
"strings"
"net/http"
"io"
)

func main() {

url := "https://app.gomangrove.com/api/v1/models_yaml_lint"

payload := strings.NewReader("{\n \"yaml\": \"nexus:\\n - formula: input_1 - input_2\\n name: Net Carbon Removal\\n\"\n}")

req, _ := http.NewRequest("POST", url, payload)

req.Header.Add("Authorization", "<api-key>")
req.Header.Add("Content-Type", "application/json")

res, _ := http.DefaultClient.Do(req)

defer res.Body.Close()
body, _ := io.ReadAll(res.Body)

fmt.Println(string(body))

}
HttpResponse<String> response = Unirest.post("https://app.gomangrove.com/api/v1/models_yaml_lint")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"yaml\": \"nexus:\\n - formula: input_1 - input_2\\n name: Net Carbon Removal\\n\"\n}")
.asString();
require 'uri'
require 'net/http'

url = URI("https://app.gomangrove.com/api/v1/models_yaml_lint")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"yaml\": \"nexus:\\n - formula: input_1 - input_2\\n name: Net Carbon Removal\\n\"\n}"

response = http.request(request)
puts response.read_body
{
  "formatted_yaml": "nexus:\n  - name: Net Carbon Removal\n    formula: input_1 - input_2\n",
  "changes": [
    {
      "type": "reorder",
      "message": "Reordered keys in node",
      "line": 2
    }
  ]
}

Authorizations

Authorization
string
header
required

Body

application/json
yaml
string
required

YAML content to format

Response

200 - application/json

200

formatted_yaml
string | null
changes
object[]
error
string