Giter Club home page Giter Club logo

yaml-validation-action's Introduction

Remote YAML file validation

Validates a YAML file by converting it to JSON and sending it to a remote HTTP API endpoint via a POST request.

The response should be of the following format:

{
    "response": {
        "isValid": false,
        "errors": [
            "Error 1",
            "Error 2"
        ]
    }
}

isValid is a boolean which specifies whether the YAML definition is valid according to some rule set that the HTTP API endpoint can specify. errors is a array of strings, each of which explains an error which makes the file invalid. If isValid is true, then errors should be an empty array.

Inputs

api-endpoint

Required The URL for the HTTP API endpoint which validates the YAML file.

yaml-file

Required The name of the YAML file to validate.

Example usage

- name: Remote YAML file validation
  uses: mpoc/[email protected]
  with:
    api-endpoint: 'http://example.com/validate'
    yaml-file: assignment.yml

yaml-validation-action's People

Contributors

mpoc avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.