Skip to content

HTTP Operation Binding v0.2.0

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

Operation Properties

PropertyTypeRequiredDescription
bindingVersionstringNoBinding version (defaults to 0.2.0).
methodstringYesThe HTTP request method (e.g., GET, POST).
querySchema ObjectNoA schema defining the URL query parameters.

Example

This operation describes an API call to fetch a list of users with a GET method and a query schema for filtering.

yaml
operations:
  listUsers:
    action: receive
    channel:
      $ref: '#/channels/users'
    bindings:
      http:
        bindingVersion: '0.2.0'
        method: 'GET'
        query:
          type: object
          properties:
            companyId:
              type: string

Changelog

Version 0.2.0

  • Renamed the original type property to method for better clarity compared to v0.1.0.