2.1Map Result

Example № 4map GetWeather {
  map result {
    airTemperature = 42  # Sets the value returned to user
  }
}

2.2Map Error

Example № 5map GetWeather {
  map error {
    title = "Location not found"
  }
}

3.1Operation Return

Example № 7operation Foo {
  return if (args.condition) {
    message = "I have a condition!"
  }

  return {
    message = "Hello World!"
  }
}

3.2Operation Fail

Example № 8operation Foo {
  fail if (args.condition) {
    errorMessage = "I have failed!"
  }
}

5.1Operation Call Shorthand

Used as RHS instead of ScriptExpression to invoke an Operation in‐place. In the case of success the operation outcome’s data is unbundled and returned by the call. See OperationCall context variable outcome.

Example № 17set {
  someVariable = call Foo()
}

Example № 18operationOutcome = call SomeOperation()

users = call foreach(user of operationOutcome.users) Foo(user = user) if (operationOutcome)

// Intepretation: 
// `Foo` is called for every `user` of `operationOutcome.users` if the `operationOutcome` is truthy

superusers = call foreach(user of operationOutcome.users) Bar(user = user) if (user.super)

// Intepretation: 
// `Bar` is called for an `user` of `operationOutcome.users` if the `user.super` is truthy

6.1Map Outcome

Outcome in the Map context.

6.2Operation Outcome

Outcome in the Operation context.

8.1HTTP Transaction

8.2HTTP Security

Example № 21GET "/users" {
  security "api_key_scheme_id"

  response {
    ...
  }
}

If no other HTTPSecurity is provided, the default is none. Explicitly signify public endpoints as none as so.

Example № 22GET "/public-endpoint" {
  security none
  
  response {
    ...
  }
}

8.3HTTP Request

Example № 23http GET "/greeting" {
  request {
    query {
      myName = "John"
    }
  }
}

Example № 24http POST "/users" {
  request "application/json" {
    query {
      parameter = "Hello World!"
    }

    headers {
      "my-header" = 42
    }

    body {
      key = 1
    }
  }
}

Example № 25http POST "/users" {
  request "application/json" {
    body = [1, 2, 3]
  }
}

8.4HTTP Response

Example № 26http GET "/" {
  response 200 "application/json" {
    map result {
      outputKey = body.someKey
    }
  }
}

Example № 27http POST "/users" {
  response 201 "application/json" {
    return {
      id = body.userId
    }
  }
}

Example № 28http POST "/users" {
  response 201 "application/json" {
    ...
  }
  
  response 400 "application/json" {
    map error {
      title = "Wrong attributes"
      details = body.message
    }
  }
}

Example № 29http POST "/users" {
  response "application/json" {
    map result if (body.ok) {
      ...
    }

    map error if (!body.ok) {
      ...
    }
  }
}

Example № 30http GET "/" {
  response "*" "en-US" {
    map result {
      rawOutput = body
    }
  }
}

11.1Operators

11.2Literals

Example № 371.234e-4

Example № 38"hello world"

Example № 39`Foo: ${foo}, bar: ${bar}`

Example № 40[...[1, 2], 3, 4]

Example № 41{ ...a, b: 1, c: 2 + 3 }

11.3Identifiers

Javascript identifier production

Javascript reserved word production

11.4Expressions

Expressions are central to the script. Expressions appear on the right‐hand side of VariableStatement, in Conditions and in operation call Argument list.

Since the only way to obtain a lexical context in which statements can be declared is to create an ScriptArrowFunction, it is often more convenient to use functional patterns to transform data:

Example № 42Object.entries(foo).filter(
  ([_key, value]) => value > 0
).map(
  ([key, _value]) => key
)

Example № 431 + 2**input.exponent

Example № 44{ ...a, b: 1, c: 2 + 3, d: [...[1, 2], 3, 4] }

Example № 45(() => {
  const result = "only do this in very complex cases"
  return result
})()

Example № 46-7

Example № 47"foo" + "bar"

Example № 48foo.bar += 7 * 8

Example № 49foo === 1 ? "hello" : "goodbye"

Example № 50foo.bar(1, 2 + 3, ["hello", "world"])

11.5Binding patterns

Binding patterns are used when destructuring values in variable declarations and function parameter declarations (i.e. in ScriptArrowFunction).

Javascript binding pattern production: BindingPattern without yield, await, Elision and ComputedPropertyName.

Example № 51[a, b = 2, ...c]

Example № 52{ a, b = 2, c: x = 3, ...d }

11.6Arrow function

Arrow functions are the only way to declare callable items in the script. They can be passed to built‐in methods like Array.map or in the most complex cases used as immediately‐invoked function expressions (e.g. (() => 1)()).

Example № 53([a, b, c = 1]) => { return a + b ** c; }

11.7Statements

Statements are usually not relevant in the script, as expressions should be preferred instead.

The allowed Javascript statement productions have the following caveats recursively:

• Each production without yield, await and Declaration
• IterationStatement without for/in and without async variants
• AssignmentExpression production replaced by ScriptExpression
• Statement production replaced by ScriptStatement

The allowed Javascript statement productions are:

• LexicalDeclaration (let, const)
• BlockStatement
• ExpressionStatement
• IfStatement
• BreakableStatement (for, for/of, while, do/while, switch)
• ContinueStatement, BreakStatement, ReturnStatement where appropriate
• LabelledStatement

Example № 54return 1;

Example № 55{
  let x = 1;
  for (const y of [1, 2, 3]) {
    x += y;
  }

  if (x == 7) {
    return null;
  }
}

12.1Source text

Example № 56// This is a comment

12.2Common Definitions

Example № 57character-information

Example № 58starwars/character-information

Example № 59character-information@2.0.0

Example № 60starwars/character-information@1.1.0

Example № 61starwars/character-information@1.1