Skip to content

HTTP Operation Binding v0.1.0

The HTTP operation binding v0.1.0 is used to define the details of an HTTP request, including its type, method, and query parameters.

Operation Properties

PropertyTypeRequiredDescription
bindingVersionstringNoBinding version (defaults to 0.1.0).
typestringYesType of operation. Must be request or response.
methodstringYes (if type is request)The HTTP request method (e.g., GET, POST).
querySchema ObjectNoA schema defining the URL query parameters.

Example

This operation describes a request to fetch users via a GET method with a query schema.

yaml
operations:
  listUsers:
    bindings:
      http:
        bindingVersion: '0.1.0'
        type: 'request'
        method: 'GET'
        query:
          type: object
          properties:
            companyId:
              type: string

Changelog

Version 0.1.0

  • Initial release with type, method, and query properties.