{"id":36684772,"url":"https://github.com/vitwit/gofaas","last_synced_at":"2026-01-12T11:11:55.713Z","repository":{"id":57514756,"uuid":"228591331","full_name":"vitwit/gofaas","owner":"vitwit","description":"Go SDK for OpenFaaS","archived":false,"fork":false,"pushed_at":"2020-02-27T13:32:45.000Z","size":120,"stargazers_count":10,"open_issues_count":0,"forks_count":4,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-07-25T14:30:05.239Z","etag":null,"topics":["go-fass","openfass","sdk","sdk-go"],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/vitwit.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":"CODE_OF_CONDUCT.md","threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2019-12-17T10:26:22.000Z","updated_at":"2022-09-26T07:03:05.000Z","dependencies_parsed_at":"2022-09-26T18:00:54.972Z","dependency_job_id":null,"html_url":"https://github.com/vitwit/gofaas","commit_stats":null,"previous_names":["vitwit/go-faas"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/vitwit/gofaas","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vitwit%2Fgofaas","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vitwit%2Fgofaas/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vitwit%2Fgofaas/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vitwit%2Fgofaas/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/vitwit","download_url":"https://codeload.github.com/vitwit/gofaas/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/vitwit%2Fgofaas/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28338970,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-12T10:58:46.209Z","status":"ssl_error","status_checked_at":"2026-01-12T10:58:42.742Z","response_time":98,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"can_crawl_api":true,"host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["go-fass","openfass","sdk","sdk-go"],"created_at":"2026-01-12T11:11:52.927Z","updated_at":"2026-01-12T11:11:55.708Z","avatar_url":"https://github.com/vitwit.png","language":"Go","funding_links":[],"categories":[],"sub_categories":[],"readme":"\n# gofaas\nGo SDK for OpenFaaS\nThis documentation is under (Beta)\n\n**This library allows you to quickly and easily use the openFasS API**\n\n# How to use\n\n\u003ca name=\"installation\"\u003e\u003c/a\u003e\n# Installation\n\n## Prerequisites\n\n- go\n- Installed openFasS\n\n### Install Package\n\n```sh\n\tgo get github.com/vitwit/gofaas\n```\n\n\n## Setup Environment Variables\n\n### Initial Setup\n\n```bash\ncp .env.example .env\n```\nUpdate OPENFAAS_GATEWAY_ADDR, OPENFAAS_USER, OPENFAAS_PASSWORD, OPENFAAS_CLUSTER_TYPE\n\n### Environment Variable\n\nUpdate the development environment with your keys, for example:\n\n```bash\n$ export OPENFAAS_GATEWAY_ADDR=http://127.0.0.1:8080\n$ export OPENFAAS_USER='admin'\n$ export OPENFAAS_PASSWORD='password'\n$ export OPENFAAS_CLUSTER_TYPE='swarm'\n```\n\u003ca name=\"quick-start\"\u003e\u003c/a\u003e\n# Quick Start\n\n### Create a client\n\n```\nimport faas \"github.com/vitwit/gofaas\"\n\nclient := faas.NewClient(\u0026faas.FaasGatewayCredentials{\n    Username:       os.Getenv(\"OPENFAAS_USER\"),\n    Password:       os.Getenv(\"OPENFAAS_PASSWORD\"),\n    GatewayAddress: os.Getenv(\"OPENFAAS_GATEWAY_ADDR\"),\n    ClusterType:    os.Getenv(\"OPENFAAS_CLUSTER_TYPE\"),\n})\n```\n\n\u003cdetails\u003e\n\n\u003csummary\u003egetFunctions\u003c/summary\u003e\n\ngetFunctions\n---\n **Example**\n\n ```\n resp, err := cli.GetSystemFunctions()\n```\n**Responses**\n\n\n\u003e Success 2XX\n```json\n{\n  \"200\": {\n    \"description\": \"List of deployed functions.\",\n    \"schema\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"$ref\": \"#/definitions/FunctionListEntry\"\n      }\n    }\n  }\n}\n```\n\n######  [FunctionListEntry](###FunctionListEntry-modal)\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\n\u003csummary\u003ecreateFunction\u003c/summary\u003e\n\ncreateFunction\n---\n **Example**\n\n ```\nfuncdef := \u0026faas.FunctionDefintion{\n    Service:    \"nodeinfo12345\",\n    Network:    \"func_functions\",\n    Image:      \"functions/nodeinfo:latest\",\n    EnvProcess: \"node main.js\",\n    EnvVars: faas.EnvVars{\n        AdditionalProp1: \"string\",\n        AdditionalProp2: \"string\",\n        AdditionalProp3: \"string\",\n    },\n    Constraints: []string{\n        \"node.platform.os == linux\",\n    },\n    Labels: map[string]string{\n        \"example\": \"func1\",\n    },\n    Annotations: faas.Annotations{\n        Topics: \"awesome-kafka-topic\",\n        Foo:    \"some\",\n    },\n    RegistryAuth: \"dXNlcjpwYXNzd29yZA==\",\n    Limits: faas.Limits{\n        Memory: \"128M\",\n        CPU:    \"0.01\",\n    },\n    Requests: faas.Requests{\n        Memory: \"128M\",\n        CPU:    \"0.01\",\n    },\n    ReadOnlyRootFilesystem: true,\n}\n\nresp, err := cli.CreateSystemFunctions(funcdef)\n```\n**Responses**\n\n\n\u003e Success 2XX\n```json\n{\n  \"202\": {\n    \"description\": \"Accepted\"\n  }\n}\n```\n\n\u003e Error 4XX\n```json\n{\n  \"400\": {\n    \"description\": \"Bad Request\"\n  }\n}\n```\n\n\u003e Error 5XX\n```json\n{\n  \"500\": {\n    \"description\": \"Internal Server Error\"\n  }\n}\n```\n\n######  [FunctionDefintion](###FunctionDefintion-modal)  [FunctionListEntry](###FunctionListEntry-modal)\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\n\u003csummary\u003eupdateFunction\u003c/summary\u003e\n\nupdateFunction\n---\n **Example**\n\n ```\nupdate := \u0026faas.FunctionDefintion{\n    Service: \"nodeinfo\",\n    Image:   \"functions/nodeinfo:latest\",\n    Labels: map[string]string{\n        \"changedlabelkey\": \"changedlabelval\",\n    },\n},\nresp, err := cli.UpdateSystemFunctions(update)\n```\n**Responses**\n\n\n\u003e Success 2XX\n```json\n{\n  \"200\": {\n    \"description\": \"Accepted\"\n  }\n}\n```\n\n\u003e Error 4XX\n```json\n{\n  \"400\": {\n    \"description\": \"Bad Request\"\n  },\n  \"404\": {\n    \"description\": \"Not Found\"\n  }\n}\n```\n\n\u003e Error 5XX\n```json\n{\n  \"500\": {\n    \"description\": \"Internal Server Error\"\n  }\n}\n```\n\n######  [FunctionDefintion](###FunctionDefintion-modal)  [FunctionDefintion](###FunctionDefintion-modal)  [FunctionListEntry](###FunctionListEntry-modal)\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\n\u003csummary\u003edeleteFunction\u003c/summary\u003e\n\ndeleteFunction\n---\n **Example**\n\n ```\nresp, err := cli.DeleteSystemFunction(\u0026faas.DeleteFunctionBodyOpts{FunctionName: \"nodeinfo\"})\n```\n**Responses**\n\n\n\u003e Success 2XX\n```json\n{\n  \"200\": {\n    \"description\": \"OK\"\n  }\n}\n```\n\n\u003e Error 4XX\n```json\n{\n  \"400\": {\n    \"description\": \"Bad Request\"\n  },\n  \"404\": {\n    \"description\": \"Not Found\"\n  }\n}\n```\n\n\u003e Error 5XX\n```json\n{\n  \"500\": {\n    \"description\": \"Internal Server Error\"\n  }\n}\n```\n\n######  [FunctionDefintion](###FunctionDefintion-modal)  [FunctionDefintion](###FunctionDefintion-modal)  [DeleteFunctionRequest](###DeleteFunctionRequest-modal)  [FunctionListEntry](###FunctionListEntry-modal)\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\n\u003csummary\u003ehandleAlert\u003c/summary\u003e\n\nhandleAlert\n---\n **Example**\n\n ```\nsysalert := \u0026faas.SystemAlertBodyOpts{\n    Receiver: \"scale-up\",\n    Status:   \"firing\",\n    Alerts: []SystemAlertsStruct{\n    {\n    Status: \"firing\",\n    Labels: SystemAlertLables{\n        Alertname:    \"APIHighInvocationRate\",\n        Code:         \"200\",\n        FunctionName: \"func_nodeinfo\",\n        Instance:     os.Getenv(\"OPENFAAS_GATEWAY_ADDR\"),\n        Job:          \"gateway\",\n        Monitor:      \"faas-monitor\",\n        Service:      \"gateway\",\n        Severity:     \"major\",\n        Value:        \"8.998200359928017\",\n    },\n    Annotations: SystemAlertAnnotations{\n        Description: \"High invocation total on gateway:8080\",\n        Summary:     \"High invocation total on gateway:8080\",\n    },\n    StartsAt: time.Now(),\n    EndsAt:   time.Now().Add(time.Hour * 24),\n    },\n    },\n    GroupLabels: GroupLabels{\n    Alertname: \"APIHighInvocationRate\",\n    Service:   \"gateway\",\n    },\n    CommonLabels: CommonLabels{\n    Alertname:    \"APIHighInvocationRate\",\n    Code:         \"200\",\n    FunctionName: \"func_nodeinfo\",\n    Instance:     os.Getenv(\"OPENFAAS_GATEWAY_ADDR\"),\n    Job:          \"gateway\",\n    Monitor:      \"faas-monitor\",\n    Service:      \"gateway\",\n    Severity:     \"major\",\n    Value:        \"8.998200359928017\",\n    },\n    CommonAnnotations: CommonAnnotations{\n    Description: \"High invocation total on gateway:8080\",\n    Summary:     \"High invocation total on gateway:8080\",\n    },\n    ExternalURL: os.Getenv(\"OPENFAAS_GATEWAY_ADDR\"),\n    Version:     \"3\",\n}\nresp, err := cli.SystemAlert(syslert)\n```\n**Responses**\n\n\n\u003e Success 2XX\n```json\n{\n  \"200\": {\n    \"description\": \"Alert handled successfully\"\n  }\n}\n```\n\n\u003e Error 5XX\n```json\n{\n  \"500\": {\n    \"description\": \"Internal error with swarm or request JSON invalid\"\n  }\n}\n```\n\n######  [FunctionDefintion](###FunctionDefintion-modal)  [FunctionDefintion](###FunctionDefintion-modal)  [DeleteFunctionRequest](###DeleteFunctionRequest-modal)  [undefined](###undefined-modal)  [FunctionListEntry](###FunctionListEntry-modal)\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\n\u003csummary\u003einvokeFunctionAsync\u003c/summary\u003e\n\ninvokeFunctionAsync\n---\n **Example**\n\n```\nresp, err := cli.AsyncFunction(\u0026faas.AsyncInvocationOpts{\n    Body:         \"Hey there!\",\n    FunctionName: \"nodeinfo\",\n    CallbackURL:  \"http://localhost:5000\",\n})\n```\n**Responses**\n\n\n\u003e Success 2XX\n```json\n{\n  \"202\": {\n    \"description\": \"Request accepted and queued\"\n  }\n}\n```\n\n\u003e Error 4XX\n```json\n{\n  \"404\": {\n    \"description\": \"Not Found\"\n  }\n}\n```\n\n\u003e Error 5XX\n```json\n{\n  \"500\": {\n    \"description\": \"Internal Server Error\"\n  }\n}\n```\n\n######  [FunctionDefintion](###FunctionDefintion-modal)  [FunctionDefintion](###FunctionDefintion-modal)  [DeleteFunctionRequest](###DeleteFunctionRequest-modal)  [undefined](###undefined-modal)  [FunctionListEntry](###FunctionListEntry-modal)\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\n\u003csummary\u003einvokeFunction\u003c/summary\u003e\n\ninvokeFunction\n---\n **Example**\n\n ```\nresp, err := cli.InvokeFunction(\u0026faas.SyncInvocationOpts{\n    Body:         \"Hi there!\",\n    FunctionName: \"nodeinfo\",\n})\n```\n**Responses**\n\n\n\u003e Success 2XX\n```json\n{\n  \"200\": {\n    \"description\": \"Value returned from function\"\n  }\n}\n```\n\n\u003e Error 4XX\n```json\n{\n  \"404\": {\n    \"description\": \"Not Found\"\n  }\n}\n```\n\n\u003e Error 5XX\n```json\n{\n  \"500\": {\n    \"description\": \"Internal server error\"\n  }\n}\n```\n\n######  [FunctionDefintion](###FunctionDefintion-modal)  [FunctionDefintion](###FunctionDefintion-modal)  [DeleteFunctionRequest](###DeleteFunctionRequest-modal)  [undefined](###undefined-modal)  [FunctionListEntry](###FunctionListEntry-modal)\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\n\u003csummary\u003escaleFunction\u003c/summary\u003e\n\nscaleFunction\n---\n **Example**\n\n```\nresp, err := cli.ScaleFunction(\u0026faas.ScaleFunctionBodyOpts{\n    Service:  \"nodeinfo\",\n    Replicas: 2,\n})\n```\n**Responses**\n\n\n\u003e Success 2XX\n```json\n{\n  \"200\": {\n    \"description\": \"Scaling OK\"\n  },\n  \"202\": {\n    \"description\": \"Scaling OK\"\n  }\n}\n```\n\n\u003e Error 4XX\n```json\n{\n  \"404\": {\n    \"description\": \"Function not found\"\n  }\n}\n```\n\n\u003e Error 5XX\n```json\n{\n  \"500\": {\n    \"description\": \"Error scaling function\"\n  }\n}\n```\n\n######  [FunctionDefintion](###FunctionDefintion-modal)  [FunctionDefintion](###FunctionDefintion-modal)  [DeleteFunctionRequest](###DeleteFunctionRequest-modal)  [undefined](###undefined-modal)  [FunctionListEntry](###FunctionListEntry-modal)\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\n\u003csummary\u003egetFunctionSummary\u003c/summary\u003e\n\ngetFunctionSummary\n---\n **Example**\n\n ```\nresp, err := cli.GetFunctionSummary(\"nodeinfo\")\n```\n**Responses**\n\n\n\u003e Success 2XX\n```json\n{\n  \"200\": {\n    \"description\": \"Function Summary\",\n    \"schema\": {\n      \"$ref\": \"#/definitions/FunctionListEntry\"\n    }\n  }\n}\n```\n\n\u003e Error 4XX\n```json\n{\n  \"404\": {\n    \"description\": \"Not Found\"\n  }\n}\n```\n\n\u003e Error 5XX\n```json\n{\n  \"500\": {\n    \"description\": \"Internal Server Error\"\n  }\n}\n```\n\n######  [FunctionDefintion](###FunctionDefintion-modal)  [FunctionDefintion](###FunctionDefintion-modal)  [DeleteFunctionRequest](###DeleteFunctionRequest-modal)  [undefined](###undefined-modal)  [FunctionListEntry](###FunctionListEntry-modal)  [FunctionListEntry](###FunctionListEntry-modal)\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\n\u003csummary\u003egetSecrets\u003c/summary\u003e\n\ngetSecrets\n---\n **Example**\n\n ```\nresp, err := client.getSecrets()\n```\n**Responses**\n\n\n\u003e Success 2XX\n```json\n{\n  \"200\": {\n    \"description\": \"List of submitted secrets.\",\n    \"schema\": {\n      \"$ref\": \"#/definitions/SecretName\"\n    }\n  }\n}\n```\n\n######  [FunctionDefintion](###FunctionDefintion-modal)  [FunctionDefintion](###FunctionDefintion-modal)  [DeleteFunctionRequest](###DeleteFunctionRequest-modal)  [undefined](###undefined-modal)  [FunctionListEntry](###FunctionListEntry-modal)  [FunctionListEntry](###FunctionListEntry-modal)  [SecretName](###SecretName-modal)\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\n\u003csummary\u003ecreateSecret\u003c/summary\u003e\n\ncreateSecret\n---\n **Example**\n\n```\nresp, err := cli.CreateNewSecret(\u0026faas.SecretBodyOpts{\n    Name:  \"key\",\n    Value: \"val\",\n})\n```\n**Responses**\n\n\n\u003e Success 2XX\n```json\n{\n  \"201\": {\n    \"description\": \"Created\"\n  }\n}\n```\n\n\u003e Error 4XX\n```json\n{\n  \"400\": {\n    \"description\": \"Bad Request\"\n  }\n}\n```\n\n\u003e Error 5XX\n```json\n{\n  \"500\": {\n    \"description\": \"Internal Server Error\"\n  }\n}\n```\n\n######  [FunctionDefintion](###FunctionDefintion-modal)  [FunctionDefintion](###FunctionDefintion-modal)  [DeleteFunctionRequest](###DeleteFunctionRequest-modal)  [undefined](###undefined-modal)  [Secret](###Secret-modal)  [FunctionListEntry](###FunctionListEntry-modal)  [FunctionListEntry](###FunctionListEntry-modal)  [SecretName](###SecretName-modal)\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\n\u003csummary\u003eupdateSecret\u003c/summary\u003e\n\nupdateSecret\n---\n **Example**\n\n```\nresp, err := cli.UpdateSecret(\u0026faas.SecretBodyOpts{\n    Name:  \"key\",\n    Value: \"updatedval\",\n})\n```\n**Responses**\n\n\n\u003e Success 2XX\n```json\n{\n  \"200\": {\n    \"description\": \"Ok\"\n  }\n}\n```\n\n\u003e Error 4XX\n```json\n{\n  \"400\": {\n    \"description\": \"Bad Request\"\n  },\n  \"404\": {\n    \"description\": \"Not Found\"\n  }\n}\n```\n\n\u003e Error 5XX\n```json\n{\n  \"500\": {\n    \"description\": \"Internal Server Error\"\n  }\n}\n```\n\n######  [FunctionDefintion](###FunctionDefintion-modal)  [FunctionDefintion](###FunctionDefintion-modal)  [DeleteFunctionRequest](###DeleteFunctionRequest-modal)  [undefined](###undefined-modal)  [Secret](###Secret-modal)  [Secret](###Secret-modal)  [FunctionListEntry](###FunctionListEntry-modal)  [FunctionListEntry](###FunctionListEntry-modal)  [SecretName](###SecretName-modal)\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\n\u003csummary\u003edeleteSecret\u003c/summary\u003e\n\ndeleteSecret\n---\n **Example**\n\n ```\nresp, err := cli.DeleteSecret(\u0026faas.SecretNameBodyOpts{\n    Name: \"key\",\n})\n```\n**Responses**\n\n\n\u003e Success 2XX\n```json\n{\n  \"204\": {\n    \"description\": \"OK\"\n  }\n}\n```\n\n\u003e Error 4XX\n```json\n{\n  \"400\": {\n    \"description\": \"Bad Request\"\n  },\n  \"404\": {\n    \"description\": \"Not Found\"\n  }\n}\n```\n\n\u003e Error 5XX\n```json\n{\n  \"500\": {\n    \"description\": \"Internal Server Error\"\n  }\n}\n```\n\n######  [FunctionDefintion](###FunctionDefintion-modal)  [FunctionDefintion](###FunctionDefintion-modal)  [DeleteFunctionRequest](###DeleteFunctionRequest-modal)  [undefined](###undefined-modal)  [Secret](###Secret-modal)  [Secret](###Secret-modal)  [SecretName](###SecretName-modal)  [FunctionListEntry](###FunctionListEntry-modal)  [FunctionListEntry](###FunctionListEntry-modal)  [SecretName](###SecretName-modal)\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\n\u003csummary\u003egetLogsOfAFunction\u003c/summary\u003e\n\ngetLogsOfAFunction\n---\n **Example**\n\n ```\nresp, err := cli.GetSystemLogs(\u0026faas.SystemLogsQueryOpts{\n    Name:   \"nodeinfo\",\n    Tail:   10,\n    Follow: false,\n    Since: \"2020-01-22T07:48:18+00:00\"\n})\n```\n**Responses**\n\n\n\u003e Success 2XX\n```json\n{\n  \"200\": {\n    \"description\": \"Newline delimited stream of log messages\",\n    \"schema\": {\n      \"$ref\": \"#/definitions/LogEntry\"\n    }\n  }\n}\n```\n\n\u003e Error 4XX\n```json\n{\n  \"404\": {\n    \"description\": \"Not Found\"\n  }\n}\n```\n\n\u003e Error 5XX\n```json\n{\n  \"500\": {\n    \"description\": \"Internal Server Error\"\n  }\n}\n```\n\n######  [FunctionDefintion](###FunctionDefintion-modal)  [FunctionDefintion](###FunctionDefintion-modal)  [DeleteFunctionRequest](###DeleteFunctionRequest-modal)  [undefined](###undefined-modal)  [Secret](###Secret-modal)  [Secret](###Secret-modal)  [SecretName](###SecretName-modal)  [FunctionListEntry](###FunctionListEntry-modal)  [FunctionListEntry](###FunctionListEntry-modal)  [SecretName](###SecretName-modal)  [LogEntry](###LogEntry-modal)\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\n\u003csummary\u003egetInfo\u003c/summary\u003e\n\ngetInfo\n---\n **Example**\n\n ```\nresp, err := cli.GetSystemInfo()\n```\n**Responses**\n\n\n\u003e Success 2XX\n```json\n{\n  \"200\": {\n    \"description\": \"Info result\",\n    \"schema\": {\n      \"$ref\": \"#/definitions/Info\"\n    }\n  }\n}\n```\n\n\u003e Error 4XX\n```json\n{\n  \"404\": {\n    \"description\": \"Provider does not support info endpoint\"\n  }\n}\n```\n\n\u003e Error 5XX\n```json\n{\n  \"500\": {\n    \"description\": \"Internal Server Error\"\n  }\n}\n```\n\n######  [FunctionDefintion](###FunctionDefintion-modal)  [FunctionDefintion](###FunctionDefintion-modal)  [DeleteFunctionRequest](###DeleteFunctionRequest-modal)  [undefined](###undefined-modal)  [Secret](###Secret-modal)  [Secret](###Secret-modal)  [SecretName](###SecretName-modal)  [FunctionListEntry](###FunctionListEntry-modal)  [FunctionListEntry](###FunctionListEntry-modal)  [SecretName](###SecretName-modal)  [LogEntry](###LogEntry-modal)  [Info](###Info-modal)\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\n\u003csummary\u003echeckHealth\u003c/summary\u003e\n\ncheckHealth\n---\n **Example**\n\n ```\nresp, err := cli.GetHealthz()\n```\n**Responses**\n\n\n\u003e Success 2XX\n```json\n{\n  \"200\": {\n    \"description\": \"Healthy\"\n  }\n}\n```\n\n\u003e Error 5XX\n```json\n{\n  \"500\": {\n    \"description\": \"Not healthy\"\n  }\n}\n```\n\n######  [FunctionDefintion](###FunctionDefintion-modal)  [FunctionDefintion](###FunctionDefintion-modal)  [DeleteFunctionRequest](###DeleteFunctionRequest-modal)  [undefined](###undefined-modal)  [Secret](###Secret-modal)  [Secret](###Secret-modal)  [SecretName](###SecretName-modal)  [FunctionListEntry](###FunctionListEntry-modal)  [FunctionListEntry](###FunctionListEntry-modal)  [SecretName](###SecretName-modal)  [LogEntry](###LogEntry-modal)  [Info](###Info-modal)\n\u003c/details\u003e\n\n# Modal Definations\n\n ### Info-modal\n ```json\n{\n  \"type\": \"object\",\n  \"properties\": {\n    \"provider\": {\n      \"type\": \"object\",\n      \"description\": \"The OpenFaaS Provider\",\n      \"properties\": {\n        \"provider\": {\n          \"type\": \"string\",\n          \"example\": \"faas-swarm\"\n        },\n        \"orchestration\": {\n          \"type\": \"string\",\n          \"example\": \"swarm\"\n        },\n        \"version\": {\n          \"type\": \"object\",\n          \"description\": \"Version of the OpenFaaS Provider\",\n          \"properties\": {\n            \"commit_message\": {\n              \"type\": \"string\",\n              \"example\": \"Sample Message\"\n            },\n            \"sha\": {\n              \"type\": \"string\",\n              \"example\": \"7108418d9dd6b329ddff40e7393b3166f8160a88\"\n            },\n            \"release\": {\n              \"type\": \"string\",\n              \"format\": \"semver\",\n              \"example\": \"0.2.6\"\n            }\n          }\n        }\n      }\n    },\n    \"version\": {\n      \"type\": \"object\",\n      \"description\": \"Version of the Gateway\",\n      \"properties\": {\n        \"commit_message\": {\n          \"type\": \"string\",\n          \"example\": \"Sample Message\"\n        },\n        \"sha\": {\n          \"type\": \"string\",\n          \"example\": \"7108418d9dd6b329ddff40e7393b3166f8160a88\"\n        },\n        \"release\": {\n          \"type\": \"string\",\n          \"format\": \"semver\",\n          \"example\": \"0.8.9\"\n        }\n      }\n    },\n    \"arch\": {\n      \"type\": \"string\",\n      \"description\": \"Platform architecture\",\n      \"example\": \"x86_64\"\n    }\n  },\n  \"required\": [\n    \"provider\",\n    \"version\"\n  ]\n}\n```\n\n ### DeleteFunctionRequest-modal\n ```json\n{\n  \"type\": \"object\",\n  \"properties\": {\n    \"functionName\": {\n      \"type\": \"string\",\n      \"description\": \"Name of deployed function\",\n      \"example\": \"nodeinfo\"\n    }\n  },\n  \"required\": [\n    \"functionName\"\n  ]\n}\n```\n\n ### FunctionDefintion-modal\n ```json\n{\n  \"type\": \"object\",\n  \"properties\": {\n    \"service\": {\n      \"type\": \"string\",\n      \"description\": \"Name of deployed function\",\n      \"example\": \"nodeinfo\"\n    },\n    \"network\": {\n      \"type\": \"string\",\n      \"description\": \"Docker swarm network, usually func_functions\",\n      \"example\": \"func_functions\"\n    },\n    \"image\": {\n      \"type\": \"string\",\n      \"description\": \"Docker image in accessible registry\",\n      \"example\": \"functions/nodeinfo:latest\"\n    },\n    \"envProcess\": {\n      \"type\": \"string\",\n      \"description\": \"Process for watchdog to fork\",\n      \"example\": \"node main.js\"\n    },\n    \"envVars\": {\n      \"type\": \"object\",\n      \"additionalProperties\": {\n        \"type\": \"string\"\n      },\n      \"description\": \"Overrides to environmental variables\"\n    },\n    \"constraints\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"string\",\n        \"description\": \"Constraints are specific to OpenFaaS Provider\",\n        \"example\": \"node.platform.os == linux\"\n      }\n    },\n    \"labels\": {\n      \"description\": \"A map of labels for making scheduling or routing decisions\",\n      \"type\": \"object\",\n      \"additionalProperties\": {\n        \"type\": \"string\"\n      },\n      \"example\": {\n        \"foo\": \"bar\"\n      }\n    },\n    \"annotations\": {\n      \"description\": \"A map of annotations for management, orchestration, events and build tasks\",\n      \"type\": \"object\",\n      \"additionalProperties\": {\n        \"type\": \"string\"\n      },\n      \"example\": {\n        \"topics\": \"awesome-kafka-topic\",\n        \"foo\": \"bar\"\n      }\n    },\n    \"secrets\": {\n      \"type\": \"array\",\n      \"items\": {\n        \"type\": \"string\",\n        \"description\": \"An array of names of secrets that are required to be loaded from the Docker Swarm.\",\n        \"example\": \"secret-name-1\"\n      }\n    },\n    \"registryAuth\": {\n      \"type\": \"string\",\n      \"description\": \"Private registry base64-encoded basic auth (as present in ~/.docker/config.json)\",\n      \"example\": \"dXNlcjpwYXNzd29yZA==\"\n    },\n    \"limits\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"memory\": {\n          \"type\": \"string\",\n          \"example\": \"128M\"\n        },\n        \"cpu\": {\n          \"type\": \"string\",\n          \"example\": \"0.01\"\n        }\n      }\n    },\n    \"requests\": {\n      \"type\": \"object\",\n      \"properties\": {\n        \"memory\": {\n          \"type\": \"string\",\n          \"example\": \"128M\"\n        },\n        \"cpu\": {\n          \"type\": \"string\",\n          \"example\": \"0.01\"\n        }\n      }\n    },\n    \"readOnlyRootFilesystem\": {\n      \"type\": \"boolean\",\n      \"description\": \"Make the root filesystem of the function read-only\"\n    }\n  },\n  \"required\": [\n    \"service\",\n    \"image\",\n    \"envProcess\"\n  ]\n}\n```\n\n ### FunctionListEntry-modal\n ```json\n{\n  \"type\": \"object\",\n  \"properties\": {\n    \"name\": {\n      \"description\": \"The name of the function\",\n      \"type\": \"string\",\n      \"example\": \"nodeinfo\"\n    },\n    \"image\": {\n      \"description\": \"The fully qualified docker image name of the function\",\n      \"type\": \"string\",\n      \"example\": \"functions/nodeinfo:latest\"\n    },\n    \"invocationCount\": {\n      \"description\": \"The amount of invocations for the specified function\",\n      \"type\": \"number\",\n      \"format\": \"integer\",\n      \"example\": 1337\n    },\n    \"replicas\": {\n      \"description\": \"The current minimal ammount of replicas\",\n      \"type\": \"number\",\n      \"format\": \"integer\",\n      \"example\": 2\n    },\n    \"availableReplicas\": {\n      \"description\": \"The current available amount of replicas\",\n      \"type\": \"number\",\n      \"format\": \"integer\",\n      \"example\": 2\n    },\n    \"envProcess\": {\n      \"description\": \"Process for watchdog to fork\",\n      \"type\": \"string\",\n      \"example\": \"node main.js\"\n    },\n    \"labels\": {\n      \"description\": \"A map of labels for making scheduling or routing decisions\",\n      \"type\": \"object\",\n      \"additionalProperties\": {\n        \"type\": \"string\"\n      },\n      \"example\": {\n        \"foo\": \"bar\"\n      }\n    },\n    \"annotations\": {\n      \"description\": \"A map of annotations for management, orchestration, events and build tasks\",\n      \"type\": \"object\",\n      \"additionalProperties\": {\n        \"type\": \"string\"\n      },\n      \"example\": {\n        \"topics\": \"awesome-kafka-topic\",\n        \"foo\": \"bar\"\n      }\n    }\n  },\n  \"required\": [\n    \"name\",\n    \"image\",\n    \"invocationCount\",\n    \"replicas\",\n    \"availableReplicas\",\n    \"envProcess\",\n    \"labels\"\n  ]\n}\n```\n\n ### Secret-modal\n ```json\n{\n  \"type\": \"object\",\n  \"properties\": {\n    \"name\": {\n      \"type\": \"string\",\n      \"description\": \"Name of secret\",\n      \"example\": \"aws-key\"\n    },\n    \"value\": {\n      \"type\": \"string\",\n      \"description\": \"Value of secret in plain-text\",\n      \"example\": \"changeme\"\n    }\n  },\n  \"required\": [\n    \"name\"\n  ]\n}\n```\n\n ### LogEntry-modal\n ```json\n{\n  \"type\": \"object\",\n  \"properties\": {\n    \"name\": {\n      \"type\": \"string\",\n      \"description\": \"the function name\"\n    },\n    \"instance\": {\n      \"type\": \"string\",\n      \"description\": \"the name/id of the specific function instance\"\n    },\n    \"timestamp\": {\n      \"type\": \"string\",\n      \"format\": \"date-time\",\n      \"description\": \"the timestamp of when the log message was recorded\"\n    },\n    \"text\": {\n      \"type\": \"string\",\n      \"description\": \"raw log message content\"\n    }\n  }\n}\n```\n\n ### SecretName-modal\n ```json\n{\n  \"type\": \"object\",\n  \"properties\": {\n    \"name\": {\n      \"type\": \"string\",\n      \"description\": \"Name of secret\",\n      \"example\": \"aws-key\"\n    }\n  }\n}\n```\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvitwit%2Fgofaas","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fvitwit%2Fgofaas","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fvitwit%2Fgofaas/lists"}