Skip to content

Latest commit

 

History

History
52 lines (39 loc) · 2.36 KB

README.md

File metadata and controls

52 lines (39 loc) · 2.36 KB

wrp-go

wrp-go provides a library implementing the Web Routing Protocol structures and supporting utilities.

Build Status codecov.io Go Report Card Quality Gate Status Apache V2 License GitHub Release GoDoc

Table of Contents

Code of Conduct

This project and everyone participating in it are governed by the XMiDT Code Of Conduct. By participating, you agree to this Code.

Validators

To setup application wrp validators, visit the example ExampleMetaValidator GoDoc.

Application config example:

# wrpValidators defines the wrp validators used to validate incoming wrp messages.
# (Optional)
# Available validator types: always_invalid, always_valid, utf8, msg_type, source, destination, simple_res_req, simple_event, spans
# Available validator levels: info, warning, error
# Validators can be disabled with `disable: true`, it is false by default
wrpValidators:
  - type: utf8
    level: warning
    disable: true
  - type: source
    level: error

Examples

To use the wrp-go library, it first should be added as an import in the file you plan to use it. Examples can be found at the top of the GoDoc.

Contributing

Refer to CONTRIBUTING.md.