bakito / adguardhome-sync

65%

main: 65%

LAST BUILD ON BRANCH add/api-documentation

branch: add/api-documentation

CHANGE BRANCH

x

Reset

Sync Branches

• add/api-documentation
• Go1.23
• actions
• bakito-linux-aarch64
• bakito-patch-1
• bakito-patch-2
• bakito-patch-3
• check-dhcp-config
• config-issues
• config-validation
• container-tests
• content-len
• cookie-support
• correct-dchp-sync-message
• correct-interfacename-env-var-name
• debug-e2e
• dependabot/github_actions/actions/checkout-3
• dependabot/github_actions/actions/checkout-4
• dependabot/github_actions/actions/setup-go-3
• dependabot/github_actions/actions/setup-go-4
• dependabot/github_actions/actions/setup-go-5
• dependabot/github_actions/dcarbone/install-jq-action-3
• dependabot/github_actions/docker/build-push-action-3
• dependabot/github_actions/docker/build-push-action-4
• dependabot/github_actions/docker/build-push-action-5
• dependabot/github_actions/docker/build-push-action-6
• dependabot/github_actions/docker/login-action-3
• dependabot/github_actions/docker/setup-buildx-action-3
• dependabot/github_actions/docker/setup-qemu-action-3
• dependabot/github_actions/github/codeql-action-3
• dependabot/github_actions/golangci/golangci-lint-action-4
• dependabot/github_actions/golangci/golangci-lint-action-5
• dependabot/github_actions/golangci/golangci-lint-action-6
• dependabot/github_actions/goreleaser/goreleaser-action-3
• dependabot/github_actions/goreleaser/goreleaser-action-4
• dependabot/github_actions/goreleaser/goreleaser-action-5
• dependabot/github_actions/goreleaser/goreleaser-action-6
• dependabot/github_actions/helm/kind-action-1.4.0
• dependabot/github_actions/helm/kind-action-1.5.0
• dependabot/go_modules/github.com/cloudflare/circl-1.3.7
• dependabot/go_modules/github.com/deepmap/oapi-codegen/v2-2.1.0
• dependabot/go_modules/github.com/docker/docker-24.0.9incompatible
• dependabot/go_modules/github.com/gin-gonic/gin-1.10.0
• dependabot/go_modules/github.com/gin-gonic/gin-1.8.0
• dependabot/go_modules/github.com/gin-gonic/gin-1.8.1
• dependabot/go_modules/github.com/gin-gonic/gin-1.8.2
• dependabot/go_modules/github.com/gin-gonic/gin-1.9.0
• dependabot/go_modules/github.com/gin-gonic/gin-1.9.1
• dependabot/go_modules/github.com/go-git/go-git/v5-5.11.0
• dependabot/go_modules/github.com/go-resty/resty/v2-2.10.0
• dependabot/go_modules/github.com/go-resty/resty/v2-2.11.0
• dependabot/go_modules/github.com/go-resty/resty/v2-2.12.0
• dependabot/go_modules/github.com/go-resty/resty/v2-2.13.1
• dependabot/go_modules/github.com/go-resty/resty/v2-2.14.0
• dependabot/go_modules/github.com/go-resty/resty/v2-2.16.0
• dependabot/go_modules/github.com/go-resty/resty/v2-2.16.2
• dependabot/go_modules/github.com/go-resty/resty/v2-2.6.0
• dependabot/go_modules/github.com/go-resty/resty/v2-2.7.0
• dependabot/go_modules/github.com/go-resty/resty/v2-2.8.0
• dependabot/go_modules/github.com/go-resty/resty/v2-2.9.1
• dependabot/go_modules/github.com/golang/mock-1.5.0
• dependabot/go_modules/github.com/golang/mock-1.6.0
• dependabot/go_modules/github.com/golangci/golangci-lint-1.56.1
• dependabot/go_modules/github.com/golangci/golangci-lint-1.56.2
• dependabot/go_modules/github.com/golangci/golangci-lint-1.57.1
• dependabot/go_modules/github.com/golangci/golangci-lint-1.57.2
• dependabot/go_modules/github.com/google/uuid-1.3.0
• dependabot/go_modules/github.com/google/uuid-1.3.1
• dependabot/go_modules/github.com/google/uuid-1.4.0
• dependabot/go_modules/github.com/google/uuid-1.5.0
• dependabot/go_modules/github.com/google/uuid-1.6.0
• dependabot/go_modules/github.com/goreleaser/goreleaser-1.24.0
• dependabot/go_modules/github.com/jinzhu/copier-0.4.0
• dependabot/go_modules/github.com/oapi-codegen/runtime-1.1.0
• dependabot/go_modules/github.com/onsi/ginkgo-1.16.1
• dependabot/go_modules/github.com/onsi/ginkgo-1.16.2
• dependabot/go_modules/github.com/onsi/ginkgo-1.16.4
• dependabot/go_modules/github.com/onsi/ginkgo-1.16.5
• dependabot/go_modules/github.com/onsi/ginkgo/v2-2.0.0
• dependabot/go_modules/github.com/onsi/ginkgo/v2-2.0.0-rc3
• dependabot/go_modules/github.com/onsi/ginkgo/v2-2.1.0
• dependabot/go_modules/github.com/onsi/ginkgo/v2-2.1.1
• dependabot/go_modules/github.com/onsi/ginkgo/v2-2.1.2
• dependabot/go_modules/github.com/onsi/ginkgo/v2-2.1.3
• dependabot/go_modules/github.com/onsi/ginkgo/v2-2.1.4
• dependabot/go_modules/github.com/onsi/ginkgo/v2-2.1.6
• dependabot/go_modules/github.com/onsi/ginkgo/v2-2.10.0
• dependabot/go_modules/github.com/onsi/ginkgo/v2-2.11.0
• dependabot/go_modules/github.com/onsi/ginkgo/v2-2.12.0
• dependabot/go_modules/github.com/onsi/ginkgo/v2-2.12.1
• dependabot/go_modules/github.com/onsi/ginkgo/v2-2.13.0
• dependabot/go_modules/github.com/onsi/ginkgo/v2-2.13.1
• dependabot/go_modules/github.com/onsi/ginkgo/v2-2.13.2
• dependabot/go_modules/github.com/onsi/ginkgo/v2-2.14.0
• dependabot/go_modules/github.com/onsi/ginkgo/v2-2.2.0
• dependabot/go_modules/github.com/onsi/ginkgo/v2-2.3.1
• dependabot/go_modules/github.com/onsi/ginkgo/v2-2.4.0
• dependabot/go_modules/github.com/onsi/ginkgo/v2-2.5.0
• dependabot/go_modules/github.com/onsi/ginkgo/v2-2.5.1
• dependabot/go_modules/github.com/onsi/ginkgo/v2-2.6.0
• dependabot/go_modules/github.com/onsi/ginkgo/v2-2.6.1
• dependabot/go_modules/github.com/onsi/ginkgo/v2-2.7.0
• dependabot/go_modules/github.com/onsi/ginkgo/v2-2.7.1
• dependabot/go_modules/github.com/onsi/ginkgo/v2-2.8.0
• dependabot/go_modules/github.com/onsi/ginkgo/v2-2.8.3
• dependabot/go_modules/github.com/onsi/ginkgo/v2-2.9.0
• dependabot/go_modules/github.com/onsi/ginkgo/v2-2.9.1
• dependabot/go_modules/github.com/onsi/ginkgo/v2-2.9.2
• dependabot/go_modules/github.com/onsi/ginkgo/v2-2.9.4
• dependabot/go_modules/github.com/onsi/ginkgo/v2-2.9.5
• dependabot/go_modules/github.com/onsi/ginkgo/v2-2.9.7
• dependabot/go_modules/github.com/onsi/gomega-1.12.0
• dependabot/go_modules/github.com/onsi/gomega-1.13.0
• dependabot/go_modules/github.com/onsi/gomega-1.14.0
• dependabot/go_modules/github.com/onsi/gomega-1.15.0
• dependabot/go_modules/github.com/onsi/gomega-1.16.0
• dependabot/go_modules/github.com/onsi/gomega-1.17.0
• dependabot/go_modules/github.com/onsi/gomega-1.18.0
• dependabot/go_modules/github.com/onsi/gomega-1.18.1
• dependabot/go_modules/github.com/onsi/gomega-1.19.0
• dependabot/go_modules/github.com/onsi/gomega-1.20.0
• dependabot/go_modules/github.com/onsi/gomega-1.20.1
• dependabot/go_modules/github.com/onsi/gomega-1.20.2
• dependabot/go_modules/github.com/onsi/gomega-1.21.1
• dependabot/go_modules/github.com/onsi/gomega-1.22.1
• dependabot/go_modules/github.com/onsi/gomega-1.23.0
• dependabot/go_modules/github.com/onsi/gomega-1.24.0
• dependabot/go_modules/github.com/onsi/gomega-1.24.1
• dependabot/go_modules/github.com/onsi/gomega-1.24.2
• dependabot/go_modules/github.com/onsi/gomega-1.25.0
• dependabot/go_modules/github.com/onsi/gomega-1.26.0
• dependabot/go_modules/github.com/onsi/gomega-1.27.1
• dependabot/go_modules/github.com/onsi/gomega-1.27.10
• dependabot/go_modules/github.com/onsi/gomega-1.27.2
• dependabot/go_modules/github.com/onsi/gomega-1.27.3
• dependabot/go_modules/github.com/onsi/gomega-1.27.4
• dependabot/go_modules/github.com/onsi/gomega-1.27.5
• dependabot/go_modules/github.com/onsi/gomega-1.27.6
• dependabot/go_modules/github.com/onsi/gomega-1.27.7
• dependabot/go_modules/github.com/onsi/gomega-1.27.8
• dependabot/go_modules/github.com/onsi/gomega-1.27.9
• dependabot/go_modules/github.com/onsi/gomega-1.28.0
• dependabot/go_modules/github.com/onsi/gomega-1.28.1
• dependabot/go_modules/github.com/onsi/gomega-1.29.0
• dependabot/go_modules/github.com/onsi/gomega-1.30.0
• dependabot/go_modules/github.com/prometheus/client_golang-1.19.0
• dependabot/go_modules/github.com/prometheus/client_golang-1.19.1
• dependabot/go_modules/github.com/quic-go/quic-go-0.54.1
• dependabot/go_modules/github.com/quic-go/quic-go-0.57.0
• dependabot/go_modules/github.com/quic-go/quic-go-0.59.1
• dependabot/go_modules/github.com/spf13/cobra-1.2.1
• dependabot/go_modules/github.com/spf13/cobra-1.3.0
• dependabot/go_modules/github.com/spf13/cobra-1.5.0
• dependabot/go_modules/github.com/spf13/cobra-1.6.0
• dependabot/go_modules/github.com/spf13/cobra-1.6.1
• dependabot/go_modules/github.com/spf13/cobra-1.7.0
• dependabot/go_modules/github.com/spf13/cobra-1.8.0
• dependabot/go_modules/github.com/spf13/cobra-1.8.1
• dependabot/go_modules/github.com/spf13/viper-1.10.0
• dependabot/go_modules/github.com/spf13/viper-1.10.1
• dependabot/go_modules/github.com/spf13/viper-1.11.0
• dependabot/go_modules/github.com/spf13/viper-1.12.0
• dependabot/go_modules/github.com/spf13/viper-1.13.0
• dependabot/go_modules/github.com/spf13/viper-1.14.0
• dependabot/go_modules/github.com/spf13/viper-1.15.0
• dependabot/go_modules/github.com/spf13/viper-1.16.0
• dependabot/go_modules/github.com/spf13/viper-1.17.0
• dependabot/go_modules/github.com/spf13/viper-1.18.1
• dependabot/go_modules/github.com/spf13/viper-1.18.2
• dependabot/go_modules/github.com/spf13/viper-1.8.0
• dependabot/go_modules/github.com/spf13/viper-1.8.1
• dependabot/go_modules/go.uber.org/zap-1.17.0
• dependabot/go_modules/go.uber.org/zap-1.18.1
• dependabot/go_modules/go.uber.org/zap-1.19.0
• dependabot/go_modules/go.uber.org/zap-1.19.1
• dependabot/go_modules/go.uber.org/zap-1.20.0
• dependabot/go_modules/go.uber.org/zap-1.21.0
• dependabot/go_modules/go.uber.org/zap-1.22.0
• dependabot/go_modules/go.uber.org/zap-1.23.0
• dependabot/go_modules/go.uber.org/zap-1.24.0
• dependabot/go_modules/go.uber.org/zap-1.25.0
• dependabot/go_modules/go.uber.org/zap-1.26.0
• dependabot/go_modules/go.uber.org/zap-1.27.0
• dependabot/go_modules/golang.org/x/crypto-0.17.0
• dependabot/go_modules/golang.org/x/crypto-0.31.0
• dependabot/go_modules/golang.org/x/crypto-0.45.0
• dependabot/go_modules/golang.org/x/mod-0.10.0
• dependabot/go_modules/golang.org/x/mod-0.11.0
• dependabot/go_modules/golang.org/x/mod-0.12.0
• dependabot/go_modules/golang.org/x/mod-0.13.0
• dependabot/go_modules/golang.org/x/mod-0.14.0
• dependabot/go_modules/golang.org/x/mod-0.15.0
• dependabot/go_modules/golang.org/x/mod-0.16.0
• dependabot/go_modules/golang.org/x/mod-0.17.0
• dependabot/go_modules/golang.org/x/mod-0.18.0
• dependabot/go_modules/golang.org/x/mod-0.19.0
• dependabot/go_modules/golang.org/x/mod-0.20.0
• dependabot/go_modules/golang.org/x/mod-0.5.1
• dependabot/go_modules/golang.org/x/mod-0.6.0
• dependabot/go_modules/golang.org/x/mod-0.8.0
• dependabot/go_modules/golang.org/x/mod-0.9.0
• dependabot/go_modules/golang.org/x/net-0.17.0
• dependabot/go_modules/golang.org/x/net-0.23.0
• dependabot/go_modules/golang.org/x/net-0.36.0
• dependabot/go_modules/golang.org/x/net-0.7.0
• dependabot/go_modules/google.golang.org/protobuf-1.33.0
• dependabot/go_modules/gopkg.in/go-jose/go-jose.v2-2.6.3
• dependabot/go_modules/k8s-8c9033ca76
• dependabot/go_modules/k8s-8d0171f7b2
• dependabot/go_modules/k8s-dae8afb270
• dependabot/go_modules/k8s-deefb2204b
• dependabot/go_modules/k8s-e5d201adef
• dependabot/go_modules/k8s-ee2881e4d1
• dependabot/go_modules/k8s-fee84e293f
• dependabot/go_modules/k8s.io/apimachinery-0.28.4
• dependabot/go_modules/k8s.io/apimachinery-0.29.0
• dependabot/go_modules/k8s.io/apimachinery-0.29.1
• dependabot/go_modules/k8s.io/code-generator-0.29.1
• dependabot/go_modules/onsi-195f8a816d
• dependabot/go_modules/onsi-1b1c53bfdd
• dependabot/go_modules/onsi-44ad4d28dd
• dependabot/go_modules/onsi-64ab4fdf8a
• dependabot/go_modules/onsi-74105ccef4
• dependabot/go_modules/onsi-800b261146
• dependabot/go_modules/onsi-8c24f35628
• dependabot/go_modules/onsi-a90ed34d00
• dependabot/go_modules/onsi-b457c624b7
• dependabot/go_modules/onsi-eefcadffdb
• dhcpServerEnabled-handling
• disable-docker-build-provenance
• disable-tls
• dns-dhcp
• docs-gen
• docs/run-as-service-via-systemd
• e2e
• e2e-config
• e2e-error
• e2e-error-handling
• e2e-logs
• e2e-tests
• e2e-with-helm
• enable-dhcp-server
• env-config
• extend-issue-templates
• filter-settings
• fix-api-inconsistency
• fix-dns-feature-logs
• fix-e2e-test
• fix-flag-type
• format-code
• gha
• golang-ci-v2
• govulncheck
• handle-empty-client-bss
• handle-new-install-location
• headers
• image-label
• imgbot
• ingnore-empty-config-file
• initial-setup
• internal
• log-format
• log-os-and-arch
• logo
• logs
• main
• mask
• metrics
• more-docs
• more-readable-env-vars
• mrstegeman/openbsd
• multi-graph
• nan
• offline-css-js
• openapi-gen
• os-tests
• patch-1
• prevent-nil-user-rules
• print-config
• print-config-in-debug-mode
• profile-sync-condition
• qlc-with-ignored
• rem-exp
• remove-deprecations
• remove-ginkgo
• renovate/adguardteam-adguardhome-0.x
• renovate/configure
• renovate/dcarbone-install-jq-action-3.x
• renovate/github-actions
• renovate/github.com-anchore-syft-cmd-syft-1.x
• renovate/github.com-bakito-docs-gen-0.x
• renovate/github.com-bakito-semver-1.x
• renovate/github.com-bytedance-sonic-1.x
• renovate/github.com-caarlos0-env-v10-11.x
• renovate/github.com-caarlos0-env-v11-11.x
• renovate/github.com-deepmap-oapi-codegen-v2-cmd-oapi-codegen-2.x
• renovate/github.com-gin-gonic-gin-1.x
• renovate/github.com-go-faker-faker-v4-4.x
• renovate/github.com-go-resty-resty-v2-2.x
• renovate/github.com-golangci-golangci-lint-cmd-golangci-lint-1.x
• renovate/github.com-golangci-golangci-lint-cmd-golangci-lint-2.x
• renovate/github.com-golangci-golangci-lint-v2-2.x
• renovate/github.com-golangci-golangci-lint-v2-cmd-golangci-lint-2.x
• renovate/github.com-google-pprof-digest
• renovate/github.com-goreleaser-goreleaser-v2-2.x
• renovate/github.com-kubernetes-sigs-controller-tools-0.x
• renovate/github.com-mvdan-gofumpt-0.x
• renovate/github.com-oapi-codegen-oapi-codegen-v2-2.x
• renovate/github.com-oapi-codegen-runtime-1.x
• renovate/github.com-onsi-gomega-1.x
• renovate/github.com-prometheus-client_golang-1.x
• renovate/github.com-santhosh-tekuri-jsonschema-v5-6.x
• renovate/github.com-santhosh-tekuri-jsonschema-v6-6.x
• renovate/github.com-segmentio-golines-0.x
• renovate/github.com-spf13-cobra-1.x
• renovate/github.com-uber-go-mock-0.x
• renovate/go.uber.org-mock-0.x
• renovate/go.uber.org-mock-mockgen-0.x
• renovate/golang-1.x
• renovate/golang.org-x-exp-digest
• renovate/golang.org-x-mod-0.x
• renovate/indirect-go-dependencies
• renovate/k8s
• renovate/k8s.io-apimachinery-0.x
• renovate/k8s.io-utils-digest
• renovate/major-github-actions
• renovate/major-indirect-go-dependencies
• renovate/mvdan.cc-gofumpt-0.x
• renovate/onsi
• renovate/sigs.k8s.io-controller-tools-cmd-controller-gen-0.x
• renovate/uber
• repo-sync/github-files/default
• resty
• rewrite-in-e2e
• rewrite-sessings
• run-on-start
• sanitize-dns-config
• skip-docker-login
• stats
• status-protection-flag
• styling
• sync-actions
• sync-metrics
• templates
• test-docs
• test-with-ginkgo
• testify
• tests
• theme-feature
• tls-mode
• tools-as-dependencies
• typo-fix
• tzdata
• uber-mock
• update-dependencies
• update-deps
• update-model
• update-time-calc
• upgrade-agh
• upgrade-to-v0.107.68
• version-check
• vt
• web-url-override
• yaml-docs

Build # 29982921574

Build Type

Pull #888

github

Committed by bakito

Commit Message

Add comprehensive API documentation to README.md

Pull Request Pull Request #888: docs: Add comprehensive API documentation to README.md

Coverage Stats

1921 of 2933 relevant lines covered (65.5%)

0.75 hits per line