example.yaml

version: 1.0
provider:
  name: openfaas
  gateway: http://127.0.0.1:8080
functions:
  go-hw:
    lang: go
    handler: ./go-hw
    image: ghcr.io/itsmurugappan/hw:latest
    environment:
      write_debug: true
    annotations:
      swagger: "{
                  \"get\": {
                    \"summary\": \"Test function returns greetings\",
                    \"responses\": {
                      \"200\": {
                        \"description\": \"Return greetings\",
                        \"content\": {
                          \"text/plain\": {
                            \"schema\": {
                              \"type\": \"string\",
                              \"example\": \"hi\"
                            }
                          }
                        }
                      },
                      \"401\": {
                        \"description\": \"Authorization information is missing or invalid.\"
                      },
                      \"404\": {
                        \"description\": \"Requested resouce not found.\"
                      },
                      \"405\": {
                        \"description\": \"Method not allowed. Check Authorization\"
                      },
                      \"5XX\": {
                        \"description\": \"Unexpected error.\"
                      }
                    }
                  }
              }"