From c98114237f3e1af2d1d3075cf59aca7c43fba9da Mon Sep 17 00:00:00 2001 From: lubronzhan Date: Mon, 7 Aug 2023 17:11:12 -0700 Subject: [PATCH] Grouped CI related cherry-picks - Add args to golangci-lint to show lines number #2180 - Align github actions with upstream CAPI #2167 - flavorgen generates all flavors by default #2172 - only CI parts - Add verify-govulncheck target and integrate to scan action #2174 - Use shellcheck binary instead of self-built docker image #2211 - Add doctoc and generate + verify targets #2147 - only CI parts --- .github/dependabot.yml | 27 +- ...langci-lint.yaml => pr-golangci-lint.yaml} | 7 +- .github/workflows/pr-md-link-check.yaml | 23 + .../{verify-pr.yml => pr-verify.yaml} | 4 +- .github/workflows/release.yaml | 2 +- .github/workflows/scan.yaml | 32 - .github/workflows/weekly-md-link-check.yaml | 26 + .github/workflows/weekly-security-scan.yaml | 32 + .github/workflows/weekly-test-release.yaml | 40 + .markdownlinkcheck.json | 17 + Makefile | 62 +- contrib/haproxy/openapi/docs/ACLApi.md | 264 -- contrib/haproxy/openapi/docs/Acl.md | 14 - contrib/haproxy/openapi/docs/Backend.md | 35 - contrib/haproxy/openapi/docs/BackendApi.md | 244 -- .../haproxy/openapi/docs/BackendHashType.md | 13 - .../haproxy/openapi/docs/BackendOptionsApi.md | 2528 ----------- .../haproxy/openapi/docs/BackendStickTable.md | 17 - .../openapi/docs/BackendSwitchingRule.md | 14 - .../openapi/docs/BackendSwitchingRuleApi.md | 254 -- contrib/haproxy/openapi/docs/Balance.md | 12 - contrib/haproxy/openapi/docs/Bind.md | 23 - contrib/haproxy/openapi/docs/BindApi.md | 254 -- .../haproxy/openapi/docs/ConfigurationApi.md | 100 - contrib/haproxy/openapi/docs/DefaultServer.md | 14 - contrib/haproxy/openapi/docs/Defaults.md | 45 - contrib/haproxy/openapi/docs/DefaultsApi.md | 100 - contrib/haproxy/openapi/docs/DiscoveryApi.md | 163 - contrib/haproxy/openapi/docs/Endpoint.md | 13 - contrib/haproxy/openapi/docs/Errorfile.md | 12 - contrib/haproxy/openapi/docs/Filter.md | 19 - contrib/haproxy/openapi/docs/FilterApi.md | 264 -- contrib/haproxy/openapi/docs/Forwardfor.md | 14 - contrib/haproxy/openapi/docs/Frontend.md | 30 - contrib/haproxy/openapi/docs/FrontendApi.md | 244 -- .../openapi/docs/FrontendOptionsApi.md | 2282 ---------- contrib/haproxy/openapi/docs/Global.md | 23 - contrib/haproxy/openapi/docs/GlobalApi.md | 100 - contrib/haproxy/openapi/docs/GlobalCpuMaps.md | 12 - .../haproxy/openapi/docs/GlobalRuntimeApis.md | 15 - .../docs/HAProxyConfigurationManagementApi.md | 3768 ----------------- .../openapi/docs/HTTPRequestRuleApi.md | 264 -- .../openapi/docs/HTTPResponseRuleApi.md | 264 -- .../haproxy/openapi/docs/HttpRequestRule.md | 33 - .../haproxy/openapi/docs/HttpResponseRule.md | 31 - contrib/haproxy/openapi/docs/Httpchk.md | 13 - contrib/haproxy/openapi/docs/Info.md | 12 - contrib/haproxy/openapi/docs/InfoApi.md | 12 - contrib/haproxy/openapi/docs/InfoSystem.md | 16 - .../haproxy/openapi/docs/InfoSystemCpuInfo.md | 12 - .../haproxy/openapi/docs/InfoSystemMemInfo.md | 13 - .../haproxy/openapi/docs/InformationApi.md | 70 - .../haproxy/openapi/docs/InlineResponse200.md | 12 - .../openapi/docs/InlineResponse2001.md | 12 - .../openapi/docs/InlineResponse20010.md | 12 - .../openapi/docs/InlineResponse20011.md | 12 - .../openapi/docs/InlineResponse20012.md | 12 - .../openapi/docs/InlineResponse20013.md | 12 - .../openapi/docs/InlineResponse20014.md | 12 - .../openapi/docs/InlineResponse20015.md | 12 - .../openapi/docs/InlineResponse20016.md | 12 - .../openapi/docs/InlineResponse20017.md | 12 - .../openapi/docs/InlineResponse20018.md | 12 - .../openapi/docs/InlineResponse20019.md | 12 - .../openapi/docs/InlineResponse2002.md | 12 - .../openapi/docs/InlineResponse20020.md | 12 - .../openapi/docs/InlineResponse20021.md | 12 - .../openapi/docs/InlineResponse20022.md | 12 - .../openapi/docs/InlineResponse20023.md | 12 - .../openapi/docs/InlineResponse20024.md | 12 - .../openapi/docs/InlineResponse20025.md | 12 - .../openapi/docs/InlineResponse20026.md | 12 - .../openapi/docs/InlineResponse20027.md | 12 - .../openapi/docs/InlineResponse20028.md | 12 - .../openapi/docs/InlineResponse20029.md | 12 - .../openapi/docs/InlineResponse2003.md | 12 - .../openapi/docs/InlineResponse20030.md | 12 - .../openapi/docs/InlineResponse20031.md | 12 - .../openapi/docs/InlineResponse20032.md | 12 - .../openapi/docs/InlineResponse2004.md | 12 - .../openapi/docs/InlineResponse2005.md | 12 - .../openapi/docs/InlineResponse2006.md | 12 - .../openapi/docs/InlineResponse2007.md | 12 - .../openapi/docs/InlineResponse2008.md | 12 - .../openapi/docs/InlineResponse2009.md | 12 - contrib/haproxy/openapi/docs/LogTarget.md | 19 - contrib/haproxy/openapi/docs/LogTargetApi.md | 264 -- contrib/haproxy/openapi/docs/ModelError.md | 12 - contrib/haproxy/openapi/docs/NativeStat.md | 14 - .../haproxy/openapi/docs/NativeStatStats.md | 88 - contrib/haproxy/openapi/docs/ProcessInfo.md | 11 - .../openapi/docs/ProcessInfoHaproxy.md | 15 - contrib/haproxy/openapi/docs/Redispatch.md | 12 - contrib/haproxy/openapi/docs/Reload.md | 14 - contrib/haproxy/openapi/docs/ReloadsApi.md | 74 - contrib/haproxy/openapi/docs/Server.md | 28 - contrib/haproxy/openapi/docs/ServerApi.md | 254 -- .../openapi/docs/ServerSwitchingRule.md | 14 - .../openapi/docs/ServerSwitchingRuleApi.md | 254 -- contrib/haproxy/openapi/docs/Site.md | 13 - contrib/haproxy/openapi/docs/SiteFarms.md | 18 - contrib/haproxy/openapi/docs/SiteService.md | 14 - contrib/haproxy/openapi/docs/SitesApi.md | 244 -- .../haproxy/openapi/docs/SpecificationApi.md | 39 - contrib/haproxy/openapi/docs/StatsApi.md | 54 - contrib/haproxy/openapi/docs/StickRule.md | 16 - contrib/haproxy/openapi/docs/StickRuleApi.md | 254 -- .../haproxy/openapi/docs/TCPRequestRuleApi.md | 264 -- .../openapi/docs/TCPResponseRuleApi.md | 254 -- .../haproxy/openapi/docs/TcpRequestRule.md | 16 - .../haproxy/openapi/docs/TcpResponseRule.md | 16 - contrib/haproxy/openapi/docs/Transaction.md | 13 - .../haproxy/openapi/docs/TransactionsApi.md | 203 - docs/release/release-tasks.md | 188 + hack/{check-shell.sh => generate-doctoc.sh} | 19 +- hack/match-release-tag.sh | 108 - hack/tools/shellcheck/Dockerfile | 31 - hack/tools/shellcheck/Makefile | 27 - .../shellcheck/shellcheck.sh => utils.sh} | 12 +- hack/verify-container-images.sh | 2 +- hack/verify-shellcheck.sh | 79 + 121 files changed, 490 insertions(+), 14765 deletions(-) rename .github/workflows/{golangci-lint.yaml => pr-golangci-lint.yaml} (78%) create mode 100644 .github/workflows/pr-md-link-check.yaml rename .github/workflows/{verify-pr.yml => pr-verify.yaml} (73%) delete mode 100644 .github/workflows/scan.yaml create mode 100644 .github/workflows/weekly-md-link-check.yaml create mode 100644 .github/workflows/weekly-security-scan.yaml create mode 100644 .github/workflows/weekly-test-release.yaml create mode 100644 .markdownlinkcheck.json delete mode 100644 contrib/haproxy/openapi/docs/ACLApi.md delete mode 100644 contrib/haproxy/openapi/docs/Acl.md delete mode 100644 contrib/haproxy/openapi/docs/Backend.md delete mode 100644 contrib/haproxy/openapi/docs/BackendApi.md delete mode 100644 contrib/haproxy/openapi/docs/BackendHashType.md delete mode 100644 contrib/haproxy/openapi/docs/BackendOptionsApi.md delete mode 100644 contrib/haproxy/openapi/docs/BackendStickTable.md delete mode 100644 contrib/haproxy/openapi/docs/BackendSwitchingRule.md delete mode 100644 contrib/haproxy/openapi/docs/BackendSwitchingRuleApi.md delete mode 100644 contrib/haproxy/openapi/docs/Balance.md delete mode 100644 contrib/haproxy/openapi/docs/Bind.md delete mode 100644 contrib/haproxy/openapi/docs/BindApi.md delete mode 100644 contrib/haproxy/openapi/docs/ConfigurationApi.md delete mode 100644 contrib/haproxy/openapi/docs/DefaultServer.md delete mode 100644 contrib/haproxy/openapi/docs/Defaults.md delete mode 100644 contrib/haproxy/openapi/docs/DefaultsApi.md delete mode 100644 contrib/haproxy/openapi/docs/DiscoveryApi.md delete mode 100644 contrib/haproxy/openapi/docs/Endpoint.md delete mode 100644 contrib/haproxy/openapi/docs/Errorfile.md delete mode 100644 contrib/haproxy/openapi/docs/Filter.md delete mode 100644 contrib/haproxy/openapi/docs/FilterApi.md delete mode 100644 contrib/haproxy/openapi/docs/Forwardfor.md delete mode 100644 contrib/haproxy/openapi/docs/Frontend.md delete mode 100644 contrib/haproxy/openapi/docs/FrontendApi.md delete mode 100644 contrib/haproxy/openapi/docs/FrontendOptionsApi.md delete mode 100644 contrib/haproxy/openapi/docs/Global.md delete mode 100644 contrib/haproxy/openapi/docs/GlobalApi.md delete mode 100644 contrib/haproxy/openapi/docs/GlobalCpuMaps.md delete mode 100644 contrib/haproxy/openapi/docs/GlobalRuntimeApis.md delete mode 100644 contrib/haproxy/openapi/docs/HAProxyConfigurationManagementApi.md delete mode 100644 contrib/haproxy/openapi/docs/HTTPRequestRuleApi.md delete mode 100644 contrib/haproxy/openapi/docs/HTTPResponseRuleApi.md delete mode 100644 contrib/haproxy/openapi/docs/HttpRequestRule.md delete mode 100644 contrib/haproxy/openapi/docs/HttpResponseRule.md delete mode 100644 contrib/haproxy/openapi/docs/Httpchk.md delete mode 100644 contrib/haproxy/openapi/docs/Info.md delete mode 100644 contrib/haproxy/openapi/docs/InfoApi.md delete mode 100644 contrib/haproxy/openapi/docs/InfoSystem.md delete mode 100644 contrib/haproxy/openapi/docs/InfoSystemCpuInfo.md delete mode 100644 contrib/haproxy/openapi/docs/InfoSystemMemInfo.md delete mode 100644 contrib/haproxy/openapi/docs/InformationApi.md delete mode 100644 contrib/haproxy/openapi/docs/InlineResponse200.md delete mode 100644 contrib/haproxy/openapi/docs/InlineResponse2001.md delete mode 100644 contrib/haproxy/openapi/docs/InlineResponse20010.md delete mode 100644 contrib/haproxy/openapi/docs/InlineResponse20011.md delete mode 100644 contrib/haproxy/openapi/docs/InlineResponse20012.md delete mode 100644 contrib/haproxy/openapi/docs/InlineResponse20013.md delete mode 100644 contrib/haproxy/openapi/docs/InlineResponse20014.md delete mode 100644 contrib/haproxy/openapi/docs/InlineResponse20015.md delete mode 100644 contrib/haproxy/openapi/docs/InlineResponse20016.md delete mode 100644 contrib/haproxy/openapi/docs/InlineResponse20017.md delete mode 100644 contrib/haproxy/openapi/docs/InlineResponse20018.md delete mode 100644 contrib/haproxy/openapi/docs/InlineResponse20019.md delete mode 100644 contrib/haproxy/openapi/docs/InlineResponse2002.md delete mode 100644 contrib/haproxy/openapi/docs/InlineResponse20020.md delete mode 100644 contrib/haproxy/openapi/docs/InlineResponse20021.md delete mode 100644 contrib/haproxy/openapi/docs/InlineResponse20022.md delete mode 100644 contrib/haproxy/openapi/docs/InlineResponse20023.md delete mode 100644 contrib/haproxy/openapi/docs/InlineResponse20024.md delete mode 100644 contrib/haproxy/openapi/docs/InlineResponse20025.md delete mode 100644 contrib/haproxy/openapi/docs/InlineResponse20026.md delete mode 100644 contrib/haproxy/openapi/docs/InlineResponse20027.md delete mode 100644 contrib/haproxy/openapi/docs/InlineResponse20028.md delete mode 100644 contrib/haproxy/openapi/docs/InlineResponse20029.md delete mode 100644 contrib/haproxy/openapi/docs/InlineResponse2003.md delete mode 100644 contrib/haproxy/openapi/docs/InlineResponse20030.md delete mode 100644 contrib/haproxy/openapi/docs/InlineResponse20031.md delete mode 100644 contrib/haproxy/openapi/docs/InlineResponse20032.md delete mode 100644 contrib/haproxy/openapi/docs/InlineResponse2004.md delete mode 100644 contrib/haproxy/openapi/docs/InlineResponse2005.md delete mode 100644 contrib/haproxy/openapi/docs/InlineResponse2006.md delete mode 100644 contrib/haproxy/openapi/docs/InlineResponse2007.md delete mode 100644 contrib/haproxy/openapi/docs/InlineResponse2008.md delete mode 100644 contrib/haproxy/openapi/docs/InlineResponse2009.md delete mode 100644 contrib/haproxy/openapi/docs/LogTarget.md delete mode 100644 contrib/haproxy/openapi/docs/LogTargetApi.md delete mode 100644 contrib/haproxy/openapi/docs/ModelError.md delete mode 100644 contrib/haproxy/openapi/docs/NativeStat.md delete mode 100644 contrib/haproxy/openapi/docs/NativeStatStats.md delete mode 100644 contrib/haproxy/openapi/docs/ProcessInfo.md delete mode 100644 contrib/haproxy/openapi/docs/ProcessInfoHaproxy.md delete mode 100644 contrib/haproxy/openapi/docs/Redispatch.md delete mode 100644 contrib/haproxy/openapi/docs/Reload.md delete mode 100644 contrib/haproxy/openapi/docs/ReloadsApi.md delete mode 100644 contrib/haproxy/openapi/docs/Server.md delete mode 100644 contrib/haproxy/openapi/docs/ServerApi.md delete mode 100644 contrib/haproxy/openapi/docs/ServerSwitchingRule.md delete mode 100644 contrib/haproxy/openapi/docs/ServerSwitchingRuleApi.md delete mode 100644 contrib/haproxy/openapi/docs/Site.md delete mode 100644 contrib/haproxy/openapi/docs/SiteFarms.md delete mode 100644 contrib/haproxy/openapi/docs/SiteService.md delete mode 100644 contrib/haproxy/openapi/docs/SitesApi.md delete mode 100644 contrib/haproxy/openapi/docs/SpecificationApi.md delete mode 100644 contrib/haproxy/openapi/docs/StatsApi.md delete mode 100644 contrib/haproxy/openapi/docs/StickRule.md delete mode 100644 contrib/haproxy/openapi/docs/StickRuleApi.md delete mode 100644 contrib/haproxy/openapi/docs/TCPRequestRuleApi.md delete mode 100644 contrib/haproxy/openapi/docs/TCPResponseRuleApi.md delete mode 100644 contrib/haproxy/openapi/docs/TcpRequestRule.md delete mode 100644 contrib/haproxy/openapi/docs/TcpResponseRule.md delete mode 100644 contrib/haproxy/openapi/docs/Transaction.md delete mode 100644 contrib/haproxy/openapi/docs/TransactionsApi.md create mode 100644 docs/release/release-tasks.md rename hack/{check-shell.sh => generate-doctoc.sh} (63%) delete mode 100755 hack/match-release-tag.sh delete mode 100644 hack/tools/shellcheck/Dockerfile delete mode 100644 hack/tools/shellcheck/Makefile rename hack/{tools/shellcheck/shellcheck.sh => utils.sh} (79%) mode change 100755 => 100644 create mode 100755 hack/verify-shellcheck.sh diff --git a/.github/dependabot.yml b/.github/dependabot.yml index 2c06c1bec8..c547f772a4 100644 --- a/.github/dependabot.yml +++ b/.github/dependabot.yml @@ -11,35 +11,24 @@ updates: prefix: ":seedling:" labels: - "ok-to-test" + # Go - package-ecosystem: "gomod" directory: "/" schedule: interval: "weekly" + day: "monday" ignore: - # Ignore k8s modules as they are upgraded manually - # together with controller-runtime and CAPI dependencies. + # Ignore controller-runtime as its upgraded manually. + - dependency-name: "sigs.k8s.io/controller-runtime" + update-types: [ "version-update:semver-major", "version-update:semver-minor" ] + # Ignore k8s and its transitives modules as they are upgraded manually + # together with controller-runtime. - dependency-name: "k8s.io/*" - - dependency-name: "sigs.k8s.io/*" + update-types: [ "version-update:semver-major", "version-update:semver-minor" ] - dependency-name: "sigs.k8s.io/cluster-api/test" update-types: ["version-update:semver-major", "version-update:semver-minor"] commit-message: prefix: ":seedling:" labels: - "ok-to-test" - -- package-ecosystem: "gomod" - directory: "/hack/tools" - schedule: - interval: "weekly" - ignore: - # Ignore k8s modules as they are upgraded manually - # together with controller-runtime and CAPI dependencies. - - dependency-name: "k8s.io/*" - update-types: ["version-update:semver-major", "version-update:semver-minor"] - - dependency-name: "sigs.k8s.io/*" - update-types: ["version-update:semver-major", "version-update:semver-minor"] - commit-message: - prefix: ":seedling:" - labels: - - "ok-to-test" diff --git a/.github/workflows/golangci-lint.yaml b/.github/workflows/pr-golangci-lint.yaml similarity index 78% rename from .github/workflows/golangci-lint.yaml rename to .github/workflows/pr-golangci-lint.yaml index 62cf8b8d46..553f9cba37 100644 --- a/.github/workflows/golangci-lint.yaml +++ b/.github/workflows/pr-golangci-lint.yaml @@ -1,4 +1,4 @@ -name: golangci-lint +name: PR golangci-lint on: pull_request: @@ -17,10 +17,11 @@ jobs: id: vars run: echo "go_version=$(make go-version)" >> $GITHUB_OUTPUT - name: Set up Go - uses: actions/setup-go@fac708d6674e30b6ba41289acaab6d4b75aa0753 # tag=v4.0.1 + uses: actions/setup-go@93397bea11091df50f3d7e59dc26a7711a8bcfbe # tag=v4.1.0 with: go-version: ${{ steps.vars.outputs.go_version }} - name: golangci-lint uses: golangci/golangci-lint-action@639cd343e1d3b897ff35927a75193d57cfcba299 # tag=v3.6.0 with: - version: v1.53.3 \ No newline at end of file + version: v1.53.3 + args: --out-format=colored-line-number diff --git a/.github/workflows/pr-md-link-check.yaml b/.github/workflows/pr-md-link-check.yaml new file mode 100644 index 0000000000..87154aacac --- /dev/null +++ b/.github/workflows/pr-md-link-check.yaml @@ -0,0 +1,23 @@ +name: PR check Markdown links + +on: + pull_request: + types: [opened, edited, synchronize, reopened] + paths: + - '**.md' + +# Remove all permissions from GITHUB_TOKEN except metadata. +permissions: {} + +jobs: + markdown-link-check: + name: Broken Links + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # tag=v3.5.3 + - uses: gaurav-nelson/github-action-markdown-link-check@5c5dfc0ac2e225883c0e5f03a85311ec2830d368 # tag=v1 + with: + use-quiet-mode: 'yes' + config-file: .markdownlinkcheck.json + check-modified-files-only: 'yes' + base-branch: main diff --git a/.github/workflows/verify-pr.yml b/.github/workflows/pr-verify.yaml similarity index 73% rename from .github/workflows/verify-pr.yml rename to .github/workflows/pr-verify.yaml index e55bc24990..c835c68010 100644 --- a/.github/workflows/verify-pr.yml +++ b/.github/workflows/pr-verify.yaml @@ -1,4 +1,4 @@ -name: Verify PR +name: PR Verify on: pull_request_target: @@ -14,6 +14,6 @@ jobs: steps: - name: Verifier action id: verifier - uses: kubernetes-sigs/kubebuilder-release-tools@v0.3.0 + uses: kubernetes-sigs/kubebuilder-release-tools@4f3d1085b4458a49ed86918b4b55505716715b77 # tag=v0.3.0 with: github_token: ${{ secrets.GITHUB_TOKEN }} diff --git a/.github/workflows/release.yaml b/.github/workflows/release.yaml index 966eb893e0..323eb006be 100644 --- a/.github/workflows/release.yaml +++ b/.github/workflows/release.yaml @@ -23,7 +23,7 @@ jobs: - name: Calculate go version run: echo "go_version=$(make go-version)" >> $GITHUB_ENV - name: Set up Go - uses: actions/setup-go@fac708d6674e30b6ba41289acaab6d4b75aa0753 # tag=v4.0.1 + uses: actions/setup-go@93397bea11091df50f3d7e59dc26a7711a8bcfbe # tag=v4.1.0 with: go-version: ${{ env.go_version }} - name: generate release artifacts diff --git a/.github/workflows/scan.yaml b/.github/workflows/scan.yaml deleted file mode 100644 index f4063e8800..0000000000 --- a/.github/workflows/scan.yaml +++ /dev/null @@ -1,32 +0,0 @@ -name: scan-images - -on: - schedule: - # Cron for every Monday at 12:00 UTC. - - cron: "0 12 * * 1" - -# Remove all permissions from GITHUB_TOKEN except metadata. -permissions: {} - -jobs: - scan: - strategy: - fail-fast: false - matrix: - branch: [ main, release-1.6, release-1.5 ] - name: Trivy - runs-on: ubuntu-latest - steps: - - name: Check out code - uses: actions/checkout@8e5e7e5ab8b370d6c329ec480221332ada57f0ab # tag=v3.5.2 - with: - ref: ${{ matrix.branch }} - - name: Calculate go version - id: vars - run: echo "go_version=$(make go-version)" >> $GITHUB_OUTPUT - - name: Set up Go - uses: actions/setup-go@6edd4406fa81c3da01a34fa6f6343087c207a568 # tag=v3.5.0 - with: - go-version: ${{ steps.vars.outputs.go_version }} - - name: Run verify container script - run: make verify-container-images diff --git a/.github/workflows/weekly-md-link-check.yaml b/.github/workflows/weekly-md-link-check.yaml new file mode 100644 index 0000000000..f03ba9f3f7 --- /dev/null +++ b/.github/workflows/weekly-md-link-check.yaml @@ -0,0 +1,26 @@ +name: Weekly check all Markdown links + +on: + schedule: + # Cron for every Monday at 12:00 UTC. + - cron: "0 12 * * 1" + +# Remove all permissions from GITHUB_TOKEN except metadata. +permissions: {} + +jobs: + markdown-link-check: + name: Broken Links + strategy: + fail-fast: false + matrix: + branch: [ main, release-1.8, release-1.7, release-1.6, release-1.5 ] + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # tag=v3.5.3 + with: + ref: ${{ matrix.branch }} + - uses: gaurav-nelson/github-action-markdown-link-check@5c5dfc0ac2e225883c0e5f03a85311ec2830d368 # tag=v1 + with: + use-quiet-mode: 'yes' + config-file: .markdownlinkcheck.json diff --git a/.github/workflows/weekly-security-scan.yaml b/.github/workflows/weekly-security-scan.yaml new file mode 100644 index 0000000000..2047bcfd9c --- /dev/null +++ b/.github/workflows/weekly-security-scan.yaml @@ -0,0 +1,32 @@ +name: Weekly security scan + +on: + schedule: + # Cron for every Monday at 12:00 UTC. + - cron: "0 12 * * 1" + +# Remove all permissions from GITHUB_TOKEN except metadata. +permissions: {} + +jobs: + scan: + strategy: + fail-fast: false + matrix: + branch: [ main, release-1.8, release-1.7, release-1.6, release-1.5 ] + name: Trivy + runs-on: ubuntu-latest + steps: + - name: Check out code + uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # tag=v3.5.3 + with: + ref: ${{ matrix.branch }} + - name: Calculate go version + id: vars + run: echo "go_version=$(make go-version)" >> $GITHUB_OUTPUT + - name: Set up Go + uses: actions/setup-go@93397bea11091df50f3d7e59dc26a7711a8bcfbe # tag=v4.1.0 + with: + go-version: ${{ steps.vars.outputs.go_version }} + - name: Run verify security target + run: make verify-security diff --git a/.github/workflows/weekly-test-release.yaml b/.github/workflows/weekly-test-release.yaml new file mode 100644 index 0000000000..f6d2fdc56e --- /dev/null +++ b/.github/workflows/weekly-test-release.yaml @@ -0,0 +1,40 @@ +name: Weekly release test + +# Note: This workflow does not build for releases. It attempts to build release binaries periodically to ensure the repo +# release machinery is in a good state. + +on: + schedule: + # Cron for every day at 12:00 UTC. + - cron: "0 12 * * *" + +# Remove all permissions from GITHUB_TOKEN except metadata. +permissions: {} + +jobs: + weekly-test-release: + name: Test release + strategy: + fail-fast: false + matrix: + branch: [ main, release-1.8, release-1.7, release-1.6, release-1.5 ] + runs-on: ubuntu-latest + steps: + - uses: actions/checkout@c85c95e3d7251135ab7dc9ce3241c5835cc595a9 # tag=v3.5.3 + with: + ref: ${{ matrix.branch }} + fetch-depth: 0 + - name: Set env + run: echo "RELEASE_TAG=v9.9.9-fake" >> $GITHUB_ENV + - name: Set fake tag for release + run: | + git tag ${{ env.RELEASE_TAG }} + - name: Calculate go version + run: echo "go_version=$(make go-version)" >> $GITHUB_ENV + - name: Set up Go + uses: actions/setup-go@93397bea11091df50f3d7e59dc26a7711a8bcfbe # tag=v4.1.0 + with: + go-version: ${{ env.go_version }} + - name: Test release + run: | + make release \ No newline at end of file diff --git a/.markdownlinkcheck.json b/.markdownlinkcheck.json new file mode 100644 index 0000000000..78da0b7b6e --- /dev/null +++ b/.markdownlinkcheck.json @@ -0,0 +1,17 @@ +{ + "ignorePatterns": [{ + "pattern": "^http://localhost" + }], + "httpHeaders": [{ + "comment": "Workaround as suggested here: https://github.com/tcort/markdown-link-check/issues/201", + "urls": ["https://docs.github.com/"], + "headers": { + "Accept-Encoding": "zstd, br, gzip, deflate" + } + }], + "timeout": "10s", + "retryOn429": true, + "retryCount": 5, + "fallbackRetryDelay": "30s", + "aliveStatusCodes": [200, 206] +} diff --git a/Makefile b/Makefile index df6b8b1f92..355126d398 100644 --- a/Makefile +++ b/Makefile @@ -134,6 +134,8 @@ GO_APIDIFF_BIN := go-apidiff GO_APIDIFF := $(abspath $(TOOLS_BIN_DIR)/$(GO_APIDIFF_BIN)-$(GO_APIDIFF_VER)) GO_APIDIFF_PKG := github.com/joelanford/go-apidiff +SHELLCHECK_VER := v0.9.0 + KPROMO_VER := v4.0.4 KPROMO_BIN := kpromo KPROMO := $(abspath $(TOOLS_BIN_DIR)/$(KPROMO_BIN)-$(KPROMO_VER)) @@ -150,10 +152,15 @@ GINKGO := $(abspath $(TOOLS_BIN_DIR)/$(GINKGO_BIN)-$(GINGKO_VER)) GINKGO_PKG := github.com/onsi/ginkgo/v2/ginkgo GOLANGCI_LINT_BIN := golangci-lint -GOLANGCI_LINT_VER := $(shell cat .github/workflows/golangci-lint.yaml | grep [[:space:]]version: | sed 's/.*version: //') +GOLANGCI_LINT_VER := $(shell cat .github/workflows/pr-golangci-lint.yaml | grep [[:space:]]version: | sed 's/.*version: //') GOLANGCI_LINT := $(abspath $(TOOLS_BIN_DIR)/$(GOLANGCI_LINT_BIN)-$(GOLANGCI_LINT_VER)) GOLANGCI_LINT_PKG := github.com/golangci/golangci-lint/cmd/golangci-lint +GOVULNCHECK_BIN := govulncheck +GOVULNCHECK_VER := v1.0.0 +GOVULNCHECK := $(abspath $(TOOLS_BIN_DIR)/$(GOVULNCHECK_BIN)-$(GOVULNCHECK_VER)) +GOVULNCHECK_PKG := golang.org/x/vuln/cmd/govulncheck + GOVC_VER := $(shell cat go.mod | grep "github.com/vmware/govmomi" | awk '{print $$NF}') GOVC_BIN := govc GOVC := $(abspath $(TOOLS_BIN_DIR)/$(GOVC_BIN)-$(GOVC_VER)) @@ -228,7 +235,7 @@ help: # Display this help .PHONY: generate generate: ## Run all generate targets - $(MAKE) generate-modules generate-manifests generate-go-deepcopy generate-go-conversions + $(MAKE) generate-modules generate-manifests generate-go-deepcopy generate-go-conversions generate-flavors .PHONY: generate-manifests generate-manifests: $(CONTROLLER_GEN) ## Generate manifests e.g. CRD, RBAC etc. @@ -276,6 +283,10 @@ generate-go-conversions: $(CONTROLLER_GEN) $(CONVERSION_GEN) ## Runs Go related generate-modules: ## Run go mod tidy to ensure modules are up to date go mod tidy +.PHONY: generate-doctoc +generate-doctoc: + TRACE=$(TRACE) ./hack/generate-doctoc.sh + .PHONY: generate-e2e-templates generate-e2e-templates: ## Generate e2e cluster templates $(MAKE) release-flavors @@ -311,7 +322,6 @@ generate-e2e-templates: ## Generate e2e cluster templates lint: $(GOLANGCI_LINT) ## Lint the codebase $(MAKE) lint-go-full $(MAKE) lint-markdown - $(MAKE) lint-shell GOLANGCI_LINT_EXTRA_ARGS ?= --fast=true .PHONY: lint-go @@ -326,10 +336,6 @@ lint-go-full: lint-go ## Run slower linters to detect possible issues lint-markdown: ## Lint the project's markdown docker run --rm -v "$$(pwd)":/build$(DOCKER_VOL_OPTS) gcr.io/cluster-api-provider-vsphere/extra/mdlint:0.17.0 -- /md/lint -i contrib/haproxy/openapi -i _releasenotes . -.PHONY: lint-shell -lint-shell: ## Lint the project's shell scripts - docker run --rm -t -v "$$(pwd)":/build:ro gcr.io/cluster-api-provider-vsphere/extra/shellcheck - .PHONY: lint-fix lint-fix: $(GOLANGCI_LINT) ## Lint the codebase and run auto-fixers if supported by the linter GOLANGCI_LINT_EXTRA_ARGS="--fast=false --fix" $(MAKE) lint-go @@ -340,10 +346,10 @@ APIDIFF_OLD_COMMIT ?= $(shell git rev-parse origin/main) apidiff: $(GO_APIDIFF) ## Check for API differences $(GO_APIDIFF) $(APIDIFF_OLD_COMMIT) --print-compatible -ALL_VERIFY_CHECKS = boilerplate modules gen conversions +ALL_VERIFY_CHECKS = boilerplate shellcheck modules gen conversions doctoc flavors .PHONY: verify -verify: $(addprefix verify-,$(ALL_VERIFY_CHECKS)) lint-markdown lint-shell ## Run all verify-* targets +verify: $(addprefix verify-,$(ALL_VERIFY_CHECKS)) lint-markdown ## Run all verify-* targets .PHONY: verify-modules verify-modules: generate-modules ## Verify go modules are up to date @@ -367,14 +373,46 @@ verify-gen: generate ## Verify go generated files are up to date verify-conversions: $(CONVERSION_VERIFIER) ## Verifies expected API conversion are in place $(CONVERSION_VERIFIER) +.PHONY: verify-doctoc +verify-doctoc: generate-doctoc + @if !(git diff --quiet HEAD); then \ + git diff; \ + echo "doctoc is out of date, run make generate-doctoc"; exit 1; \ + fi + .PHONY: verify-boilerplate verify-boilerplate: ## Verify boilerplate text exists in each file TRACE=$(TRACE) ./hack/verify-boilerplate.sh +.PHONY: verify-shellcheck +verify-shellcheck: ## Verify shell files + TRACE=$(TRACE) ./hack/verify-shellcheck.sh $(SHELLCHECK_VER) + .PHONY: verify-container-images verify-container-images: ## Verify container images TRACE=$(TRACE) ./hack/verify-container-images.sh +.PHONY: verify-govulncheck +verify-govulncheck: $(GOVULNCHECK) ## Verify code for vulnerabilities + $(GOVULNCHECK) ./... + +.PHONY: verify-security +verify-security: ## Verify code and images for vulnerabilities + $(MAKE) verify-container-images && R1=$$? || R1=$$?; \ + $(MAKE) verify-govulncheck && R2=$$? || R2=$$?; \ + if [ "$$R1" -ne "0" ] || [ "$$R2" -ne "0" ]; then \ + echo "Check for vulnerabilities failed! There are vulnerabilities to be fixed"; \ + exit 1; \ + fi + +.PHONY: verify-flavors +verify-flavors: $(FLAVOR_DIR) generate-flavors ## Verify generated flavors + @if !(git diff --quiet HEAD -- $(FLAVOR_DIR)); then \ + git diff $(FLAVOR_DIR); \ + echo "flavor files in templates directory are out of date"; exit 1; \ + fi + + ## -------------------------------------- ## Build ## -------------------------------------- @@ -722,6 +760,9 @@ $(GINKGO_BIN): $(GINKGO) ## Build a local copy of ginkgo. .PHONY: $(GOLANGCI_LINT_BIN) $(GOLANGCI_LINT_BIN): $(GOLANGCI_LINT) ## Build a local copy of golangci-lint. +.PHONY: $(GOVULNCHECK_BIN) +$(GOVULNCHECK_BIN): $(GOVULNCHECK) ## Build a local copy of govulncheck. + .PHONY: $(GOVC_BIN) $(GOVC_BIN): $(GOVC) ## Build a local copy of govc. @@ -771,6 +812,9 @@ $(GINKGO): # Build ginkgo. $(GOLANGCI_LINT): # Build golangci-lint. GOBIN=$(TOOLS_BIN_DIR) $(GO_INSTALL) $(GOLANGCI_LINT_PKG) $(GOLANGCI_LINT_BIN) $(GOLANGCI_LINT_VER) +$(GOVULNCHECK): # Build govulncheck. + GOBIN=$(TOOLS_BIN_DIR) $(GO_INSTALL) $(GOVULNCHECK_PKG) $(GOVULNCHECK_BIN) $(GOVULNCHECK_VER) + $(GOVC): # Build GOVC. CGO_ENABLED=0 GOBIN=$(TOOLS_BIN_DIR) $(GO_INSTALL) $(GOVC_PKG) $(GOVC_BIN) $(GOVC_VER) diff --git a/contrib/haproxy/openapi/docs/ACLApi.md b/contrib/haproxy/openapi/docs/ACLApi.md deleted file mode 100644 index 5da690bfb9..0000000000 --- a/contrib/haproxy/openapi/docs/ACLApi.md +++ /dev/null @@ -1,264 +0,0 @@ -# \ACLApi - -All URIs are relative to *http://localhost/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**CreateAcl**](ACLApi.md#CreateAcl) | **Post** /services/haproxy/configuration/acls | Add a new ACL line -[**DeleteAcl**](ACLApi.md#DeleteAcl) | **Delete** /services/haproxy/configuration/acls/{id} | Delete a ACL line -[**GetAcl**](ACLApi.md#GetAcl) | **Get** /services/haproxy/configuration/acls/{id} | Return one ACL line -[**GetAcls**](ACLApi.md#GetAcls) | **Get** /services/haproxy/configuration/acls | Return an array of all ACL lines -[**ReplaceAcl**](ACLApi.md#ReplaceAcl) | **Put** /services/haproxy/configuration/acls/{id} | Replace a ACL line - - - -## CreateAcl - -> Acl CreateAcl(ctx, parentName, parentType, acl, optional) - -Add a new ACL line - -Adds a new ACL line of the specified type in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | -**acl** | [**Acl**](Acl.md)| | - **optional** | ***CreateAclOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a CreateAclOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**Acl**](acl.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DeleteAcl - -> DeleteAcl(ctx, id, parentName, parentType, optional) - -Delete a ACL line - -Deletes a ACL line configuration by it's ID from the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| ACL line ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***DeleteAclOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a DeleteAclOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - - (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetAcl - -> InlineResponse20031 GetAcl(ctx, id, parentName, parentType, optional) - -Return one ACL line - -Returns one ACL line configuration by it's ID in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| ACL line ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***GetAclOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetAclOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20031**](inline_response_200_31.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetAcls - -> InlineResponse20030 GetAcls(ctx, parentName, parentType, optional) - -Return an array of all ACL lines - -Returns all ACL lines that are configured in specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***GetAclsOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetAclsOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20030**](inline_response_200_30.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceAcl - -> Acl ReplaceAcl(ctx, id, parentName, parentType, acl, optional) - -Replace a ACL line - -Replaces a ACL line configuration by it's ID in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| ACL line ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | -**acl** | [**Acl**](Acl.md)| | - **optional** | ***ReplaceAclOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceAclOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**Acl**](acl.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - diff --git a/contrib/haproxy/openapi/docs/Acl.md b/contrib/haproxy/openapi/docs/Acl.md deleted file mode 100644 index 75e57e0dac..0000000000 --- a/contrib/haproxy/openapi/docs/Acl.md +++ /dev/null @@ -1,14 +0,0 @@ -# Acl - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AclName** | **string** | | -**Criterion** | **string** | | -**Id** | Pointer to **int32** | | -**Value** | **string** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/Backend.md b/contrib/haproxy/openapi/docs/Backend.md deleted file mode 100644 index b78f0a4289..0000000000 --- a/contrib/haproxy/openapi/docs/Backend.md +++ /dev/null @@ -1,35 +0,0 @@ -# Backend - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AdvCheck** | **string** | | [optional] -**Balance** | [**Balance**](balance.md) | | [optional] -**CheckTimeout** | Pointer to **int32** | | [optional] -**ConnectTimeout** | Pointer to **int32** | | [optional] -**Cookie** | **string** | | [optional] -**DefaultServer** | [**DefaultServer**](default_server.md) | | [optional] -**ExternalCheck** | **string** | | [optional] -**ExternalCheckCommand** | **string** | | [optional] -**ExternalCheckPath** | **string** | | [optional] -**Forwardfor** | [**Forwardfor**](forwardfor.md) | | [optional] -**HashType** | [**BackendHashType**](backend_hash_type.md) | | [optional] -**HttpUseHtx** | **string** | | [optional] -**HttpConnectionMode** | **string** | | [optional] -**HttpKeepAliveTimeout** | Pointer to **int32** | | [optional] -**HttpPretendKeepalive** | **string** | | [optional] -**HttpRequestTimeout** | Pointer to **int32** | | [optional] -**Httpchk** | [**Httpchk**](httpchk.md) | | [optional] -**LogTag** | **string** | | [optional] -**Mode** | **string** | | [optional] -**Name** | **string** | | -**QueueTimeout** | Pointer to **int32** | | [optional] -**Redispatch** | [**Redispatch**](redispatch.md) | | [optional] -**Retries** | Pointer to **int32** | | [optional] -**ServerTimeout** | Pointer to **int32** | | [optional] -**StickTable** | [**BackendStickTable**](backend_stick_table.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/BackendApi.md b/contrib/haproxy/openapi/docs/BackendApi.md deleted file mode 100644 index 38d34aa3ba..0000000000 --- a/contrib/haproxy/openapi/docs/BackendApi.md +++ /dev/null @@ -1,244 +0,0 @@ -# \BackendApi - -All URIs are relative to *http://localhost/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**CreateBackend**](BackendApi.md#CreateBackend) | **Post** /services/haproxy/configuration/backends | Add a backend -[**DeleteBackend**](BackendApi.md#DeleteBackend) | **Delete** /services/haproxy/configuration/backends/{name} | Delete a backend -[**GetBackend**](BackendApi.md#GetBackend) | **Get** /services/haproxy/configuration/backends/{name} | Return a backend -[**GetBackends**](BackendApi.md#GetBackends) | **Get** /services/haproxy/configuration/backends | Return an array of backends -[**ReplaceBackend**](BackendApi.md#ReplaceBackend) | **Put** /services/haproxy/configuration/backends/{name} | Replace a backend - - - -## CreateBackend - -> Backend CreateBackend(ctx, backend, optional) - -Add a backend - -Adds a new backend to the configuration file. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**backend** | [**Backend**](Backend.md)| | - **optional** | ***CreateBackendOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a CreateBackendOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**Backend**](backend.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DeleteBackend - -> DeleteBackend(ctx, name, optional) - -Delete a backend - -Deletes a frontend from the configuration by it's name. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**name** | **string**| Backend name | - **optional** | ***DeleteBackendOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a DeleteBackendOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - - (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetBackend - -> InlineResponse2007 GetBackend(ctx, name, optional) - -Return a backend - -Returns one backend configuration by it's name. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**name** | **string**| Backend name | - **optional** | ***GetBackendOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetBackendOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse2007**](inline_response_200_7.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetBackends - -> InlineResponse2006 GetBackends(ctx, optional) - -Return an array of backends - -Returns an array of all configured backends. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. - **optional** | ***GetBackendsOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetBackendsOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse2006**](inline_response_200_6.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceBackend - -> Backend ReplaceBackend(ctx, name, backend, optional) - -Replace a backend - -Replaces a backend configuration by it's name. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**name** | **string**| Backend name | -**backend** | [**Backend**](Backend.md)| | - **optional** | ***ReplaceBackendOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceBackendOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**Backend**](backend.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - diff --git a/contrib/haproxy/openapi/docs/BackendHashType.md b/contrib/haproxy/openapi/docs/BackendHashType.md deleted file mode 100644 index 429753f267..0000000000 --- a/contrib/haproxy/openapi/docs/BackendHashType.md +++ /dev/null @@ -1,13 +0,0 @@ -# BackendHashType - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Function** | **string** | | [optional] -**Method** | **string** | | [optional] -**Modifier** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/BackendOptionsApi.md b/contrib/haproxy/openapi/docs/BackendOptionsApi.md deleted file mode 100644 index 48f7fa33b0..0000000000 --- a/contrib/haproxy/openapi/docs/BackendOptionsApi.md +++ /dev/null @@ -1,2528 +0,0 @@ -# \BackendOptionsApi - -All URIs are relative to *http://localhost/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**CreateAcl**](BackendOptionsApi.md#CreateAcl) | **Post** /services/haproxy/configuration/acls | Add a new ACL line -[**CreateFilter**](BackendOptionsApi.md#CreateFilter) | **Post** /services/haproxy/configuration/filters | Add a new Filter -[**CreateHTTPRequestRule**](BackendOptionsApi.md#CreateHTTPRequestRule) | **Post** /services/haproxy/configuration/http_request_rules | Add a new HTTP Request Rule -[**CreateHTTPResponseRule**](BackendOptionsApi.md#CreateHTTPResponseRule) | **Post** /services/haproxy/configuration/http_response_rules | Add a new HTTP Response Rule -[**CreateLogTarget**](BackendOptionsApi.md#CreateLogTarget) | **Post** /services/haproxy/configuration/log_targets | Add a new Log Target -[**CreateServer**](BackendOptionsApi.md#CreateServer) | **Post** /services/haproxy/configuration/servers | Add a new server -[**CreateServerSwitchingRule**](BackendOptionsApi.md#CreateServerSwitchingRule) | **Post** /services/haproxy/configuration/server_switching_rules | Add a new Server Switching Rule -[**CreateStickRule**](BackendOptionsApi.md#CreateStickRule) | **Post** /services/haproxy/configuration/stick_rules | Add a new Stick Rule -[**CreateTCPRequestRule**](BackendOptionsApi.md#CreateTCPRequestRule) | **Post** /services/haproxy/configuration/tcp_request_rules | Add a new TCP Request Rule -[**CreateTCPResponseRule**](BackendOptionsApi.md#CreateTCPResponseRule) | **Post** /services/haproxy/configuration/tcp_response_rules | Add a new TCP Response Rule -[**DeleteAcl**](BackendOptionsApi.md#DeleteAcl) | **Delete** /services/haproxy/configuration/acls/{id} | Delete a ACL line -[**DeleteFilter**](BackendOptionsApi.md#DeleteFilter) | **Delete** /services/haproxy/configuration/filters/{id} | Delete a Filter -[**DeleteHTTPRequestRule**](BackendOptionsApi.md#DeleteHTTPRequestRule) | **Delete** /services/haproxy/configuration/http_request_rules/{id} | Delete a HTTP Request Rule -[**DeleteHTTPResponseRule**](BackendOptionsApi.md#DeleteHTTPResponseRule) | **Delete** /services/haproxy/configuration/http_response_rules/{id} | Delete a HTTP Response Rule -[**DeleteLogTarget**](BackendOptionsApi.md#DeleteLogTarget) | **Delete** /services/haproxy/configuration/log_targets/{id} | Delete a Log Target -[**DeleteServer**](BackendOptionsApi.md#DeleteServer) | **Delete** /services/haproxy/configuration/servers/{name} | Delete a server -[**DeleteServerSwitchingRule**](BackendOptionsApi.md#DeleteServerSwitchingRule) | **Delete** /services/haproxy/configuration/server_switching_rules/{id} | Delete a Server Switching Rule -[**DeleteStickRule**](BackendOptionsApi.md#DeleteStickRule) | **Delete** /services/haproxy/configuration/stick_rules/{id} | Delete a Stick Rule -[**DeleteTCPRequestRule**](BackendOptionsApi.md#DeleteTCPRequestRule) | **Delete** /services/haproxy/configuration/tcp_request_rules/{id} | Delete a TCP Request Rule -[**DeleteTCPResponseRule**](BackendOptionsApi.md#DeleteTCPResponseRule) | **Delete** /services/haproxy/configuration/tcp_response_rules/{id} | Delete a TCP Response Rule -[**GetAcl**](BackendOptionsApi.md#GetAcl) | **Get** /services/haproxy/configuration/acls/{id} | Return one ACL line -[**GetAcls**](BackendOptionsApi.md#GetAcls) | **Get** /services/haproxy/configuration/acls | Return an array of all ACL lines -[**GetFilter**](BackendOptionsApi.md#GetFilter) | **Get** /services/haproxy/configuration/filters/{id} | Return one Filter -[**GetFilters**](BackendOptionsApi.md#GetFilters) | **Get** /services/haproxy/configuration/filters | Return an array of all Filters -[**GetHTTPRequestRule**](BackendOptionsApi.md#GetHTTPRequestRule) | **Get** /services/haproxy/configuration/http_request_rules/{id} | Return one HTTP Request Rule -[**GetHTTPRequestRules**](BackendOptionsApi.md#GetHTTPRequestRules) | **Get** /services/haproxy/configuration/http_request_rules | Return an array of all HTTP Request Rules -[**GetHTTPResponseRule**](BackendOptionsApi.md#GetHTTPResponseRule) | **Get** /services/haproxy/configuration/http_response_rules/{id} | Return one HTTP Response Rule -[**GetHTTPResponseRules**](BackendOptionsApi.md#GetHTTPResponseRules) | **Get** /services/haproxy/configuration/http_response_rules | Return an array of all HTTP Response Rules -[**GetLogTarget**](BackendOptionsApi.md#GetLogTarget) | **Get** /services/haproxy/configuration/log_targets/{id} | Return one Log Target -[**GetLogTargets**](BackendOptionsApi.md#GetLogTargets) | **Get** /services/haproxy/configuration/log_targets | Return an array of all Log Targets -[**GetServer**](BackendOptionsApi.md#GetServer) | **Get** /services/haproxy/configuration/servers/{name} | Return one server -[**GetServerSwitchingRule**](BackendOptionsApi.md#GetServerSwitchingRule) | **Get** /services/haproxy/configuration/server_switching_rules/{id} | Return one Server Switching Rule -[**GetServerSwitchingRules**](BackendOptionsApi.md#GetServerSwitchingRules) | **Get** /services/haproxy/configuration/server_switching_rules | Return an array of all Server Switching Rules -[**GetServers**](BackendOptionsApi.md#GetServers) | **Get** /services/haproxy/configuration/servers | Return an array of servers -[**GetStickRule**](BackendOptionsApi.md#GetStickRule) | **Get** /services/haproxy/configuration/stick_rules/{id} | Return one Stick Rule -[**GetStickRules**](BackendOptionsApi.md#GetStickRules) | **Get** /services/haproxy/configuration/stick_rules | Return an array of all Stick Rules -[**GetTCPRequestRule**](BackendOptionsApi.md#GetTCPRequestRule) | **Get** /services/haproxy/configuration/tcp_request_rules/{id} | Return one TCP Request Rule -[**GetTCPRequestRules**](BackendOptionsApi.md#GetTCPRequestRules) | **Get** /services/haproxy/configuration/tcp_request_rules | Return an array of all TCP Request Rules -[**GetTCPResponseRule**](BackendOptionsApi.md#GetTCPResponseRule) | **Get** /services/haproxy/configuration/tcp_response_rules/{id} | Return one TCP Response Rule -[**GetTCPResponseRules**](BackendOptionsApi.md#GetTCPResponseRules) | **Get** /services/haproxy/configuration/tcp_response_rules | Return an array of all TCP Response Rules -[**ReplaceAcl**](BackendOptionsApi.md#ReplaceAcl) | **Put** /services/haproxy/configuration/acls/{id} | Replace a ACL line -[**ReplaceFilter**](BackendOptionsApi.md#ReplaceFilter) | **Put** /services/haproxy/configuration/filters/{id} | Replace a Filter -[**ReplaceHTTPRequestRule**](BackendOptionsApi.md#ReplaceHTTPRequestRule) | **Put** /services/haproxy/configuration/http_request_rules/{id} | Replace a HTTP Request Rule -[**ReplaceHTTPResponseRule**](BackendOptionsApi.md#ReplaceHTTPResponseRule) | **Put** /services/haproxy/configuration/http_response_rules/{id} | Replace a HTTP Response Rule -[**ReplaceLogTarget**](BackendOptionsApi.md#ReplaceLogTarget) | **Put** /services/haproxy/configuration/log_targets/{id} | Replace a Log Target -[**ReplaceServer**](BackendOptionsApi.md#ReplaceServer) | **Put** /services/haproxy/configuration/servers/{name} | Replace a server -[**ReplaceServerSwitchingRule**](BackendOptionsApi.md#ReplaceServerSwitchingRule) | **Put** /services/haproxy/configuration/server_switching_rules/{id} | Replace a Server Switching Rule -[**ReplaceStickRule**](BackendOptionsApi.md#ReplaceStickRule) | **Put** /services/haproxy/configuration/stick_rules/{id} | Replace a Stick Rule -[**ReplaceTCPRequestRule**](BackendOptionsApi.md#ReplaceTCPRequestRule) | **Put** /services/haproxy/configuration/tcp_request_rules/{id} | Replace a TCP Request Rule -[**ReplaceTCPResponseRule**](BackendOptionsApi.md#ReplaceTCPResponseRule) | **Put** /services/haproxy/configuration/tcp_response_rules/{id} | Replace a TCP Response Rule - - - -## CreateAcl - -> Acl CreateAcl(ctx, parentName, parentType, acl, optional) - -Add a new ACL line - -Adds a new ACL line of the specified type in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | -**acl** | [**Acl**](Acl.md)| | - **optional** | ***CreateAclOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a CreateAclOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**Acl**](acl.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## CreateFilter - -> Filter CreateFilter(ctx, parentName, parentType, filter, optional) - -Add a new Filter - -Adds a new Filter of the specified type in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | -**filter** | [**Filter**](Filter.md)| | - **optional** | ***CreateFilterOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a CreateFilterOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**Filter**](filter.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## CreateHTTPRequestRule - -> HttpRequestRule CreateHTTPRequestRule(ctx, parentName, parentType, httpRequestRule, optional) - -Add a new HTTP Request Rule - -Adds a new HTTP Request Rule of the specified type in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | -**httpRequestRule** | [**HttpRequestRule**](HttpRequestRule.md)| | - **optional** | ***CreateHTTPRequestRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a CreateHTTPRequestRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**HttpRequestRule**](http_request_rule.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## CreateHTTPResponseRule - -> HttpResponseRule CreateHTTPResponseRule(ctx, parentName, parentType, httpResponseRule, optional) - -Add a new HTTP Response Rule - -Adds a new HTTP Response Rule of the specified type in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | -**httpResponseRule** | [**HttpResponseRule**](HttpResponseRule.md)| | - **optional** | ***CreateHTTPResponseRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a CreateHTTPResponseRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**HttpResponseRule**](http_response_rule.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## CreateLogTarget - -> LogTarget CreateLogTarget(ctx, parentName, parentType, logTarget, optional) - -Add a new Log Target - -Adds a new Log Target of the specified type in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | -**logTarget** | [**LogTarget**](LogTarget.md)| | - **optional** | ***CreateLogTargetOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a CreateLogTargetOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**LogTarget**](log_target.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## CreateServer - -> Server CreateServer(ctx, backend, server, optional) - -Add a new server - -Adds a new server in the specified backend in the configuration file. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**backend** | **string**| Parent backend name | -**server** | [**Server**](Server.md)| | - **optional** | ***CreateServerOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a CreateServerOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**Server**](server.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## CreateServerSwitchingRule - -> ServerSwitchingRule CreateServerSwitchingRule(ctx, backend, serverSwitchingRule, optional) - -Add a new Server Switching Rule - -Adds a new Server Switching Rule of the specified type in the specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**backend** | **string**| Backend name | -**serverSwitchingRule** | [**ServerSwitchingRule**](ServerSwitchingRule.md)| | - **optional** | ***CreateServerSwitchingRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a CreateServerSwitchingRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**ServerSwitchingRule**](server_switching_rule.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## CreateStickRule - -> StickRule CreateStickRule(ctx, backend, stickRule, optional) - -Add a new Stick Rule - -Adds a new Stick Rule of the specified type in the specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**backend** | **string**| Backend name | -**stickRule** | [**StickRule**](StickRule.md)| | - **optional** | ***CreateStickRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a CreateStickRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**StickRule**](stick_rule.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## CreateTCPRequestRule - -> TcpRequestRule CreateTCPRequestRule(ctx, parentName, parentType, tcpRequestRule, optional) - -Add a new TCP Request Rule - -Adds a new TCP Request Rule of the specified type in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | -**tcpRequestRule** | [**TcpRequestRule**](TcpRequestRule.md)| | - **optional** | ***CreateTCPRequestRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a CreateTCPRequestRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**TcpRequestRule**](tcp_request_rule.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## CreateTCPResponseRule - -> TcpResponseRule CreateTCPResponseRule(ctx, backend, tcpResponseRule, optional) - -Add a new TCP Response Rule - -Adds a new TCP Response Rule of the specified type in the specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**backend** | **string**| Parent backend name | -**tcpResponseRule** | [**TcpResponseRule**](TcpResponseRule.md)| | - **optional** | ***CreateTCPResponseRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a CreateTCPResponseRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**TcpResponseRule**](tcp_response_rule.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DeleteAcl - -> DeleteAcl(ctx, id, parentName, parentType, optional) - -Delete a ACL line - -Deletes a ACL line configuration by it's ID from the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| ACL line ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***DeleteAclOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a DeleteAclOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - - (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DeleteFilter - -> DeleteFilter(ctx, id, parentName, parentType, optional) - -Delete a Filter - -Deletes a Filter configuration by it's ID from the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Filter ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***DeleteFilterOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a DeleteFilterOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - - (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DeleteHTTPRequestRule - -> DeleteHTTPRequestRule(ctx, id, parentName, parentType, optional) - -Delete a HTTP Request Rule - -Deletes a HTTP Request Rule configuration by it's ID from the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| HTTP Request Rule ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***DeleteHTTPRequestRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a DeleteHTTPRequestRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - - (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DeleteHTTPResponseRule - -> DeleteHTTPResponseRule(ctx, id, parentName, parentType, optional) - -Delete a HTTP Response Rule - -Deletes a HTTP Response Rule configuration by it's ID from the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| HTTP Response Rule ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***DeleteHTTPResponseRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a DeleteHTTPResponseRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - - (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DeleteLogTarget - -> DeleteLogTarget(ctx, id, parentName, parentType, optional) - -Delete a Log Target - -Deletes a Log Target configuration by it's ID from the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Log Target ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***DeleteLogTargetOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a DeleteLogTargetOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - - (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DeleteServer - -> DeleteServer(ctx, name, backend, optional) - -Delete a server - -Deletes a server configuration by it's name in the specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**name** | **string**| Server name | -**backend** | **string**| Parent backend name | - **optional** | ***DeleteServerOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a DeleteServerOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - - (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DeleteServerSwitchingRule - -> DeleteServerSwitchingRule(ctx, id, backend, optional) - -Delete a Server Switching Rule - -Deletes a Server Switching Rule configuration by it's ID from the specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Switching Rule ID | -**backend** | **string**| Backend name | - **optional** | ***DeleteServerSwitchingRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a DeleteServerSwitchingRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - - (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DeleteStickRule - -> DeleteStickRule(ctx, id, backend, optional) - -Delete a Stick Rule - -Deletes a Stick Rule configuration by it's ID from the specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Stick Rule ID | -**backend** | **string**| Backend name | - **optional** | ***DeleteStickRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a DeleteStickRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - - (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DeleteTCPRequestRule - -> DeleteTCPRequestRule(ctx, id, parentName, parentType, optional) - -Delete a TCP Request Rule - -Deletes a TCP Request Rule configuration by it's ID from the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| TCP Request Rule ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***DeleteTCPRequestRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a DeleteTCPRequestRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - - (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DeleteTCPResponseRule - -> DeleteTCPResponseRule(ctx, id, backend, optional) - -Delete a TCP Response Rule - -Deletes a TCP Response Rule configuration by it's ID from the specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| TCP Response Rule ID | -**backend** | **string**| Parent backend name | - **optional** | ***DeleteTCPResponseRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a DeleteTCPResponseRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - - (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetAcl - -> InlineResponse20031 GetAcl(ctx, id, parentName, parentType, optional) - -Return one ACL line - -Returns one ACL line configuration by it's ID in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| ACL line ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***GetAclOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetAclOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20031**](inline_response_200_31.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetAcls - -> InlineResponse20030 GetAcls(ctx, parentName, parentType, optional) - -Return an array of all ACL lines - -Returns all ACL lines that are configured in specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***GetAclsOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetAclsOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20030**](inline_response_200_30.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetFilter - -> InlineResponse20025 GetFilter(ctx, id, parentName, parentType, optional) - -Return one Filter - -Returns one Filter configuration by it's ID in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Filter ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***GetFilterOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetFilterOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20025**](inline_response_200_25.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetFilters - -> InlineResponse20024 GetFilters(ctx, parentName, parentType, optional) - -Return an array of all Filters - -Returns all Filters that are configured in specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***GetFiltersOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetFiltersOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20024**](inline_response_200_24.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetHTTPRequestRule - -> InlineResponse20013 GetHTTPRequestRule(ctx, id, parentName, parentType, optional) - -Return one HTTP Request Rule - -Returns one HTTP Request Rule configuration by it's ID in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| HTTP Request Rule ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***GetHTTPRequestRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetHTTPRequestRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20013**](inline_response_200_13.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetHTTPRequestRules - -> InlineResponse20012 GetHTTPRequestRules(ctx, parentName, parentType, optional) - -Return an array of all HTTP Request Rules - -Returns all HTTP Request Rules that are configured in specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***GetHTTPRequestRulesOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetHTTPRequestRulesOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20012**](inline_response_200_12.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetHTTPResponseRule - -> InlineResponse20015 GetHTTPResponseRule(ctx, id, parentName, parentType, optional) - -Return one HTTP Response Rule - -Returns one HTTP Response Rule configuration by it's ID in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| HTTP Response Rule ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***GetHTTPResponseRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetHTTPResponseRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20015**](inline_response_200_15.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetHTTPResponseRules - -> InlineResponse20014 GetHTTPResponseRules(ctx, parentName, parentType, optional) - -Return an array of all HTTP Response Rules - -Returns all HTTP Response Rules that are configured in specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***GetHTTPResponseRulesOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetHTTPResponseRulesOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20014**](inline_response_200_14.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetLogTarget - -> InlineResponse20029 GetLogTarget(ctx, id, parentName, parentType, optional) - -Return one Log Target - -Returns one Log Target configuration by it's ID in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Log Target ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***GetLogTargetOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetLogTargetOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20029**](inline_response_200_29.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetLogTargets - -> InlineResponse20028 GetLogTargets(ctx, parentName, parentType, optional) - -Return an array of all Log Targets - -Returns all Log Targets that are configured in specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***GetLogTargetsOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetLogTargetsOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20028**](inline_response_200_28.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetServer - -> InlineResponse20011 GetServer(ctx, name, backend, optional) - -Return one server - -Returns one server configuration by it's name in the specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**name** | **string**| Server name | -**backend** | **string**| Parent backend name | - **optional** | ***GetServerOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetServerOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20011**](inline_response_200_11.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetServerSwitchingRule - -> InlineResponse20023 GetServerSwitchingRule(ctx, id, backend, optional) - -Return one Server Switching Rule - -Returns one Server Switching Rule configuration by it's ID in the specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Switching Rule ID | -**backend** | **string**| Backend name | - **optional** | ***GetServerSwitchingRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetServerSwitchingRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20023**](inline_response_200_23.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetServerSwitchingRules - -> InlineResponse20022 GetServerSwitchingRules(ctx, backend, optional) - -Return an array of all Server Switching Rules - -Returns all Backend Switching Rules that are configured in specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**backend** | **string**| Backend name | - **optional** | ***GetServerSwitchingRulesOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetServerSwitchingRulesOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20022**](inline_response_200_22.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetServers - -> InlineResponse20010 GetServers(ctx, backend, optional) - -Return an array of servers - -Returns an array of all servers that are configured in specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**backend** | **string**| Parent backend name | - **optional** | ***GetServersOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetServersOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20010**](inline_response_200_10.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetStickRule - -> InlineResponse20027 GetStickRule(ctx, id, backend, optional) - -Return one Stick Rule - -Returns one Stick Rule configuration by it's ID in the specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Stick Rule ID | -**backend** | **string**| Backend name | - **optional** | ***GetStickRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetStickRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20027**](inline_response_200_27.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetStickRules - -> InlineResponse20026 GetStickRules(ctx, backend, optional) - -Return an array of all Stick Rules - -Returns all Stick Rules that are configured in specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**backend** | **string**| Backend name | - **optional** | ***GetStickRulesOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetStickRulesOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20026**](inline_response_200_26.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetTCPRequestRule - -> InlineResponse20017 GetTCPRequestRule(ctx, id, parentName, parentType, optional) - -Return one TCP Request Rule - -Returns one TCP Request Rule configuration by it's ID in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| TCP Request Rule ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***GetTCPRequestRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetTCPRequestRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20017**](inline_response_200_17.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetTCPRequestRules - -> InlineResponse20016 GetTCPRequestRules(ctx, parentName, parentType, optional) - -Return an array of all TCP Request Rules - -Returns all TCP Request Rules that are configured in specified parent and parent type. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***GetTCPRequestRulesOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetTCPRequestRulesOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20016**](inline_response_200_16.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetTCPResponseRule - -> InlineResponse20019 GetTCPResponseRule(ctx, id, backend, optional) - -Return one TCP Response Rule - -Returns one TCP Response Rule configuration by it's ID in the specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| TCP Response Rule ID | -**backend** | **string**| Parent backend name | - **optional** | ***GetTCPResponseRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetTCPResponseRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20019**](inline_response_200_19.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetTCPResponseRules - -> InlineResponse20018 GetTCPResponseRules(ctx, backend, optional) - -Return an array of all TCP Response Rules - -Returns all TCP Response Rules that are configured in specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**backend** | **string**| Parent backend name | - **optional** | ***GetTCPResponseRulesOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetTCPResponseRulesOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20018**](inline_response_200_18.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceAcl - -> Acl ReplaceAcl(ctx, id, parentName, parentType, acl, optional) - -Replace a ACL line - -Replaces a ACL line configuration by it's ID in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| ACL line ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | -**acl** | [**Acl**](Acl.md)| | - **optional** | ***ReplaceAclOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceAclOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**Acl**](acl.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceFilter - -> Filter ReplaceFilter(ctx, id, parentName, parentType, filter, optional) - -Replace a Filter - -Replaces a Filter configuration by it's ID in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Filter ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | -**filter** | [**Filter**](Filter.md)| | - **optional** | ***ReplaceFilterOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceFilterOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**Filter**](filter.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceHTTPRequestRule - -> HttpRequestRule ReplaceHTTPRequestRule(ctx, id, parentName, parentType, httpRequestRule, optional) - -Replace a HTTP Request Rule - -Replaces a HTTP Request Rule configuration by it's ID in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| HTTP Request Rule ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | -**httpRequestRule** | [**HttpRequestRule**](HttpRequestRule.md)| | - **optional** | ***ReplaceHTTPRequestRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceHTTPRequestRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**HttpRequestRule**](http_request_rule.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceHTTPResponseRule - -> HttpResponseRule ReplaceHTTPResponseRule(ctx, id, parentName, parentType, httpResponseRule, optional) - -Replace a HTTP Response Rule - -Replaces a HTTP Response Rule configuration by it's ID in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| HTTP Response Rule ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | -**httpResponseRule** | [**HttpResponseRule**](HttpResponseRule.md)| | - **optional** | ***ReplaceHTTPResponseRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceHTTPResponseRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**HttpResponseRule**](http_response_rule.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceLogTarget - -> LogTarget ReplaceLogTarget(ctx, id, parentName, parentType, logTarget, optional) - -Replace a Log Target - -Replaces a Log Target configuration by it's ID in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Log Target ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | -**logTarget** | [**LogTarget**](LogTarget.md)| | - **optional** | ***ReplaceLogTargetOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceLogTargetOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**LogTarget**](log_target.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceServer - -> Server ReplaceServer(ctx, name, backend, server, optional) - -Replace a server - -Replaces a server configuration by it's name in the specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**name** | **string**| Server name | -**backend** | **string**| Parent backend name | -**server** | [**Server**](Server.md)| | - **optional** | ***ReplaceServerOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceServerOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**Server**](server.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceServerSwitchingRule - -> ServerSwitchingRule ReplaceServerSwitchingRule(ctx, id, backend, serverSwitchingRule, optional) - -Replace a Server Switching Rule - -Replaces a Server Switching Rule configuration by it's ID in the specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Switching Rule ID | -**backend** | **string**| Backend name | -**serverSwitchingRule** | [**ServerSwitchingRule**](ServerSwitchingRule.md)| | - **optional** | ***ReplaceServerSwitchingRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceServerSwitchingRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**ServerSwitchingRule**](server_switching_rule.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceStickRule - -> StickRule ReplaceStickRule(ctx, id, backend, stickRule, optional) - -Replace a Stick Rule - -Replaces a Stick Rule configuration by it's ID in the specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Stick Rule ID | -**backend** | **string**| Backend name | -**stickRule** | [**StickRule**](StickRule.md)| | - **optional** | ***ReplaceStickRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceStickRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**StickRule**](stick_rule.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceTCPRequestRule - -> TcpRequestRule ReplaceTCPRequestRule(ctx, id, parentName, parentType, tcpRequestRule, optional) - -Replace a TCP Request Rule - -Replaces a TCP Request Rule configuration by it's ID in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| TCP Request Rule ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | -**tcpRequestRule** | [**TcpRequestRule**](TcpRequestRule.md)| | - **optional** | ***ReplaceTCPRequestRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceTCPRequestRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**TcpRequestRule**](tcp_request_rule.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceTCPResponseRule - -> TcpResponseRule ReplaceTCPResponseRule(ctx, id, backend, tcpResponseRule, optional) - -Replace a TCP Response Rule - -Replaces a TCP Response Rule configuration by it's ID in the specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| TCP Response Rule ID | -**backend** | **string**| Parent backend name | -**tcpResponseRule** | [**TcpResponseRule**](TcpResponseRule.md)| | - **optional** | ***ReplaceTCPResponseRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceTCPResponseRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**TcpResponseRule**](tcp_response_rule.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - diff --git a/contrib/haproxy/openapi/docs/BackendStickTable.md b/contrib/haproxy/openapi/docs/BackendStickTable.md deleted file mode 100644 index a4e34f1b63..0000000000 --- a/contrib/haproxy/openapi/docs/BackendStickTable.md +++ /dev/null @@ -1,17 +0,0 @@ -# BackendStickTable - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Expire** | Pointer to **int32** | | [optional] -**Keylen** | Pointer to **int32** | | [optional] -**Nopurge** | **bool** | | [optional] -**Peers** | **string** | | [optional] -**Size** | Pointer to **int32** | | [optional] -**Store** | **string** | | [optional] -**Type** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/BackendSwitchingRule.md b/contrib/haproxy/openapi/docs/BackendSwitchingRule.md deleted file mode 100644 index 83f3d9593a..0000000000 --- a/contrib/haproxy/openapi/docs/BackendSwitchingRule.md +++ /dev/null @@ -1,14 +0,0 @@ -# BackendSwitchingRule - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Cond** | **string** | | [optional] -**CondTest** | **string** | | [optional] -**Id** | Pointer to **int32** | | -**Name** | **string** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/BackendSwitchingRuleApi.md b/contrib/haproxy/openapi/docs/BackendSwitchingRuleApi.md deleted file mode 100644 index 4cc5bf27ef..0000000000 --- a/contrib/haproxy/openapi/docs/BackendSwitchingRuleApi.md +++ /dev/null @@ -1,254 +0,0 @@ -# \BackendSwitchingRuleApi - -All URIs are relative to *http://localhost/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**CreateBackendSwitchingRule**](BackendSwitchingRuleApi.md#CreateBackendSwitchingRule) | **Post** /services/haproxy/configuration/backend_switching_rules | Add a new Backend Switching Rule -[**DeleteBackendSwitchingRule**](BackendSwitchingRuleApi.md#DeleteBackendSwitchingRule) | **Delete** /services/haproxy/configuration/backend_switching_rules/{id} | Delete a Backend Switching Rule -[**GetBackendSwitchingRule**](BackendSwitchingRuleApi.md#GetBackendSwitchingRule) | **Get** /services/haproxy/configuration/backend_switching_rules/{id} | Return one Backend Switching Rule -[**GetBackendSwitchingRules**](BackendSwitchingRuleApi.md#GetBackendSwitchingRules) | **Get** /services/haproxy/configuration/backend_switching_rules | Return an array of all Backend Switching Rules -[**ReplaceBackendSwitchingRule**](BackendSwitchingRuleApi.md#ReplaceBackendSwitchingRule) | **Put** /services/haproxy/configuration/backend_switching_rules/{id} | Replace a Backend Switching Rule - - - -## CreateBackendSwitchingRule - -> BackendSwitchingRule CreateBackendSwitchingRule(ctx, frontend, backendSwitchingRule, optional) - -Add a new Backend Switching Rule - -Adds a new Backend Switching Rule of the specified type in the specified frontend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**frontend** | **string**| Frontend name | -**backendSwitchingRule** | [**BackendSwitchingRule**](BackendSwitchingRule.md)| | - **optional** | ***CreateBackendSwitchingRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a CreateBackendSwitchingRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**BackendSwitchingRule**](backend_switching_rule.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DeleteBackendSwitchingRule - -> DeleteBackendSwitchingRule(ctx, id, frontend, optional) - -Delete a Backend Switching Rule - -Deletes a Backend Switching Rule configuration by it's ID from the specified frontend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Switching Rule ID | -**frontend** | **string**| Frontend name | - **optional** | ***DeleteBackendSwitchingRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a DeleteBackendSwitchingRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - - (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetBackendSwitchingRule - -> InlineResponse20021 GetBackendSwitchingRule(ctx, id, frontend, optional) - -Return one Backend Switching Rule - -Returns one Backend Switching Rule configuration by it's ID in the specified frontend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Switching Rule ID | -**frontend** | **string**| Frontend name | - **optional** | ***GetBackendSwitchingRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetBackendSwitchingRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20021**](inline_response_200_21.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetBackendSwitchingRules - -> InlineResponse20020 GetBackendSwitchingRules(ctx, frontend, optional) - -Return an array of all Backend Switching Rules - -Returns all Backend Switching Rules that are configured in specified frontend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**frontend** | **string**| Frontend name | - **optional** | ***GetBackendSwitchingRulesOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetBackendSwitchingRulesOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20020**](inline_response_200_20.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceBackendSwitchingRule - -> BackendSwitchingRule ReplaceBackendSwitchingRule(ctx, id, frontend, backendSwitchingRule, optional) - -Replace a Backend Switching Rule - -Replaces a Backend Switching Rule configuration by it's ID in the specified frontend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Switching Rule ID | -**frontend** | **string**| Frontend name | -**backendSwitchingRule** | [**BackendSwitchingRule**](BackendSwitchingRule.md)| | - **optional** | ***ReplaceBackendSwitchingRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceBackendSwitchingRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**BackendSwitchingRule**](backend_switching_rule.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - diff --git a/contrib/haproxy/openapi/docs/Balance.md b/contrib/haproxy/openapi/docs/Balance.md deleted file mode 100644 index 68011bb19a..0000000000 --- a/contrib/haproxy/openapi/docs/Balance.md +++ /dev/null @@ -1,12 +0,0 @@ -# Balance - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Algorithm** | **string** | | [optional] -**Arguments** | **[]string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/Bind.md b/contrib/haproxy/openapi/docs/Bind.md deleted file mode 100644 index f61a4317b5..0000000000 --- a/contrib/haproxy/openapi/docs/Bind.md +++ /dev/null @@ -1,23 +0,0 @@ -# Bind - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AcceptProxy** | **bool** | | [optional] -**Address** | **string** | | [optional] -**Alpn** | **string** | | [optional] -**Name** | **string** | | -**Port** | Pointer to **int32** | | [optional] -**Process** | **string** | | [optional] -**Ssl** | **bool** | | [optional] -**SslCafile** | **string** | | [optional] -**SslCertificate** | **string** | | [optional] -**TcpUserTimeout** | Pointer to **int32** | | [optional] -**Transparent** | **bool** | | [optional] -**V4v6** | **bool** | | [optional] -**Verify** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/BindApi.md b/contrib/haproxy/openapi/docs/BindApi.md deleted file mode 100644 index bf37f6969e..0000000000 --- a/contrib/haproxy/openapi/docs/BindApi.md +++ /dev/null @@ -1,254 +0,0 @@ -# \BindApi - -All URIs are relative to *http://localhost/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**CreateBind**](BindApi.md#CreateBind) | **Post** /services/haproxy/configuration/binds | Add a new bind -[**DeleteBind**](BindApi.md#DeleteBind) | **Delete** /services/haproxy/configuration/binds/{name} | Delete a bind -[**GetBind**](BindApi.md#GetBind) | **Get** /services/haproxy/configuration/binds/{name} | Return one bind -[**GetBinds**](BindApi.md#GetBinds) | **Get** /services/haproxy/configuration/binds | Return an array of binds -[**ReplaceBind**](BindApi.md#ReplaceBind) | **Put** /services/haproxy/configuration/binds/{name} | Replace a bind - - - -## CreateBind - -> Bind CreateBind(ctx, frontend, bind, optional) - -Add a new bind - -Adds a new bind in the specified frontend in the configuration file. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**frontend** | **string**| Parent frontend name | -**bind** | [**Bind**](Bind.md)| | - **optional** | ***CreateBindOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a CreateBindOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**Bind**](bind.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DeleteBind - -> DeleteBind(ctx, name, frontend, optional) - -Delete a bind - -Deletes a bind configuration by it's name in the specified frontend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**name** | **string**| Bind name | -**frontend** | **string**| Parent frontend name | - **optional** | ***DeleteBindOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a DeleteBindOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - - (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetBind - -> InlineResponse2009 GetBind(ctx, name, frontend, optional) - -Return one bind - -Returns one bind configuration by it's name in the specified frontend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**name** | **string**| Bind name | -**frontend** | **string**| Parent frontend name | - **optional** | ***GetBindOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetBindOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse2009**](inline_response_200_9.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetBinds - -> InlineResponse2008 GetBinds(ctx, frontend, optional) - -Return an array of binds - -Returns an array of all binds that are configured in specified frontend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**frontend** | **string**| Parent frontend name | - **optional** | ***GetBindsOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetBindsOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse2008**](inline_response_200_8.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceBind - -> Bind ReplaceBind(ctx, name, frontend, bind, optional) - -Replace a bind - -Replaces a bind configuration by it's name in the specified frontend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**name** | **string**| Bind name | -**frontend** | **string**| Parent frontend name | -**bind** | [**Bind**](Bind.md)| | - **optional** | ***ReplaceBindOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceBindOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**Bind**](bind.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - diff --git a/contrib/haproxy/openapi/docs/ConfigurationApi.md b/contrib/haproxy/openapi/docs/ConfigurationApi.md deleted file mode 100644 index 6041a3940a..0000000000 --- a/contrib/haproxy/openapi/docs/ConfigurationApi.md +++ /dev/null @@ -1,100 +0,0 @@ -# \ConfigurationApi - -All URIs are relative to *http://localhost/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**GetHAProxyConfiguration**](ConfigurationApi.md#GetHAProxyConfiguration) | **Get** /services/haproxy/configuration/raw | Return HAProxy configuration -[**PostHAProxyConfiguration**](ConfigurationApi.md#PostHAProxyConfiguration) | **Post** /services/haproxy/configuration/raw | Push new haproxy configuration - - - -## GetHAProxyConfiguration - -> InlineResponse20032 GetHAProxyConfiguration(ctx, optional) - -Return HAProxy configuration - -Returns HAProxy configuration file in plain text - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. - **optional** | ***GetHAProxyConfigurationOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetHAProxyConfigurationOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - -### Return type - -[**InlineResponse20032**](inline_response_200_32.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: text/plain, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## PostHAProxyConfiguration - -> string PostHAProxyConfiguration(ctx, body, optional) - -Push new haproxy configuration - -Push a new haproxy configuration file in plain text - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**body** | **string**| | - **optional** | ***PostHAProxyConfigurationOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a PostHAProxyConfigurationOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -**string** - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: text/plain -- **Accept**: text/plain, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - diff --git a/contrib/haproxy/openapi/docs/DefaultServer.md b/contrib/haproxy/openapi/docs/DefaultServer.md deleted file mode 100644 index e0d0c29dd4..0000000000 --- a/contrib/haproxy/openapi/docs/DefaultServer.md +++ /dev/null @@ -1,14 +0,0 @@ -# DefaultServer - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Fall** | Pointer to **int32** | | [optional] -**Inter** | Pointer to **int32** | | [optional] -**Port** | Pointer to **int32** | | [optional] -**Rise** | Pointer to **int32** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/Defaults.md b/contrib/haproxy/openapi/docs/Defaults.md deleted file mode 100644 index 81efab9a5b..0000000000 --- a/contrib/haproxy/openapi/docs/Defaults.md +++ /dev/null @@ -1,45 +0,0 @@ -# Defaults - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AdvCheck** | **string** | | [optional] -**Balance** | [**Balance**](balance.md) | | [optional] -**CheckTimeout** | Pointer to **int32** | | [optional] -**Clflog** | **bool** | | [optional] -**ClientTimeout** | Pointer to **int32** | | [optional] -**Clitcpka** | **string** | | [optional] -**ConnectTimeout** | Pointer to **int32** | | [optional] -**Contstats** | **string** | | [optional] -**Cookie** | **string** | | [optional] -**DefaultBackend** | **string** | | [optional] -**DefaultServer** | [**DefaultServer**](default_server.md) | | [optional] -**Dontlognull** | **string** | | [optional] -**ErrorFiles** | [**[]Errorfile**](errorfile.md) | | [optional] -**ExternalCheck** | **string** | | [optional] -**ExternalCheckCommand** | **string** | | [optional] -**ExternalCheckPath** | **string** | | [optional] -**Forwardfor** | [**Forwardfor**](forwardfor.md) | | [optional] -**HttpUseHtx** | **string** | | [optional] -**HttpConnectionMode** | **string** | | [optional] -**HttpKeepAliveTimeout** | Pointer to **int32** | | [optional] -**HttpPretendKeepalive** | **string** | | [optional] -**HttpRequestTimeout** | Pointer to **int32** | | [optional] -**Httpchk** | [**Httpchk**](httpchk.md) | | [optional] -**Httplog** | **bool** | | [optional] -**LogFormat** | **string** | | [optional] -**LogFormatSd** | **string** | | [optional] -**LogSeparateErrors** | **string** | | [optional] -**LogTag** | **string** | | [optional] -**Maxconn** | Pointer to **int32** | | [optional] -**Mode** | **string** | | [optional] -**QueueTimeout** | Pointer to **int32** | | [optional] -**Redispatch** | [**Redispatch**](redispatch.md) | | [optional] -**Retries** | Pointer to **int32** | | [optional] -**ServerTimeout** | Pointer to **int32** | | [optional] -**Tcplog** | **bool** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/DefaultsApi.md b/contrib/haproxy/openapi/docs/DefaultsApi.md deleted file mode 100644 index 71648a3b81..0000000000 --- a/contrib/haproxy/openapi/docs/DefaultsApi.md +++ /dev/null @@ -1,100 +0,0 @@ -# \DefaultsApi - -All URIs are relative to *http://localhost/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**GetDefaults**](DefaultsApi.md#GetDefaults) | **Get** /services/haproxy/configuration/defaults | Return defaults part of configuration -[**ReplaceDefaults**](DefaultsApi.md#ReplaceDefaults) | **Put** /services/haproxy/configuration/defaults | Replace defaults - - - -## GetDefaults - -> InlineResponse2003 GetDefaults(ctx, optional) - -Return defaults part of configuration - -Returns defaults part of configuration. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. - **optional** | ***GetDefaultsOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetDefaultsOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse2003**](inline_response_200_3.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceDefaults - -> Defaults ReplaceDefaults(ctx, defaults, optional) - -Replace defaults - -Replace defaults part of config - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**defaults** | [**Defaults**](Defaults.md)| | - **optional** | ***ReplaceDefaultsOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceDefaultsOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**Defaults**](defaults.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - diff --git a/contrib/haproxy/openapi/docs/DiscoveryApi.md b/contrib/haproxy/openapi/docs/DiscoveryApi.md deleted file mode 100644 index 4cd943b453..0000000000 --- a/contrib/haproxy/openapi/docs/DiscoveryApi.md +++ /dev/null @@ -1,163 +0,0 @@ -# \DiscoveryApi - -All URIs are relative to *http://localhost/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**GetAPIEndpoints**](DiscoveryApi.md#GetAPIEndpoints) | **Get** / | Return list of root endpoints -[**GetConfigurationEndpoints**](DiscoveryApi.md#GetConfigurationEndpoints) | **Get** /services/haproxy/configuration | Return list of HAProxy advanced configuration endpoints -[**GetHaproxyEndpoints**](DiscoveryApi.md#GetHaproxyEndpoints) | **Get** /services/haproxy | Return list of HAProxy related endpoints -[**GetServicesEndpoints**](DiscoveryApi.md#GetServicesEndpoints) | **Get** /services | Return list of service endpoints -[**GetStatsEndpoints**](DiscoveryApi.md#GetStatsEndpoints) | **Get** /services/haproxy/stats | Return list of HAProxy stats endpoints - - - -## GetAPIEndpoints - -> []Endpoint GetAPIEndpoints(ctx, ) - -Return list of root endpoints - -Returns a list of root endpoints. - -### Required Parameters - -This endpoint does not need any parameter. - -### Return type - -[**[]Endpoint**](endpoint.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetConfigurationEndpoints - -> []Endpoint GetConfigurationEndpoints(ctx, ) - -Return list of HAProxy advanced configuration endpoints - -Returns a list of endpoints to be used for advanced configuration of HAProxy objects. - -### Required Parameters - -This endpoint does not need any parameter. - -### Return type - -[**[]Endpoint**](endpoint.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetHaproxyEndpoints - -> []Endpoint GetHaproxyEndpoints(ctx, ) - -Return list of HAProxy related endpoints - -Returns a list of HAProxy related endpoints. - -### Required Parameters - -This endpoint does not need any parameter. - -### Return type - -[**[]Endpoint**](endpoint.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetServicesEndpoints - -> []Endpoint GetServicesEndpoints(ctx, ) - -Return list of service endpoints - -Returns a list of API managed services endpoints. - -### Required Parameters - -This endpoint does not need any parameter. - -### Return type - -[**[]Endpoint**](endpoint.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetStatsEndpoints - -> []Endpoint GetStatsEndpoints(ctx, ) - -Return list of HAProxy stats endpoints - -Returns a list of HAProxy stats endpoints. - -### Required Parameters - -This endpoint does not need any parameter. - -### Return type - -[**[]Endpoint**](endpoint.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - diff --git a/contrib/haproxy/openapi/docs/Endpoint.md b/contrib/haproxy/openapi/docs/Endpoint.md deleted file mode 100644 index 01ccfdb2be..0000000000 --- a/contrib/haproxy/openapi/docs/Endpoint.md +++ /dev/null @@ -1,13 +0,0 @@ -# Endpoint - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Description** | **string** | Endpoint description | [optional] -**Title** | **string** | Endpoint title | [optional] -**Url** | **string** | Path to the endpoint | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/Errorfile.md b/contrib/haproxy/openapi/docs/Errorfile.md deleted file mode 100644 index e2108f5c05..0000000000 --- a/contrib/haproxy/openapi/docs/Errorfile.md +++ /dev/null @@ -1,12 +0,0 @@ -# Errorfile - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Code** | **int32** | | [optional] -**File** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/Filter.md b/contrib/haproxy/openapi/docs/Filter.md deleted file mode 100644 index 3db358aca3..0000000000 --- a/contrib/haproxy/openapi/docs/Filter.md +++ /dev/null @@ -1,19 +0,0 @@ -# Filter - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**CacheName** | **string** | | [optional] -**Id** | Pointer to **int32** | | -**SpoeConfig** | **string** | | [optional] -**SpoeEngine** | **string** | | [optional] -**TraceHexdump** | **bool** | | [optional] -**TraceName** | **string** | | [optional] -**TraceRndForwarding** | **bool** | | [optional] -**TraceRndParsing** | **bool** | | [optional] -**Type** | **string** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/FilterApi.md b/contrib/haproxy/openapi/docs/FilterApi.md deleted file mode 100644 index 64df051351..0000000000 --- a/contrib/haproxy/openapi/docs/FilterApi.md +++ /dev/null @@ -1,264 +0,0 @@ -# \FilterApi - -All URIs are relative to *http://localhost/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**CreateFilter**](FilterApi.md#CreateFilter) | **Post** /services/haproxy/configuration/filters | Add a new Filter -[**DeleteFilter**](FilterApi.md#DeleteFilter) | **Delete** /services/haproxy/configuration/filters/{id} | Delete a Filter -[**GetFilter**](FilterApi.md#GetFilter) | **Get** /services/haproxy/configuration/filters/{id} | Return one Filter -[**GetFilters**](FilterApi.md#GetFilters) | **Get** /services/haproxy/configuration/filters | Return an array of all Filters -[**ReplaceFilter**](FilterApi.md#ReplaceFilter) | **Put** /services/haproxy/configuration/filters/{id} | Replace a Filter - - - -## CreateFilter - -> Filter CreateFilter(ctx, parentName, parentType, filter, optional) - -Add a new Filter - -Adds a new Filter of the specified type in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | -**filter** | [**Filter**](Filter.md)| | - **optional** | ***CreateFilterOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a CreateFilterOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**Filter**](filter.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DeleteFilter - -> DeleteFilter(ctx, id, parentName, parentType, optional) - -Delete a Filter - -Deletes a Filter configuration by it's ID from the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Filter ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***DeleteFilterOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a DeleteFilterOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - - (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetFilter - -> InlineResponse20025 GetFilter(ctx, id, parentName, parentType, optional) - -Return one Filter - -Returns one Filter configuration by it's ID in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Filter ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***GetFilterOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetFilterOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20025**](inline_response_200_25.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetFilters - -> InlineResponse20024 GetFilters(ctx, parentName, parentType, optional) - -Return an array of all Filters - -Returns all Filters that are configured in specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***GetFiltersOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetFiltersOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20024**](inline_response_200_24.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceFilter - -> Filter ReplaceFilter(ctx, id, parentName, parentType, filter, optional) - -Replace a Filter - -Replaces a Filter configuration by it's ID in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Filter ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | -**filter** | [**Filter**](Filter.md)| | - **optional** | ***ReplaceFilterOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceFilterOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**Filter**](filter.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - diff --git a/contrib/haproxy/openapi/docs/Forwardfor.md b/contrib/haproxy/openapi/docs/Forwardfor.md deleted file mode 100644 index 321b16e519..0000000000 --- a/contrib/haproxy/openapi/docs/Forwardfor.md +++ /dev/null @@ -1,14 +0,0 @@ -# Forwardfor - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Enabled** | **string** | | -**Except** | **string** | | [optional] -**Header** | **string** | | [optional] -**Ifnone** | **bool** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/Frontend.md b/contrib/haproxy/openapi/docs/Frontend.md deleted file mode 100644 index 3d0b70389e..0000000000 --- a/contrib/haproxy/openapi/docs/Frontend.md +++ /dev/null @@ -1,30 +0,0 @@ -# Frontend - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Clflog** | **bool** | | [optional] -**ClientTimeout** | Pointer to **int32** | | [optional] -**Clitcpka** | **string** | | [optional] -**Contstats** | **string** | | [optional] -**DefaultBackend** | **string** | | [optional] -**Dontlognull** | **string** | | [optional] -**Forwardfor** | [**Forwardfor**](forwardfor.md) | | [optional] -**HttpUseHtx** | **string** | | [optional] -**HttpConnectionMode** | **string** | | [optional] -**HttpKeepAliveTimeout** | Pointer to **int32** | | [optional] -**HttpRequestTimeout** | Pointer to **int32** | | [optional] -**Httplog** | **bool** | | [optional] -**LogFormat** | **string** | | [optional] -**LogFormatSd** | **string** | | [optional] -**LogSeparateErrors** | **string** | | [optional] -**LogTag** | **string** | | [optional] -**Maxconn** | Pointer to **int32** | | [optional] -**Mode** | **string** | | [optional] -**Name** | **string** | | -**Tcplog** | **bool** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/FrontendApi.md b/contrib/haproxy/openapi/docs/FrontendApi.md deleted file mode 100644 index 3f891a91f5..0000000000 --- a/contrib/haproxy/openapi/docs/FrontendApi.md +++ /dev/null @@ -1,244 +0,0 @@ -# \FrontendApi - -All URIs are relative to *http://localhost/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**CreateFrontend**](FrontendApi.md#CreateFrontend) | **Post** /services/haproxy/configuration/frontends | Add a frontend -[**DeleteFrontend**](FrontendApi.md#DeleteFrontend) | **Delete** /services/haproxy/configuration/frontends/{name} | Delete a frontend -[**GetFrontend**](FrontendApi.md#GetFrontend) | **Get** /services/haproxy/configuration/frontends/{name} | Return a frontend -[**GetFrontends**](FrontendApi.md#GetFrontends) | **Get** /services/haproxy/configuration/frontends | Return an array of frontends -[**ReplaceFrontend**](FrontendApi.md#ReplaceFrontend) | **Put** /services/haproxy/configuration/frontends/{name} | Replace a frontend - - - -## CreateFrontend - -> Frontend CreateFrontend(ctx, frontend, optional) - -Add a frontend - -Adds a new frontend to the configuration file. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**frontend** | [**Frontend**](Frontend.md)| | - **optional** | ***CreateFrontendOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a CreateFrontendOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**Frontend**](frontend.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DeleteFrontend - -> DeleteFrontend(ctx, name, optional) - -Delete a frontend - -Deletes a frontend from the configuration by it's name. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**name** | **string**| Frontend name | - **optional** | ***DeleteFrontendOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a DeleteFrontendOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - - (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetFrontend - -> InlineResponse2005 GetFrontend(ctx, name, optional) - -Return a frontend - -Returns one frontend configuration by it's name. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**name** | **string**| Frontend name | - **optional** | ***GetFrontendOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetFrontendOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse2005**](inline_response_200_5.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetFrontends - -> InlineResponse2004 GetFrontends(ctx, optional) - -Return an array of frontends - -Returns an array of all configured frontends. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. - **optional** | ***GetFrontendsOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetFrontendsOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse2004**](inline_response_200_4.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceFrontend - -> Frontend ReplaceFrontend(ctx, name, frontend, optional) - -Replace a frontend - -Replaces a frontend configuration by it's name. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**name** | **string**| Frontend name | -**frontend** | [**Frontend**](Frontend.md)| | - **optional** | ***ReplaceFrontendOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceFrontendOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**Frontend**](frontend.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - diff --git a/contrib/haproxy/openapi/docs/FrontendOptionsApi.md b/contrib/haproxy/openapi/docs/FrontendOptionsApi.md deleted file mode 100644 index edb93ccebd..0000000000 --- a/contrib/haproxy/openapi/docs/FrontendOptionsApi.md +++ /dev/null @@ -1,2282 +0,0 @@ -# \FrontendOptionsApi - -All URIs are relative to *http://localhost/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**CreateAcl**](FrontendOptionsApi.md#CreateAcl) | **Post** /services/haproxy/configuration/acls | Add a new ACL line -[**CreateBackendSwitchingRule**](FrontendOptionsApi.md#CreateBackendSwitchingRule) | **Post** /services/haproxy/configuration/backend_switching_rules | Add a new Backend Switching Rule -[**CreateBind**](FrontendOptionsApi.md#CreateBind) | **Post** /services/haproxy/configuration/binds | Add a new bind -[**CreateFilter**](FrontendOptionsApi.md#CreateFilter) | **Post** /services/haproxy/configuration/filters | Add a new Filter -[**CreateHTTPRequestRule**](FrontendOptionsApi.md#CreateHTTPRequestRule) | **Post** /services/haproxy/configuration/http_request_rules | Add a new HTTP Request Rule -[**CreateHTTPResponseRule**](FrontendOptionsApi.md#CreateHTTPResponseRule) | **Post** /services/haproxy/configuration/http_response_rules | Add a new HTTP Response Rule -[**CreateLogTarget**](FrontendOptionsApi.md#CreateLogTarget) | **Post** /services/haproxy/configuration/log_targets | Add a new Log Target -[**CreateTCPRequestRule**](FrontendOptionsApi.md#CreateTCPRequestRule) | **Post** /services/haproxy/configuration/tcp_request_rules | Add a new TCP Request Rule -[**CreateTCPResponseRule**](FrontendOptionsApi.md#CreateTCPResponseRule) | **Post** /services/haproxy/configuration/tcp_response_rules | Add a new TCP Response Rule -[**DeleteAcl**](FrontendOptionsApi.md#DeleteAcl) | **Delete** /services/haproxy/configuration/acls/{id} | Delete a ACL line -[**DeleteBackendSwitchingRule**](FrontendOptionsApi.md#DeleteBackendSwitchingRule) | **Delete** /services/haproxy/configuration/backend_switching_rules/{id} | Delete a Backend Switching Rule -[**DeleteBind**](FrontendOptionsApi.md#DeleteBind) | **Delete** /services/haproxy/configuration/binds/{name} | Delete a bind -[**DeleteFilter**](FrontendOptionsApi.md#DeleteFilter) | **Delete** /services/haproxy/configuration/filters/{id} | Delete a Filter -[**DeleteHTTPRequestRule**](FrontendOptionsApi.md#DeleteHTTPRequestRule) | **Delete** /services/haproxy/configuration/http_request_rules/{id} | Delete a HTTP Request Rule -[**DeleteHTTPResponseRule**](FrontendOptionsApi.md#DeleteHTTPResponseRule) | **Delete** /services/haproxy/configuration/http_response_rules/{id} | Delete a HTTP Response Rule -[**DeleteLogTarget**](FrontendOptionsApi.md#DeleteLogTarget) | **Delete** /services/haproxy/configuration/log_targets/{id} | Delete a Log Target -[**DeleteTCPRequestRule**](FrontendOptionsApi.md#DeleteTCPRequestRule) | **Delete** /services/haproxy/configuration/tcp_request_rules/{id} | Delete a TCP Request Rule -[**DeleteTCPResponseRule**](FrontendOptionsApi.md#DeleteTCPResponseRule) | **Delete** /services/haproxy/configuration/tcp_response_rules/{id} | Delete a TCP Response Rule -[**GetAcl**](FrontendOptionsApi.md#GetAcl) | **Get** /services/haproxy/configuration/acls/{id} | Return one ACL line -[**GetAcls**](FrontendOptionsApi.md#GetAcls) | **Get** /services/haproxy/configuration/acls | Return an array of all ACL lines -[**GetBackendSwitchingRule**](FrontendOptionsApi.md#GetBackendSwitchingRule) | **Get** /services/haproxy/configuration/backend_switching_rules/{id} | Return one Backend Switching Rule -[**GetBackendSwitchingRules**](FrontendOptionsApi.md#GetBackendSwitchingRules) | **Get** /services/haproxy/configuration/backend_switching_rules | Return an array of all Backend Switching Rules -[**GetBind**](FrontendOptionsApi.md#GetBind) | **Get** /services/haproxy/configuration/binds/{name} | Return one bind -[**GetBinds**](FrontendOptionsApi.md#GetBinds) | **Get** /services/haproxy/configuration/binds | Return an array of binds -[**GetFilter**](FrontendOptionsApi.md#GetFilter) | **Get** /services/haproxy/configuration/filters/{id} | Return one Filter -[**GetFilters**](FrontendOptionsApi.md#GetFilters) | **Get** /services/haproxy/configuration/filters | Return an array of all Filters -[**GetHTTPRequestRule**](FrontendOptionsApi.md#GetHTTPRequestRule) | **Get** /services/haproxy/configuration/http_request_rules/{id} | Return one HTTP Request Rule -[**GetHTTPRequestRules**](FrontendOptionsApi.md#GetHTTPRequestRules) | **Get** /services/haproxy/configuration/http_request_rules | Return an array of all HTTP Request Rules -[**GetHTTPResponseRule**](FrontendOptionsApi.md#GetHTTPResponseRule) | **Get** /services/haproxy/configuration/http_response_rules/{id} | Return one HTTP Response Rule -[**GetHTTPResponseRules**](FrontendOptionsApi.md#GetHTTPResponseRules) | **Get** /services/haproxy/configuration/http_response_rules | Return an array of all HTTP Response Rules -[**GetLogTarget**](FrontendOptionsApi.md#GetLogTarget) | **Get** /services/haproxy/configuration/log_targets/{id} | Return one Log Target -[**GetLogTargets**](FrontendOptionsApi.md#GetLogTargets) | **Get** /services/haproxy/configuration/log_targets | Return an array of all Log Targets -[**GetTCPRequestRule**](FrontendOptionsApi.md#GetTCPRequestRule) | **Get** /services/haproxy/configuration/tcp_request_rules/{id} | Return one TCP Request Rule -[**GetTCPRequestRules**](FrontendOptionsApi.md#GetTCPRequestRules) | **Get** /services/haproxy/configuration/tcp_request_rules | Return an array of all TCP Request Rules -[**GetTCPResponseRule**](FrontendOptionsApi.md#GetTCPResponseRule) | **Get** /services/haproxy/configuration/tcp_response_rules/{id} | Return one TCP Response Rule -[**GetTCPResponseRules**](FrontendOptionsApi.md#GetTCPResponseRules) | **Get** /services/haproxy/configuration/tcp_response_rules | Return an array of all TCP Response Rules -[**ReplaceAcl**](FrontendOptionsApi.md#ReplaceAcl) | **Put** /services/haproxy/configuration/acls/{id} | Replace a ACL line -[**ReplaceBackendSwitchingRule**](FrontendOptionsApi.md#ReplaceBackendSwitchingRule) | **Put** /services/haproxy/configuration/backend_switching_rules/{id} | Replace a Backend Switching Rule -[**ReplaceBind**](FrontendOptionsApi.md#ReplaceBind) | **Put** /services/haproxy/configuration/binds/{name} | Replace a bind -[**ReplaceFilter**](FrontendOptionsApi.md#ReplaceFilter) | **Put** /services/haproxy/configuration/filters/{id} | Replace a Filter -[**ReplaceHTTPRequestRule**](FrontendOptionsApi.md#ReplaceHTTPRequestRule) | **Put** /services/haproxy/configuration/http_request_rules/{id} | Replace a HTTP Request Rule -[**ReplaceHTTPResponseRule**](FrontendOptionsApi.md#ReplaceHTTPResponseRule) | **Put** /services/haproxy/configuration/http_response_rules/{id} | Replace a HTTP Response Rule -[**ReplaceLogTarget**](FrontendOptionsApi.md#ReplaceLogTarget) | **Put** /services/haproxy/configuration/log_targets/{id} | Replace a Log Target -[**ReplaceTCPRequestRule**](FrontendOptionsApi.md#ReplaceTCPRequestRule) | **Put** /services/haproxy/configuration/tcp_request_rules/{id} | Replace a TCP Request Rule -[**ReplaceTCPResponseRule**](FrontendOptionsApi.md#ReplaceTCPResponseRule) | **Put** /services/haproxy/configuration/tcp_response_rules/{id} | Replace a TCP Response Rule - - - -## CreateAcl - -> Acl CreateAcl(ctx, parentName, parentType, acl, optional) - -Add a new ACL line - -Adds a new ACL line of the specified type in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | -**acl** | [**Acl**](Acl.md)| | - **optional** | ***CreateAclOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a CreateAclOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**Acl**](acl.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## CreateBackendSwitchingRule - -> BackendSwitchingRule CreateBackendSwitchingRule(ctx, frontend, backendSwitchingRule, optional) - -Add a new Backend Switching Rule - -Adds a new Backend Switching Rule of the specified type in the specified frontend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**frontend** | **string**| Frontend name | -**backendSwitchingRule** | [**BackendSwitchingRule**](BackendSwitchingRule.md)| | - **optional** | ***CreateBackendSwitchingRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a CreateBackendSwitchingRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**BackendSwitchingRule**](backend_switching_rule.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## CreateBind - -> Bind CreateBind(ctx, frontend, bind, optional) - -Add a new bind - -Adds a new bind in the specified frontend in the configuration file. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**frontend** | **string**| Parent frontend name | -**bind** | [**Bind**](Bind.md)| | - **optional** | ***CreateBindOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a CreateBindOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**Bind**](bind.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## CreateFilter - -> Filter CreateFilter(ctx, parentName, parentType, filter, optional) - -Add a new Filter - -Adds a new Filter of the specified type in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | -**filter** | [**Filter**](Filter.md)| | - **optional** | ***CreateFilterOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a CreateFilterOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**Filter**](filter.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## CreateHTTPRequestRule - -> HttpRequestRule CreateHTTPRequestRule(ctx, parentName, parentType, httpRequestRule, optional) - -Add a new HTTP Request Rule - -Adds a new HTTP Request Rule of the specified type in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | -**httpRequestRule** | [**HttpRequestRule**](HttpRequestRule.md)| | - **optional** | ***CreateHTTPRequestRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a CreateHTTPRequestRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**HttpRequestRule**](http_request_rule.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## CreateHTTPResponseRule - -> HttpResponseRule CreateHTTPResponseRule(ctx, parentName, parentType, httpResponseRule, optional) - -Add a new HTTP Response Rule - -Adds a new HTTP Response Rule of the specified type in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | -**httpResponseRule** | [**HttpResponseRule**](HttpResponseRule.md)| | - **optional** | ***CreateHTTPResponseRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a CreateHTTPResponseRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**HttpResponseRule**](http_response_rule.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## CreateLogTarget - -> LogTarget CreateLogTarget(ctx, parentName, parentType, logTarget, optional) - -Add a new Log Target - -Adds a new Log Target of the specified type in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | -**logTarget** | [**LogTarget**](LogTarget.md)| | - **optional** | ***CreateLogTargetOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a CreateLogTargetOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**LogTarget**](log_target.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## CreateTCPRequestRule - -> TcpRequestRule CreateTCPRequestRule(ctx, parentName, parentType, tcpRequestRule, optional) - -Add a new TCP Request Rule - -Adds a new TCP Request Rule of the specified type in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | -**tcpRequestRule** | [**TcpRequestRule**](TcpRequestRule.md)| | - **optional** | ***CreateTCPRequestRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a CreateTCPRequestRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**TcpRequestRule**](tcp_request_rule.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## CreateTCPResponseRule - -> TcpResponseRule CreateTCPResponseRule(ctx, backend, tcpResponseRule, optional) - -Add a new TCP Response Rule - -Adds a new TCP Response Rule of the specified type in the specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**backend** | **string**| Parent backend name | -**tcpResponseRule** | [**TcpResponseRule**](TcpResponseRule.md)| | - **optional** | ***CreateTCPResponseRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a CreateTCPResponseRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**TcpResponseRule**](tcp_response_rule.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DeleteAcl - -> DeleteAcl(ctx, id, parentName, parentType, optional) - -Delete a ACL line - -Deletes a ACL line configuration by it's ID from the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| ACL line ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***DeleteAclOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a DeleteAclOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - - (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DeleteBackendSwitchingRule - -> DeleteBackendSwitchingRule(ctx, id, frontend, optional) - -Delete a Backend Switching Rule - -Deletes a Backend Switching Rule configuration by it's ID from the specified frontend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Switching Rule ID | -**frontend** | **string**| Frontend name | - **optional** | ***DeleteBackendSwitchingRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a DeleteBackendSwitchingRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - - (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DeleteBind - -> DeleteBind(ctx, name, frontend, optional) - -Delete a bind - -Deletes a bind configuration by it's name in the specified frontend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**name** | **string**| Bind name | -**frontend** | **string**| Parent frontend name | - **optional** | ***DeleteBindOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a DeleteBindOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - - (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DeleteFilter - -> DeleteFilter(ctx, id, parentName, parentType, optional) - -Delete a Filter - -Deletes a Filter configuration by it's ID from the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Filter ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***DeleteFilterOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a DeleteFilterOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - - (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DeleteHTTPRequestRule - -> DeleteHTTPRequestRule(ctx, id, parentName, parentType, optional) - -Delete a HTTP Request Rule - -Deletes a HTTP Request Rule configuration by it's ID from the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| HTTP Request Rule ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***DeleteHTTPRequestRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a DeleteHTTPRequestRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - - (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DeleteHTTPResponseRule - -> DeleteHTTPResponseRule(ctx, id, parentName, parentType, optional) - -Delete a HTTP Response Rule - -Deletes a HTTP Response Rule configuration by it's ID from the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| HTTP Response Rule ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***DeleteHTTPResponseRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a DeleteHTTPResponseRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - - (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DeleteLogTarget - -> DeleteLogTarget(ctx, id, parentName, parentType, optional) - -Delete a Log Target - -Deletes a Log Target configuration by it's ID from the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Log Target ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***DeleteLogTargetOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a DeleteLogTargetOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - - (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DeleteTCPRequestRule - -> DeleteTCPRequestRule(ctx, id, parentName, parentType, optional) - -Delete a TCP Request Rule - -Deletes a TCP Request Rule configuration by it's ID from the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| TCP Request Rule ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***DeleteTCPRequestRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a DeleteTCPRequestRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - - (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DeleteTCPResponseRule - -> DeleteTCPResponseRule(ctx, id, backend, optional) - -Delete a TCP Response Rule - -Deletes a TCP Response Rule configuration by it's ID from the specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| TCP Response Rule ID | -**backend** | **string**| Parent backend name | - **optional** | ***DeleteTCPResponseRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a DeleteTCPResponseRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - - (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetAcl - -> InlineResponse20031 GetAcl(ctx, id, parentName, parentType, optional) - -Return one ACL line - -Returns one ACL line configuration by it's ID in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| ACL line ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***GetAclOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetAclOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20031**](inline_response_200_31.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetAcls - -> InlineResponse20030 GetAcls(ctx, parentName, parentType, optional) - -Return an array of all ACL lines - -Returns all ACL lines that are configured in specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***GetAclsOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetAclsOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20030**](inline_response_200_30.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetBackendSwitchingRule - -> InlineResponse20021 GetBackendSwitchingRule(ctx, id, frontend, optional) - -Return one Backend Switching Rule - -Returns one Backend Switching Rule configuration by it's ID in the specified frontend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Switching Rule ID | -**frontend** | **string**| Frontend name | - **optional** | ***GetBackendSwitchingRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetBackendSwitchingRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20021**](inline_response_200_21.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetBackendSwitchingRules - -> InlineResponse20020 GetBackendSwitchingRules(ctx, frontend, optional) - -Return an array of all Backend Switching Rules - -Returns all Backend Switching Rules that are configured in specified frontend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**frontend** | **string**| Frontend name | - **optional** | ***GetBackendSwitchingRulesOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetBackendSwitchingRulesOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20020**](inline_response_200_20.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetBind - -> InlineResponse2009 GetBind(ctx, name, frontend, optional) - -Return one bind - -Returns one bind configuration by it's name in the specified frontend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**name** | **string**| Bind name | -**frontend** | **string**| Parent frontend name | - **optional** | ***GetBindOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetBindOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse2009**](inline_response_200_9.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetBinds - -> InlineResponse2008 GetBinds(ctx, frontend, optional) - -Return an array of binds - -Returns an array of all binds that are configured in specified frontend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**frontend** | **string**| Parent frontend name | - **optional** | ***GetBindsOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetBindsOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse2008**](inline_response_200_8.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetFilter - -> InlineResponse20025 GetFilter(ctx, id, parentName, parentType, optional) - -Return one Filter - -Returns one Filter configuration by it's ID in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Filter ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***GetFilterOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetFilterOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20025**](inline_response_200_25.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetFilters - -> InlineResponse20024 GetFilters(ctx, parentName, parentType, optional) - -Return an array of all Filters - -Returns all Filters that are configured in specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***GetFiltersOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetFiltersOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20024**](inline_response_200_24.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetHTTPRequestRule - -> InlineResponse20013 GetHTTPRequestRule(ctx, id, parentName, parentType, optional) - -Return one HTTP Request Rule - -Returns one HTTP Request Rule configuration by it's ID in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| HTTP Request Rule ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***GetHTTPRequestRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetHTTPRequestRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20013**](inline_response_200_13.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetHTTPRequestRules - -> InlineResponse20012 GetHTTPRequestRules(ctx, parentName, parentType, optional) - -Return an array of all HTTP Request Rules - -Returns all HTTP Request Rules that are configured in specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***GetHTTPRequestRulesOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetHTTPRequestRulesOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20012**](inline_response_200_12.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetHTTPResponseRule - -> InlineResponse20015 GetHTTPResponseRule(ctx, id, parentName, parentType, optional) - -Return one HTTP Response Rule - -Returns one HTTP Response Rule configuration by it's ID in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| HTTP Response Rule ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***GetHTTPResponseRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetHTTPResponseRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20015**](inline_response_200_15.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetHTTPResponseRules - -> InlineResponse20014 GetHTTPResponseRules(ctx, parentName, parentType, optional) - -Return an array of all HTTP Response Rules - -Returns all HTTP Response Rules that are configured in specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***GetHTTPResponseRulesOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetHTTPResponseRulesOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20014**](inline_response_200_14.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetLogTarget - -> InlineResponse20029 GetLogTarget(ctx, id, parentName, parentType, optional) - -Return one Log Target - -Returns one Log Target configuration by it's ID in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Log Target ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***GetLogTargetOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetLogTargetOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20029**](inline_response_200_29.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetLogTargets - -> InlineResponse20028 GetLogTargets(ctx, parentName, parentType, optional) - -Return an array of all Log Targets - -Returns all Log Targets that are configured in specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***GetLogTargetsOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetLogTargetsOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20028**](inline_response_200_28.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetTCPRequestRule - -> InlineResponse20017 GetTCPRequestRule(ctx, id, parentName, parentType, optional) - -Return one TCP Request Rule - -Returns one TCP Request Rule configuration by it's ID in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| TCP Request Rule ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***GetTCPRequestRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetTCPRequestRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20017**](inline_response_200_17.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetTCPRequestRules - -> InlineResponse20016 GetTCPRequestRules(ctx, parentName, parentType, optional) - -Return an array of all TCP Request Rules - -Returns all TCP Request Rules that are configured in specified parent and parent type. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***GetTCPRequestRulesOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetTCPRequestRulesOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20016**](inline_response_200_16.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetTCPResponseRule - -> InlineResponse20019 GetTCPResponseRule(ctx, id, backend, optional) - -Return one TCP Response Rule - -Returns one TCP Response Rule configuration by it's ID in the specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| TCP Response Rule ID | -**backend** | **string**| Parent backend name | - **optional** | ***GetTCPResponseRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetTCPResponseRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20019**](inline_response_200_19.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetTCPResponseRules - -> InlineResponse20018 GetTCPResponseRules(ctx, backend, optional) - -Return an array of all TCP Response Rules - -Returns all TCP Response Rules that are configured in specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**backend** | **string**| Parent backend name | - **optional** | ***GetTCPResponseRulesOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetTCPResponseRulesOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20018**](inline_response_200_18.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceAcl - -> Acl ReplaceAcl(ctx, id, parentName, parentType, acl, optional) - -Replace a ACL line - -Replaces a ACL line configuration by it's ID in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| ACL line ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | -**acl** | [**Acl**](Acl.md)| | - **optional** | ***ReplaceAclOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceAclOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**Acl**](acl.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceBackendSwitchingRule - -> BackendSwitchingRule ReplaceBackendSwitchingRule(ctx, id, frontend, backendSwitchingRule, optional) - -Replace a Backend Switching Rule - -Replaces a Backend Switching Rule configuration by it's ID in the specified frontend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Switching Rule ID | -**frontend** | **string**| Frontend name | -**backendSwitchingRule** | [**BackendSwitchingRule**](BackendSwitchingRule.md)| | - **optional** | ***ReplaceBackendSwitchingRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceBackendSwitchingRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**BackendSwitchingRule**](backend_switching_rule.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceBind - -> Bind ReplaceBind(ctx, name, frontend, bind, optional) - -Replace a bind - -Replaces a bind configuration by it's name in the specified frontend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**name** | **string**| Bind name | -**frontend** | **string**| Parent frontend name | -**bind** | [**Bind**](Bind.md)| | - **optional** | ***ReplaceBindOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceBindOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**Bind**](bind.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceFilter - -> Filter ReplaceFilter(ctx, id, parentName, parentType, filter, optional) - -Replace a Filter - -Replaces a Filter configuration by it's ID in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Filter ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | -**filter** | [**Filter**](Filter.md)| | - **optional** | ***ReplaceFilterOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceFilterOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**Filter**](filter.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceHTTPRequestRule - -> HttpRequestRule ReplaceHTTPRequestRule(ctx, id, parentName, parentType, httpRequestRule, optional) - -Replace a HTTP Request Rule - -Replaces a HTTP Request Rule configuration by it's ID in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| HTTP Request Rule ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | -**httpRequestRule** | [**HttpRequestRule**](HttpRequestRule.md)| | - **optional** | ***ReplaceHTTPRequestRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceHTTPRequestRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**HttpRequestRule**](http_request_rule.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceHTTPResponseRule - -> HttpResponseRule ReplaceHTTPResponseRule(ctx, id, parentName, parentType, httpResponseRule, optional) - -Replace a HTTP Response Rule - -Replaces a HTTP Response Rule configuration by it's ID in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| HTTP Response Rule ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | -**httpResponseRule** | [**HttpResponseRule**](HttpResponseRule.md)| | - **optional** | ***ReplaceHTTPResponseRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceHTTPResponseRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**HttpResponseRule**](http_response_rule.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceLogTarget - -> LogTarget ReplaceLogTarget(ctx, id, parentName, parentType, logTarget, optional) - -Replace a Log Target - -Replaces a Log Target configuration by it's ID in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Log Target ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | -**logTarget** | [**LogTarget**](LogTarget.md)| | - **optional** | ***ReplaceLogTargetOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceLogTargetOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**LogTarget**](log_target.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceTCPRequestRule - -> TcpRequestRule ReplaceTCPRequestRule(ctx, id, parentName, parentType, tcpRequestRule, optional) - -Replace a TCP Request Rule - -Replaces a TCP Request Rule configuration by it's ID in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| TCP Request Rule ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | -**tcpRequestRule** | [**TcpRequestRule**](TcpRequestRule.md)| | - **optional** | ***ReplaceTCPRequestRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceTCPRequestRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**TcpRequestRule**](tcp_request_rule.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceTCPResponseRule - -> TcpResponseRule ReplaceTCPResponseRule(ctx, id, backend, tcpResponseRule, optional) - -Replace a TCP Response Rule - -Replaces a TCP Response Rule configuration by it's ID in the specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| TCP Response Rule ID | -**backend** | **string**| Parent backend name | -**tcpResponseRule** | [**TcpResponseRule**](TcpResponseRule.md)| | - **optional** | ***ReplaceTCPResponseRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceTCPResponseRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**TcpResponseRule**](tcp_response_rule.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - diff --git a/contrib/haproxy/openapi/docs/Global.md b/contrib/haproxy/openapi/docs/Global.md deleted file mode 100644 index d1f0fffca0..0000000000 --- a/contrib/haproxy/openapi/docs/Global.md +++ /dev/null @@ -1,23 +0,0 @@ -# Global - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**CpuMaps** | [**[]GlobalCpuMaps**](global_cpu_maps.md) | | [optional] -**Daemon** | **string** | | [optional] -**ExternalCheck** | **bool** | | [optional] -**MasterWorker** | **bool** | | [optional] -**Maxconn** | **int32** | | [optional] -**Nbproc** | **int32** | | [optional] -**Nbthread** | **int32** | | [optional] -**Pidfile** | **string** | | [optional] -**RuntimeApis** | [**[]GlobalRuntimeApis**](global_runtime_apis.md) | | [optional] -**SslDefaultBindCiphers** | **string** | | [optional] -**SslDefaultBindOptions** | **string** | | [optional] -**StatsTimeout** | Pointer to **int32** | | [optional] -**TuneSslDefaultDhParam** | **int32** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/GlobalApi.md b/contrib/haproxy/openapi/docs/GlobalApi.md deleted file mode 100644 index 2ae5f57d71..0000000000 --- a/contrib/haproxy/openapi/docs/GlobalApi.md +++ /dev/null @@ -1,100 +0,0 @@ -# \GlobalApi - -All URIs are relative to *http://localhost/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**GetGlobal**](GlobalApi.md#GetGlobal) | **Get** /services/haproxy/configuration/global | Return a global part of configuration -[**ReplaceGlobal**](GlobalApi.md#ReplaceGlobal) | **Put** /services/haproxy/configuration/global | Replace global - - - -## GetGlobal - -> InlineResponse2002 GetGlobal(ctx, optional) - -Return a global part of configuration - -Returns global part of configuration. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. - **optional** | ***GetGlobalOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetGlobalOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse2002**](inline_response_200_2.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceGlobal - -> Global ReplaceGlobal(ctx, global, optional) - -Replace global - -Replace global part of config - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**global** | [**Global**](Global.md)| | - **optional** | ***ReplaceGlobalOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceGlobalOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**Global**](global.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - diff --git a/contrib/haproxy/openapi/docs/GlobalCpuMaps.md b/contrib/haproxy/openapi/docs/GlobalCpuMaps.md deleted file mode 100644 index b05c1e48d9..0000000000 --- a/contrib/haproxy/openapi/docs/GlobalCpuMaps.md +++ /dev/null @@ -1,12 +0,0 @@ -# GlobalCpuMaps - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**CpuSet** | **string** | | -**Process** | **string** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/GlobalRuntimeApis.md b/contrib/haproxy/openapi/docs/GlobalRuntimeApis.md deleted file mode 100644 index 28ecc8c757..0000000000 --- a/contrib/haproxy/openapi/docs/GlobalRuntimeApis.md +++ /dev/null @@ -1,15 +0,0 @@ -# GlobalRuntimeApis - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Address** | **string** | | -**ExposeFdListeners** | **bool** | | [optional] -**Level** | **string** | | [optional] -**Mode** | **string** | | [optional] -**Process** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/HAProxyConfigurationManagementApi.md b/contrib/haproxy/openapi/docs/HAProxyConfigurationManagementApi.md deleted file mode 100644 index 71305ee565..0000000000 --- a/contrib/haproxy/openapi/docs/HAProxyConfigurationManagementApi.md +++ /dev/null @@ -1,3768 +0,0 @@ -# \HAProxyConfigurationManagementApi - -All URIs are relative to *http://localhost/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**CreateAcl**](HAProxyConfigurationManagementApi.md#CreateAcl) | **Post** /services/haproxy/configuration/acls | Add a new ACL line -[**CreateBackend**](HAProxyConfigurationManagementApi.md#CreateBackend) | **Post** /services/haproxy/configuration/backends | Add a backend -[**CreateBackendSwitchingRule**](HAProxyConfigurationManagementApi.md#CreateBackendSwitchingRule) | **Post** /services/haproxy/configuration/backend_switching_rules | Add a new Backend Switching Rule -[**CreateBind**](HAProxyConfigurationManagementApi.md#CreateBind) | **Post** /services/haproxy/configuration/binds | Add a new bind -[**CreateFilter**](HAProxyConfigurationManagementApi.md#CreateFilter) | **Post** /services/haproxy/configuration/filters | Add a new Filter -[**CreateFrontend**](HAProxyConfigurationManagementApi.md#CreateFrontend) | **Post** /services/haproxy/configuration/frontends | Add a frontend -[**CreateHTTPRequestRule**](HAProxyConfigurationManagementApi.md#CreateHTTPRequestRule) | **Post** /services/haproxy/configuration/http_request_rules | Add a new HTTP Request Rule -[**CreateHTTPResponseRule**](HAProxyConfigurationManagementApi.md#CreateHTTPResponseRule) | **Post** /services/haproxy/configuration/http_response_rules | Add a new HTTP Response Rule -[**CreateLogTarget**](HAProxyConfigurationManagementApi.md#CreateLogTarget) | **Post** /services/haproxy/configuration/log_targets | Add a new Log Target -[**CreateServer**](HAProxyConfigurationManagementApi.md#CreateServer) | **Post** /services/haproxy/configuration/servers | Add a new server -[**CreateServerSwitchingRule**](HAProxyConfigurationManagementApi.md#CreateServerSwitchingRule) | **Post** /services/haproxy/configuration/server_switching_rules | Add a new Server Switching Rule -[**CreateStickRule**](HAProxyConfigurationManagementApi.md#CreateStickRule) | **Post** /services/haproxy/configuration/stick_rules | Add a new Stick Rule -[**CreateTCPRequestRule**](HAProxyConfigurationManagementApi.md#CreateTCPRequestRule) | **Post** /services/haproxy/configuration/tcp_request_rules | Add a new TCP Request Rule -[**CreateTCPResponseRule**](HAProxyConfigurationManagementApi.md#CreateTCPResponseRule) | **Post** /services/haproxy/configuration/tcp_response_rules | Add a new TCP Response Rule -[**DeleteAcl**](HAProxyConfigurationManagementApi.md#DeleteAcl) | **Delete** /services/haproxy/configuration/acls/{id} | Delete a ACL line -[**DeleteBackend**](HAProxyConfigurationManagementApi.md#DeleteBackend) | **Delete** /services/haproxy/configuration/backends/{name} | Delete a backend -[**DeleteBackendSwitchingRule**](HAProxyConfigurationManagementApi.md#DeleteBackendSwitchingRule) | **Delete** /services/haproxy/configuration/backend_switching_rules/{id} | Delete a Backend Switching Rule -[**DeleteBind**](HAProxyConfigurationManagementApi.md#DeleteBind) | **Delete** /services/haproxy/configuration/binds/{name} | Delete a bind -[**DeleteFilter**](HAProxyConfigurationManagementApi.md#DeleteFilter) | **Delete** /services/haproxy/configuration/filters/{id} | Delete a Filter -[**DeleteFrontend**](HAProxyConfigurationManagementApi.md#DeleteFrontend) | **Delete** /services/haproxy/configuration/frontends/{name} | Delete a frontend -[**DeleteHTTPRequestRule**](HAProxyConfigurationManagementApi.md#DeleteHTTPRequestRule) | **Delete** /services/haproxy/configuration/http_request_rules/{id} | Delete a HTTP Request Rule -[**DeleteHTTPResponseRule**](HAProxyConfigurationManagementApi.md#DeleteHTTPResponseRule) | **Delete** /services/haproxy/configuration/http_response_rules/{id} | Delete a HTTP Response Rule -[**DeleteLogTarget**](HAProxyConfigurationManagementApi.md#DeleteLogTarget) | **Delete** /services/haproxy/configuration/log_targets/{id} | Delete a Log Target -[**DeleteServer**](HAProxyConfigurationManagementApi.md#DeleteServer) | **Delete** /services/haproxy/configuration/servers/{name} | Delete a server -[**DeleteServerSwitchingRule**](HAProxyConfigurationManagementApi.md#DeleteServerSwitchingRule) | **Delete** /services/haproxy/configuration/server_switching_rules/{id} | Delete a Server Switching Rule -[**DeleteStickRule**](HAProxyConfigurationManagementApi.md#DeleteStickRule) | **Delete** /services/haproxy/configuration/stick_rules/{id} | Delete a Stick Rule -[**DeleteTCPRequestRule**](HAProxyConfigurationManagementApi.md#DeleteTCPRequestRule) | **Delete** /services/haproxy/configuration/tcp_request_rules/{id} | Delete a TCP Request Rule -[**DeleteTCPResponseRule**](HAProxyConfigurationManagementApi.md#DeleteTCPResponseRule) | **Delete** /services/haproxy/configuration/tcp_response_rules/{id} | Delete a TCP Response Rule -[**GetAcl**](HAProxyConfigurationManagementApi.md#GetAcl) | **Get** /services/haproxy/configuration/acls/{id} | Return one ACL line -[**GetAcls**](HAProxyConfigurationManagementApi.md#GetAcls) | **Get** /services/haproxy/configuration/acls | Return an array of all ACL lines -[**GetBackend**](HAProxyConfigurationManagementApi.md#GetBackend) | **Get** /services/haproxy/configuration/backends/{name} | Return a backend -[**GetBackendSwitchingRule**](HAProxyConfigurationManagementApi.md#GetBackendSwitchingRule) | **Get** /services/haproxy/configuration/backend_switching_rules/{id} | Return one Backend Switching Rule -[**GetBackendSwitchingRules**](HAProxyConfigurationManagementApi.md#GetBackendSwitchingRules) | **Get** /services/haproxy/configuration/backend_switching_rules | Return an array of all Backend Switching Rules -[**GetBackends**](HAProxyConfigurationManagementApi.md#GetBackends) | **Get** /services/haproxy/configuration/backends | Return an array of backends -[**GetBind**](HAProxyConfigurationManagementApi.md#GetBind) | **Get** /services/haproxy/configuration/binds/{name} | Return one bind -[**GetBinds**](HAProxyConfigurationManagementApi.md#GetBinds) | **Get** /services/haproxy/configuration/binds | Return an array of binds -[**GetDefaults**](HAProxyConfigurationManagementApi.md#GetDefaults) | **Get** /services/haproxy/configuration/defaults | Return defaults part of configuration -[**GetFilter**](HAProxyConfigurationManagementApi.md#GetFilter) | **Get** /services/haproxy/configuration/filters/{id} | Return one Filter -[**GetFilters**](HAProxyConfigurationManagementApi.md#GetFilters) | **Get** /services/haproxy/configuration/filters | Return an array of all Filters -[**GetFrontend**](HAProxyConfigurationManagementApi.md#GetFrontend) | **Get** /services/haproxy/configuration/frontends/{name} | Return a frontend -[**GetFrontends**](HAProxyConfigurationManagementApi.md#GetFrontends) | **Get** /services/haproxy/configuration/frontends | Return an array of frontends -[**GetGlobal**](HAProxyConfigurationManagementApi.md#GetGlobal) | **Get** /services/haproxy/configuration/global | Return a global part of configuration -[**GetHAProxyConfiguration**](HAProxyConfigurationManagementApi.md#GetHAProxyConfiguration) | **Get** /services/haproxy/configuration/raw | Return HAProxy configuration -[**GetHTTPRequestRule**](HAProxyConfigurationManagementApi.md#GetHTTPRequestRule) | **Get** /services/haproxy/configuration/http_request_rules/{id} | Return one HTTP Request Rule -[**GetHTTPRequestRules**](HAProxyConfigurationManagementApi.md#GetHTTPRequestRules) | **Get** /services/haproxy/configuration/http_request_rules | Return an array of all HTTP Request Rules -[**GetHTTPResponseRule**](HAProxyConfigurationManagementApi.md#GetHTTPResponseRule) | **Get** /services/haproxy/configuration/http_response_rules/{id} | Return one HTTP Response Rule -[**GetHTTPResponseRules**](HAProxyConfigurationManagementApi.md#GetHTTPResponseRules) | **Get** /services/haproxy/configuration/http_response_rules | Return an array of all HTTP Response Rules -[**GetLogTarget**](HAProxyConfigurationManagementApi.md#GetLogTarget) | **Get** /services/haproxy/configuration/log_targets/{id} | Return one Log Target -[**GetLogTargets**](HAProxyConfigurationManagementApi.md#GetLogTargets) | **Get** /services/haproxy/configuration/log_targets | Return an array of all Log Targets -[**GetServer**](HAProxyConfigurationManagementApi.md#GetServer) | **Get** /services/haproxy/configuration/servers/{name} | Return one server -[**GetServerSwitchingRule**](HAProxyConfigurationManagementApi.md#GetServerSwitchingRule) | **Get** /services/haproxy/configuration/server_switching_rules/{id} | Return one Server Switching Rule -[**GetServerSwitchingRules**](HAProxyConfigurationManagementApi.md#GetServerSwitchingRules) | **Get** /services/haproxy/configuration/server_switching_rules | Return an array of all Server Switching Rules -[**GetServers**](HAProxyConfigurationManagementApi.md#GetServers) | **Get** /services/haproxy/configuration/servers | Return an array of servers -[**GetStickRule**](HAProxyConfigurationManagementApi.md#GetStickRule) | **Get** /services/haproxy/configuration/stick_rules/{id} | Return one Stick Rule -[**GetStickRules**](HAProxyConfigurationManagementApi.md#GetStickRules) | **Get** /services/haproxy/configuration/stick_rules | Return an array of all Stick Rules -[**GetTCPRequestRule**](HAProxyConfigurationManagementApi.md#GetTCPRequestRule) | **Get** /services/haproxy/configuration/tcp_request_rules/{id} | Return one TCP Request Rule -[**GetTCPRequestRules**](HAProxyConfigurationManagementApi.md#GetTCPRequestRules) | **Get** /services/haproxy/configuration/tcp_request_rules | Return an array of all TCP Request Rules -[**GetTCPResponseRule**](HAProxyConfigurationManagementApi.md#GetTCPResponseRule) | **Get** /services/haproxy/configuration/tcp_response_rules/{id} | Return one TCP Response Rule -[**GetTCPResponseRules**](HAProxyConfigurationManagementApi.md#GetTCPResponseRules) | **Get** /services/haproxy/configuration/tcp_response_rules | Return an array of all TCP Response Rules -[**PostHAProxyConfiguration**](HAProxyConfigurationManagementApi.md#PostHAProxyConfiguration) | **Post** /services/haproxy/configuration/raw | Push new haproxy configuration -[**ReplaceAcl**](HAProxyConfigurationManagementApi.md#ReplaceAcl) | **Put** /services/haproxy/configuration/acls/{id} | Replace a ACL line -[**ReplaceBackend**](HAProxyConfigurationManagementApi.md#ReplaceBackend) | **Put** /services/haproxy/configuration/backends/{name} | Replace a backend -[**ReplaceBackendSwitchingRule**](HAProxyConfigurationManagementApi.md#ReplaceBackendSwitchingRule) | **Put** /services/haproxy/configuration/backend_switching_rules/{id} | Replace a Backend Switching Rule -[**ReplaceBind**](HAProxyConfigurationManagementApi.md#ReplaceBind) | **Put** /services/haproxy/configuration/binds/{name} | Replace a bind -[**ReplaceDefaults**](HAProxyConfigurationManagementApi.md#ReplaceDefaults) | **Put** /services/haproxy/configuration/defaults | Replace defaults -[**ReplaceFilter**](HAProxyConfigurationManagementApi.md#ReplaceFilter) | **Put** /services/haproxy/configuration/filters/{id} | Replace a Filter -[**ReplaceFrontend**](HAProxyConfigurationManagementApi.md#ReplaceFrontend) | **Put** /services/haproxy/configuration/frontends/{name} | Replace a frontend -[**ReplaceGlobal**](HAProxyConfigurationManagementApi.md#ReplaceGlobal) | **Put** /services/haproxy/configuration/global | Replace global -[**ReplaceHTTPRequestRule**](HAProxyConfigurationManagementApi.md#ReplaceHTTPRequestRule) | **Put** /services/haproxy/configuration/http_request_rules/{id} | Replace a HTTP Request Rule -[**ReplaceHTTPResponseRule**](HAProxyConfigurationManagementApi.md#ReplaceHTTPResponseRule) | **Put** /services/haproxy/configuration/http_response_rules/{id} | Replace a HTTP Response Rule -[**ReplaceLogTarget**](HAProxyConfigurationManagementApi.md#ReplaceLogTarget) | **Put** /services/haproxy/configuration/log_targets/{id} | Replace a Log Target -[**ReplaceServer**](HAProxyConfigurationManagementApi.md#ReplaceServer) | **Put** /services/haproxy/configuration/servers/{name} | Replace a server -[**ReplaceServerSwitchingRule**](HAProxyConfigurationManagementApi.md#ReplaceServerSwitchingRule) | **Put** /services/haproxy/configuration/server_switching_rules/{id} | Replace a Server Switching Rule -[**ReplaceStickRule**](HAProxyConfigurationManagementApi.md#ReplaceStickRule) | **Put** /services/haproxy/configuration/stick_rules/{id} | Replace a Stick Rule -[**ReplaceTCPRequestRule**](HAProxyConfigurationManagementApi.md#ReplaceTCPRequestRule) | **Put** /services/haproxy/configuration/tcp_request_rules/{id} | Replace a TCP Request Rule -[**ReplaceTCPResponseRule**](HAProxyConfigurationManagementApi.md#ReplaceTCPResponseRule) | **Put** /services/haproxy/configuration/tcp_response_rules/{id} | Replace a TCP Response Rule - - - -## CreateAcl - -> Acl CreateAcl(ctx, parentName, parentType, acl, optional) - -Add a new ACL line - -Adds a new ACL line of the specified type in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | -**acl** | [**Acl**](Acl.md)| | - **optional** | ***CreateAclOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a CreateAclOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**Acl**](acl.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## CreateBackend - -> Backend CreateBackend(ctx, backend, optional) - -Add a backend - -Adds a new backend to the configuration file. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**backend** | [**Backend**](Backend.md)| | - **optional** | ***CreateBackendOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a CreateBackendOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**Backend**](backend.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## CreateBackendSwitchingRule - -> BackendSwitchingRule CreateBackendSwitchingRule(ctx, frontend, backendSwitchingRule, optional) - -Add a new Backend Switching Rule - -Adds a new Backend Switching Rule of the specified type in the specified frontend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**frontend** | **string**| Frontend name | -**backendSwitchingRule** | [**BackendSwitchingRule**](BackendSwitchingRule.md)| | - **optional** | ***CreateBackendSwitchingRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a CreateBackendSwitchingRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**BackendSwitchingRule**](backend_switching_rule.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## CreateBind - -> Bind CreateBind(ctx, frontend, bind, optional) - -Add a new bind - -Adds a new bind in the specified frontend in the configuration file. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**frontend** | **string**| Parent frontend name | -**bind** | [**Bind**](Bind.md)| | - **optional** | ***CreateBindOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a CreateBindOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**Bind**](bind.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## CreateFilter - -> Filter CreateFilter(ctx, parentName, parentType, filter, optional) - -Add a new Filter - -Adds a new Filter of the specified type in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | -**filter** | [**Filter**](Filter.md)| | - **optional** | ***CreateFilterOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a CreateFilterOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**Filter**](filter.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## CreateFrontend - -> Frontend CreateFrontend(ctx, frontend, optional) - -Add a frontend - -Adds a new frontend to the configuration file. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**frontend** | [**Frontend**](Frontend.md)| | - **optional** | ***CreateFrontendOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a CreateFrontendOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**Frontend**](frontend.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## CreateHTTPRequestRule - -> HttpRequestRule CreateHTTPRequestRule(ctx, parentName, parentType, httpRequestRule, optional) - -Add a new HTTP Request Rule - -Adds a new HTTP Request Rule of the specified type in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | -**httpRequestRule** | [**HttpRequestRule**](HttpRequestRule.md)| | - **optional** | ***CreateHTTPRequestRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a CreateHTTPRequestRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**HttpRequestRule**](http_request_rule.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## CreateHTTPResponseRule - -> HttpResponseRule CreateHTTPResponseRule(ctx, parentName, parentType, httpResponseRule, optional) - -Add a new HTTP Response Rule - -Adds a new HTTP Response Rule of the specified type in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | -**httpResponseRule** | [**HttpResponseRule**](HttpResponseRule.md)| | - **optional** | ***CreateHTTPResponseRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a CreateHTTPResponseRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**HttpResponseRule**](http_response_rule.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## CreateLogTarget - -> LogTarget CreateLogTarget(ctx, parentName, parentType, logTarget, optional) - -Add a new Log Target - -Adds a new Log Target of the specified type in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | -**logTarget** | [**LogTarget**](LogTarget.md)| | - **optional** | ***CreateLogTargetOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a CreateLogTargetOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**LogTarget**](log_target.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## CreateServer - -> Server CreateServer(ctx, backend, server, optional) - -Add a new server - -Adds a new server in the specified backend in the configuration file. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**backend** | **string**| Parent backend name | -**server** | [**Server**](Server.md)| | - **optional** | ***CreateServerOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a CreateServerOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**Server**](server.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## CreateServerSwitchingRule - -> ServerSwitchingRule CreateServerSwitchingRule(ctx, backend, serverSwitchingRule, optional) - -Add a new Server Switching Rule - -Adds a new Server Switching Rule of the specified type in the specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**backend** | **string**| Backend name | -**serverSwitchingRule** | [**ServerSwitchingRule**](ServerSwitchingRule.md)| | - **optional** | ***CreateServerSwitchingRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a CreateServerSwitchingRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**ServerSwitchingRule**](server_switching_rule.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## CreateStickRule - -> StickRule CreateStickRule(ctx, backend, stickRule, optional) - -Add a new Stick Rule - -Adds a new Stick Rule of the specified type in the specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**backend** | **string**| Backend name | -**stickRule** | [**StickRule**](StickRule.md)| | - **optional** | ***CreateStickRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a CreateStickRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**StickRule**](stick_rule.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## CreateTCPRequestRule - -> TcpRequestRule CreateTCPRequestRule(ctx, parentName, parentType, tcpRequestRule, optional) - -Add a new TCP Request Rule - -Adds a new TCP Request Rule of the specified type in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | -**tcpRequestRule** | [**TcpRequestRule**](TcpRequestRule.md)| | - **optional** | ***CreateTCPRequestRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a CreateTCPRequestRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**TcpRequestRule**](tcp_request_rule.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## CreateTCPResponseRule - -> TcpResponseRule CreateTCPResponseRule(ctx, backend, tcpResponseRule, optional) - -Add a new TCP Response Rule - -Adds a new TCP Response Rule of the specified type in the specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**backend** | **string**| Parent backend name | -**tcpResponseRule** | [**TcpResponseRule**](TcpResponseRule.md)| | - **optional** | ***CreateTCPResponseRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a CreateTCPResponseRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**TcpResponseRule**](tcp_response_rule.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DeleteAcl - -> DeleteAcl(ctx, id, parentName, parentType, optional) - -Delete a ACL line - -Deletes a ACL line configuration by it's ID from the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| ACL line ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***DeleteAclOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a DeleteAclOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - - (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DeleteBackend - -> DeleteBackend(ctx, name, optional) - -Delete a backend - -Deletes a frontend from the configuration by it's name. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**name** | **string**| Backend name | - **optional** | ***DeleteBackendOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a DeleteBackendOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - - (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DeleteBackendSwitchingRule - -> DeleteBackendSwitchingRule(ctx, id, frontend, optional) - -Delete a Backend Switching Rule - -Deletes a Backend Switching Rule configuration by it's ID from the specified frontend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Switching Rule ID | -**frontend** | **string**| Frontend name | - **optional** | ***DeleteBackendSwitchingRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a DeleteBackendSwitchingRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - - (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DeleteBind - -> DeleteBind(ctx, name, frontend, optional) - -Delete a bind - -Deletes a bind configuration by it's name in the specified frontend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**name** | **string**| Bind name | -**frontend** | **string**| Parent frontend name | - **optional** | ***DeleteBindOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a DeleteBindOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - - (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DeleteFilter - -> DeleteFilter(ctx, id, parentName, parentType, optional) - -Delete a Filter - -Deletes a Filter configuration by it's ID from the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Filter ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***DeleteFilterOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a DeleteFilterOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - - (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DeleteFrontend - -> DeleteFrontend(ctx, name, optional) - -Delete a frontend - -Deletes a frontend from the configuration by it's name. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**name** | **string**| Frontend name | - **optional** | ***DeleteFrontendOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a DeleteFrontendOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - - (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DeleteHTTPRequestRule - -> DeleteHTTPRequestRule(ctx, id, parentName, parentType, optional) - -Delete a HTTP Request Rule - -Deletes a HTTP Request Rule configuration by it's ID from the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| HTTP Request Rule ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***DeleteHTTPRequestRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a DeleteHTTPRequestRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - - (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DeleteHTTPResponseRule - -> DeleteHTTPResponseRule(ctx, id, parentName, parentType, optional) - -Delete a HTTP Response Rule - -Deletes a HTTP Response Rule configuration by it's ID from the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| HTTP Response Rule ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***DeleteHTTPResponseRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a DeleteHTTPResponseRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - - (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DeleteLogTarget - -> DeleteLogTarget(ctx, id, parentName, parentType, optional) - -Delete a Log Target - -Deletes a Log Target configuration by it's ID from the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Log Target ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***DeleteLogTargetOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a DeleteLogTargetOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - - (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DeleteServer - -> DeleteServer(ctx, name, backend, optional) - -Delete a server - -Deletes a server configuration by it's name in the specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**name** | **string**| Server name | -**backend** | **string**| Parent backend name | - **optional** | ***DeleteServerOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a DeleteServerOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - - (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DeleteServerSwitchingRule - -> DeleteServerSwitchingRule(ctx, id, backend, optional) - -Delete a Server Switching Rule - -Deletes a Server Switching Rule configuration by it's ID from the specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Switching Rule ID | -**backend** | **string**| Backend name | - **optional** | ***DeleteServerSwitchingRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a DeleteServerSwitchingRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - - (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DeleteStickRule - -> DeleteStickRule(ctx, id, backend, optional) - -Delete a Stick Rule - -Deletes a Stick Rule configuration by it's ID from the specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Stick Rule ID | -**backend** | **string**| Backend name | - **optional** | ***DeleteStickRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a DeleteStickRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - - (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DeleteTCPRequestRule - -> DeleteTCPRequestRule(ctx, id, parentName, parentType, optional) - -Delete a TCP Request Rule - -Deletes a TCP Request Rule configuration by it's ID from the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| TCP Request Rule ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***DeleteTCPRequestRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a DeleteTCPRequestRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - - (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DeleteTCPResponseRule - -> DeleteTCPResponseRule(ctx, id, backend, optional) - -Delete a TCP Response Rule - -Deletes a TCP Response Rule configuration by it's ID from the specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| TCP Response Rule ID | -**backend** | **string**| Parent backend name | - **optional** | ***DeleteTCPResponseRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a DeleteTCPResponseRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - - (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetAcl - -> InlineResponse20031 GetAcl(ctx, id, parentName, parentType, optional) - -Return one ACL line - -Returns one ACL line configuration by it's ID in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| ACL line ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***GetAclOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetAclOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20031**](inline_response_200_31.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetAcls - -> InlineResponse20030 GetAcls(ctx, parentName, parentType, optional) - -Return an array of all ACL lines - -Returns all ACL lines that are configured in specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***GetAclsOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetAclsOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20030**](inline_response_200_30.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetBackend - -> InlineResponse2007 GetBackend(ctx, name, optional) - -Return a backend - -Returns one backend configuration by it's name. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**name** | **string**| Backend name | - **optional** | ***GetBackendOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetBackendOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse2007**](inline_response_200_7.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetBackendSwitchingRule - -> InlineResponse20021 GetBackendSwitchingRule(ctx, id, frontend, optional) - -Return one Backend Switching Rule - -Returns one Backend Switching Rule configuration by it's ID in the specified frontend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Switching Rule ID | -**frontend** | **string**| Frontend name | - **optional** | ***GetBackendSwitchingRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetBackendSwitchingRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20021**](inline_response_200_21.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetBackendSwitchingRules - -> InlineResponse20020 GetBackendSwitchingRules(ctx, frontend, optional) - -Return an array of all Backend Switching Rules - -Returns all Backend Switching Rules that are configured in specified frontend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**frontend** | **string**| Frontend name | - **optional** | ***GetBackendSwitchingRulesOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetBackendSwitchingRulesOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20020**](inline_response_200_20.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetBackends - -> InlineResponse2006 GetBackends(ctx, optional) - -Return an array of backends - -Returns an array of all configured backends. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. - **optional** | ***GetBackendsOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetBackendsOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse2006**](inline_response_200_6.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetBind - -> InlineResponse2009 GetBind(ctx, name, frontend, optional) - -Return one bind - -Returns one bind configuration by it's name in the specified frontend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**name** | **string**| Bind name | -**frontend** | **string**| Parent frontend name | - **optional** | ***GetBindOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetBindOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse2009**](inline_response_200_9.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetBinds - -> InlineResponse2008 GetBinds(ctx, frontend, optional) - -Return an array of binds - -Returns an array of all binds that are configured in specified frontend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**frontend** | **string**| Parent frontend name | - **optional** | ***GetBindsOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetBindsOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse2008**](inline_response_200_8.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetDefaults - -> InlineResponse2003 GetDefaults(ctx, optional) - -Return defaults part of configuration - -Returns defaults part of configuration. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. - **optional** | ***GetDefaultsOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetDefaultsOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse2003**](inline_response_200_3.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetFilter - -> InlineResponse20025 GetFilter(ctx, id, parentName, parentType, optional) - -Return one Filter - -Returns one Filter configuration by it's ID in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Filter ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***GetFilterOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetFilterOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20025**](inline_response_200_25.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetFilters - -> InlineResponse20024 GetFilters(ctx, parentName, parentType, optional) - -Return an array of all Filters - -Returns all Filters that are configured in specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***GetFiltersOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetFiltersOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20024**](inline_response_200_24.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetFrontend - -> InlineResponse2005 GetFrontend(ctx, name, optional) - -Return a frontend - -Returns one frontend configuration by it's name. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**name** | **string**| Frontend name | - **optional** | ***GetFrontendOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetFrontendOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse2005**](inline_response_200_5.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetFrontends - -> InlineResponse2004 GetFrontends(ctx, optional) - -Return an array of frontends - -Returns an array of all configured frontends. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. - **optional** | ***GetFrontendsOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetFrontendsOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse2004**](inline_response_200_4.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetGlobal - -> InlineResponse2002 GetGlobal(ctx, optional) - -Return a global part of configuration - -Returns global part of configuration. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. - **optional** | ***GetGlobalOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetGlobalOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse2002**](inline_response_200_2.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetHAProxyConfiguration - -> InlineResponse20032 GetHAProxyConfiguration(ctx, optional) - -Return HAProxy configuration - -Returns HAProxy configuration file in plain text - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. - **optional** | ***GetHAProxyConfigurationOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetHAProxyConfigurationOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - -### Return type - -[**InlineResponse20032**](inline_response_200_32.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: text/plain, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetHTTPRequestRule - -> InlineResponse20013 GetHTTPRequestRule(ctx, id, parentName, parentType, optional) - -Return one HTTP Request Rule - -Returns one HTTP Request Rule configuration by it's ID in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| HTTP Request Rule ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***GetHTTPRequestRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetHTTPRequestRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20013**](inline_response_200_13.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetHTTPRequestRules - -> InlineResponse20012 GetHTTPRequestRules(ctx, parentName, parentType, optional) - -Return an array of all HTTP Request Rules - -Returns all HTTP Request Rules that are configured in specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***GetHTTPRequestRulesOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetHTTPRequestRulesOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20012**](inline_response_200_12.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetHTTPResponseRule - -> InlineResponse20015 GetHTTPResponseRule(ctx, id, parentName, parentType, optional) - -Return one HTTP Response Rule - -Returns one HTTP Response Rule configuration by it's ID in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| HTTP Response Rule ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***GetHTTPResponseRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetHTTPResponseRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20015**](inline_response_200_15.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetHTTPResponseRules - -> InlineResponse20014 GetHTTPResponseRules(ctx, parentName, parentType, optional) - -Return an array of all HTTP Response Rules - -Returns all HTTP Response Rules that are configured in specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***GetHTTPResponseRulesOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetHTTPResponseRulesOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20014**](inline_response_200_14.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetLogTarget - -> InlineResponse20029 GetLogTarget(ctx, id, parentName, parentType, optional) - -Return one Log Target - -Returns one Log Target configuration by it's ID in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Log Target ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***GetLogTargetOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetLogTargetOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20029**](inline_response_200_29.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetLogTargets - -> InlineResponse20028 GetLogTargets(ctx, parentName, parentType, optional) - -Return an array of all Log Targets - -Returns all Log Targets that are configured in specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***GetLogTargetsOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetLogTargetsOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20028**](inline_response_200_28.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetServer - -> InlineResponse20011 GetServer(ctx, name, backend, optional) - -Return one server - -Returns one server configuration by it's name in the specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**name** | **string**| Server name | -**backend** | **string**| Parent backend name | - **optional** | ***GetServerOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetServerOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20011**](inline_response_200_11.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetServerSwitchingRule - -> InlineResponse20023 GetServerSwitchingRule(ctx, id, backend, optional) - -Return one Server Switching Rule - -Returns one Server Switching Rule configuration by it's ID in the specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Switching Rule ID | -**backend** | **string**| Backend name | - **optional** | ***GetServerSwitchingRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetServerSwitchingRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20023**](inline_response_200_23.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetServerSwitchingRules - -> InlineResponse20022 GetServerSwitchingRules(ctx, backend, optional) - -Return an array of all Server Switching Rules - -Returns all Backend Switching Rules that are configured in specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**backend** | **string**| Backend name | - **optional** | ***GetServerSwitchingRulesOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetServerSwitchingRulesOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20022**](inline_response_200_22.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetServers - -> InlineResponse20010 GetServers(ctx, backend, optional) - -Return an array of servers - -Returns an array of all servers that are configured in specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**backend** | **string**| Parent backend name | - **optional** | ***GetServersOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetServersOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20010**](inline_response_200_10.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetStickRule - -> InlineResponse20027 GetStickRule(ctx, id, backend, optional) - -Return one Stick Rule - -Returns one Stick Rule configuration by it's ID in the specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Stick Rule ID | -**backend** | **string**| Backend name | - **optional** | ***GetStickRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetStickRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20027**](inline_response_200_27.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetStickRules - -> InlineResponse20026 GetStickRules(ctx, backend, optional) - -Return an array of all Stick Rules - -Returns all Stick Rules that are configured in specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**backend** | **string**| Backend name | - **optional** | ***GetStickRulesOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetStickRulesOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20026**](inline_response_200_26.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetTCPRequestRule - -> InlineResponse20017 GetTCPRequestRule(ctx, id, parentName, parentType, optional) - -Return one TCP Request Rule - -Returns one TCP Request Rule configuration by it's ID in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| TCP Request Rule ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***GetTCPRequestRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetTCPRequestRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20017**](inline_response_200_17.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetTCPRequestRules - -> InlineResponse20016 GetTCPRequestRules(ctx, parentName, parentType, optional) - -Return an array of all TCP Request Rules - -Returns all TCP Request Rules that are configured in specified parent and parent type. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***GetTCPRequestRulesOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetTCPRequestRulesOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20016**](inline_response_200_16.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetTCPResponseRule - -> InlineResponse20019 GetTCPResponseRule(ctx, id, backend, optional) - -Return one TCP Response Rule - -Returns one TCP Response Rule configuration by it's ID in the specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| TCP Response Rule ID | -**backend** | **string**| Parent backend name | - **optional** | ***GetTCPResponseRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetTCPResponseRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20019**](inline_response_200_19.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetTCPResponseRules - -> InlineResponse20018 GetTCPResponseRules(ctx, backend, optional) - -Return an array of all TCP Response Rules - -Returns all TCP Response Rules that are configured in specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**backend** | **string**| Parent backend name | - **optional** | ***GetTCPResponseRulesOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetTCPResponseRulesOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20018**](inline_response_200_18.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## PostHAProxyConfiguration - -> string PostHAProxyConfiguration(ctx, body, optional) - -Push new haproxy configuration - -Push a new haproxy configuration file in plain text - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**body** | **string**| | - **optional** | ***PostHAProxyConfigurationOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a PostHAProxyConfigurationOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -**string** - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: text/plain -- **Accept**: text/plain, application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceAcl - -> Acl ReplaceAcl(ctx, id, parentName, parentType, acl, optional) - -Replace a ACL line - -Replaces a ACL line configuration by it's ID in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| ACL line ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | -**acl** | [**Acl**](Acl.md)| | - **optional** | ***ReplaceAclOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceAclOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**Acl**](acl.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceBackend - -> Backend ReplaceBackend(ctx, name, backend, optional) - -Replace a backend - -Replaces a backend configuration by it's name. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**name** | **string**| Backend name | -**backend** | [**Backend**](Backend.md)| | - **optional** | ***ReplaceBackendOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceBackendOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**Backend**](backend.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceBackendSwitchingRule - -> BackendSwitchingRule ReplaceBackendSwitchingRule(ctx, id, frontend, backendSwitchingRule, optional) - -Replace a Backend Switching Rule - -Replaces a Backend Switching Rule configuration by it's ID in the specified frontend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Switching Rule ID | -**frontend** | **string**| Frontend name | -**backendSwitchingRule** | [**BackendSwitchingRule**](BackendSwitchingRule.md)| | - **optional** | ***ReplaceBackendSwitchingRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceBackendSwitchingRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**BackendSwitchingRule**](backend_switching_rule.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceBind - -> Bind ReplaceBind(ctx, name, frontend, bind, optional) - -Replace a bind - -Replaces a bind configuration by it's name in the specified frontend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**name** | **string**| Bind name | -**frontend** | **string**| Parent frontend name | -**bind** | [**Bind**](Bind.md)| | - **optional** | ***ReplaceBindOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceBindOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**Bind**](bind.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceDefaults - -> Defaults ReplaceDefaults(ctx, defaults, optional) - -Replace defaults - -Replace defaults part of config - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**defaults** | [**Defaults**](Defaults.md)| | - **optional** | ***ReplaceDefaultsOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceDefaultsOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**Defaults**](defaults.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceFilter - -> Filter ReplaceFilter(ctx, id, parentName, parentType, filter, optional) - -Replace a Filter - -Replaces a Filter configuration by it's ID in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Filter ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | -**filter** | [**Filter**](Filter.md)| | - **optional** | ***ReplaceFilterOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceFilterOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**Filter**](filter.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceFrontend - -> Frontend ReplaceFrontend(ctx, name, frontend, optional) - -Replace a frontend - -Replaces a frontend configuration by it's name. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**name** | **string**| Frontend name | -**frontend** | [**Frontend**](Frontend.md)| | - **optional** | ***ReplaceFrontendOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceFrontendOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**Frontend**](frontend.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceGlobal - -> Global ReplaceGlobal(ctx, global, optional) - -Replace global - -Replace global part of config - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**global** | [**Global**](Global.md)| | - **optional** | ***ReplaceGlobalOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceGlobalOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**Global**](global.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceHTTPRequestRule - -> HttpRequestRule ReplaceHTTPRequestRule(ctx, id, parentName, parentType, httpRequestRule, optional) - -Replace a HTTP Request Rule - -Replaces a HTTP Request Rule configuration by it's ID in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| HTTP Request Rule ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | -**httpRequestRule** | [**HttpRequestRule**](HttpRequestRule.md)| | - **optional** | ***ReplaceHTTPRequestRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceHTTPRequestRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**HttpRequestRule**](http_request_rule.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceHTTPResponseRule - -> HttpResponseRule ReplaceHTTPResponseRule(ctx, id, parentName, parentType, httpResponseRule, optional) - -Replace a HTTP Response Rule - -Replaces a HTTP Response Rule configuration by it's ID in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| HTTP Response Rule ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | -**httpResponseRule** | [**HttpResponseRule**](HttpResponseRule.md)| | - **optional** | ***ReplaceHTTPResponseRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceHTTPResponseRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**HttpResponseRule**](http_response_rule.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceLogTarget - -> LogTarget ReplaceLogTarget(ctx, id, parentName, parentType, logTarget, optional) - -Replace a Log Target - -Replaces a Log Target configuration by it's ID in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Log Target ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | -**logTarget** | [**LogTarget**](LogTarget.md)| | - **optional** | ***ReplaceLogTargetOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceLogTargetOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**LogTarget**](log_target.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceServer - -> Server ReplaceServer(ctx, name, backend, server, optional) - -Replace a server - -Replaces a server configuration by it's name in the specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**name** | **string**| Server name | -**backend** | **string**| Parent backend name | -**server** | [**Server**](Server.md)| | - **optional** | ***ReplaceServerOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceServerOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**Server**](server.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceServerSwitchingRule - -> ServerSwitchingRule ReplaceServerSwitchingRule(ctx, id, backend, serverSwitchingRule, optional) - -Replace a Server Switching Rule - -Replaces a Server Switching Rule configuration by it's ID in the specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Switching Rule ID | -**backend** | **string**| Backend name | -**serverSwitchingRule** | [**ServerSwitchingRule**](ServerSwitchingRule.md)| | - **optional** | ***ReplaceServerSwitchingRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceServerSwitchingRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**ServerSwitchingRule**](server_switching_rule.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceStickRule - -> StickRule ReplaceStickRule(ctx, id, backend, stickRule, optional) - -Replace a Stick Rule - -Replaces a Stick Rule configuration by it's ID in the specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Stick Rule ID | -**backend** | **string**| Backend name | -**stickRule** | [**StickRule**](StickRule.md)| | - **optional** | ***ReplaceStickRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceStickRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**StickRule**](stick_rule.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceTCPRequestRule - -> TcpRequestRule ReplaceTCPRequestRule(ctx, id, parentName, parentType, tcpRequestRule, optional) - -Replace a TCP Request Rule - -Replaces a TCP Request Rule configuration by it's ID in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| TCP Request Rule ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | -**tcpRequestRule** | [**TcpRequestRule**](TcpRequestRule.md)| | - **optional** | ***ReplaceTCPRequestRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceTCPRequestRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**TcpRequestRule**](tcp_request_rule.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceTCPResponseRule - -> TcpResponseRule ReplaceTCPResponseRule(ctx, id, backend, tcpResponseRule, optional) - -Replace a TCP Response Rule - -Replaces a TCP Response Rule configuration by it's ID in the specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| TCP Response Rule ID | -**backend** | **string**| Parent backend name | -**tcpResponseRule** | [**TcpResponseRule**](TcpResponseRule.md)| | - **optional** | ***ReplaceTCPResponseRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceTCPResponseRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**TcpResponseRule**](tcp_response_rule.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - diff --git a/contrib/haproxy/openapi/docs/HTTPRequestRuleApi.md b/contrib/haproxy/openapi/docs/HTTPRequestRuleApi.md deleted file mode 100644 index f9fef0d790..0000000000 --- a/contrib/haproxy/openapi/docs/HTTPRequestRuleApi.md +++ /dev/null @@ -1,264 +0,0 @@ -# \HTTPRequestRuleApi - -All URIs are relative to *http://localhost/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**CreateHTTPRequestRule**](HTTPRequestRuleApi.md#CreateHTTPRequestRule) | **Post** /services/haproxy/configuration/http_request_rules | Add a new HTTP Request Rule -[**DeleteHTTPRequestRule**](HTTPRequestRuleApi.md#DeleteHTTPRequestRule) | **Delete** /services/haproxy/configuration/http_request_rules/{id} | Delete a HTTP Request Rule -[**GetHTTPRequestRule**](HTTPRequestRuleApi.md#GetHTTPRequestRule) | **Get** /services/haproxy/configuration/http_request_rules/{id} | Return one HTTP Request Rule -[**GetHTTPRequestRules**](HTTPRequestRuleApi.md#GetHTTPRequestRules) | **Get** /services/haproxy/configuration/http_request_rules | Return an array of all HTTP Request Rules -[**ReplaceHTTPRequestRule**](HTTPRequestRuleApi.md#ReplaceHTTPRequestRule) | **Put** /services/haproxy/configuration/http_request_rules/{id} | Replace a HTTP Request Rule - - - -## CreateHTTPRequestRule - -> HttpRequestRule CreateHTTPRequestRule(ctx, parentName, parentType, httpRequestRule, optional) - -Add a new HTTP Request Rule - -Adds a new HTTP Request Rule of the specified type in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | -**httpRequestRule** | [**HttpRequestRule**](HttpRequestRule.md)| | - **optional** | ***CreateHTTPRequestRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a CreateHTTPRequestRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**HttpRequestRule**](http_request_rule.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DeleteHTTPRequestRule - -> DeleteHTTPRequestRule(ctx, id, parentName, parentType, optional) - -Delete a HTTP Request Rule - -Deletes a HTTP Request Rule configuration by it's ID from the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| HTTP Request Rule ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***DeleteHTTPRequestRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a DeleteHTTPRequestRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - - (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetHTTPRequestRule - -> InlineResponse20013 GetHTTPRequestRule(ctx, id, parentName, parentType, optional) - -Return one HTTP Request Rule - -Returns one HTTP Request Rule configuration by it's ID in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| HTTP Request Rule ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***GetHTTPRequestRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetHTTPRequestRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20013**](inline_response_200_13.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetHTTPRequestRules - -> InlineResponse20012 GetHTTPRequestRules(ctx, parentName, parentType, optional) - -Return an array of all HTTP Request Rules - -Returns all HTTP Request Rules that are configured in specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***GetHTTPRequestRulesOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetHTTPRequestRulesOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20012**](inline_response_200_12.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceHTTPRequestRule - -> HttpRequestRule ReplaceHTTPRequestRule(ctx, id, parentName, parentType, httpRequestRule, optional) - -Replace a HTTP Request Rule - -Replaces a HTTP Request Rule configuration by it's ID in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| HTTP Request Rule ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | -**httpRequestRule** | [**HttpRequestRule**](HttpRequestRule.md)| | - **optional** | ***ReplaceHTTPRequestRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceHTTPRequestRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**HttpRequestRule**](http_request_rule.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - diff --git a/contrib/haproxy/openapi/docs/HTTPResponseRuleApi.md b/contrib/haproxy/openapi/docs/HTTPResponseRuleApi.md deleted file mode 100644 index 992dee919a..0000000000 --- a/contrib/haproxy/openapi/docs/HTTPResponseRuleApi.md +++ /dev/null @@ -1,264 +0,0 @@ -# \HTTPResponseRuleApi - -All URIs are relative to *http://localhost/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**CreateHTTPResponseRule**](HTTPResponseRuleApi.md#CreateHTTPResponseRule) | **Post** /services/haproxy/configuration/http_response_rules | Add a new HTTP Response Rule -[**DeleteHTTPResponseRule**](HTTPResponseRuleApi.md#DeleteHTTPResponseRule) | **Delete** /services/haproxy/configuration/http_response_rules/{id} | Delete a HTTP Response Rule -[**GetHTTPResponseRule**](HTTPResponseRuleApi.md#GetHTTPResponseRule) | **Get** /services/haproxy/configuration/http_response_rules/{id} | Return one HTTP Response Rule -[**GetHTTPResponseRules**](HTTPResponseRuleApi.md#GetHTTPResponseRules) | **Get** /services/haproxy/configuration/http_response_rules | Return an array of all HTTP Response Rules -[**ReplaceHTTPResponseRule**](HTTPResponseRuleApi.md#ReplaceHTTPResponseRule) | **Put** /services/haproxy/configuration/http_response_rules/{id} | Replace a HTTP Response Rule - - - -## CreateHTTPResponseRule - -> HttpResponseRule CreateHTTPResponseRule(ctx, parentName, parentType, httpResponseRule, optional) - -Add a new HTTP Response Rule - -Adds a new HTTP Response Rule of the specified type in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | -**httpResponseRule** | [**HttpResponseRule**](HttpResponseRule.md)| | - **optional** | ***CreateHTTPResponseRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a CreateHTTPResponseRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**HttpResponseRule**](http_response_rule.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DeleteHTTPResponseRule - -> DeleteHTTPResponseRule(ctx, id, parentName, parentType, optional) - -Delete a HTTP Response Rule - -Deletes a HTTP Response Rule configuration by it's ID from the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| HTTP Response Rule ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***DeleteHTTPResponseRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a DeleteHTTPResponseRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - - (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetHTTPResponseRule - -> InlineResponse20015 GetHTTPResponseRule(ctx, id, parentName, parentType, optional) - -Return one HTTP Response Rule - -Returns one HTTP Response Rule configuration by it's ID in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| HTTP Response Rule ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***GetHTTPResponseRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetHTTPResponseRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20015**](inline_response_200_15.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetHTTPResponseRules - -> InlineResponse20014 GetHTTPResponseRules(ctx, parentName, parentType, optional) - -Return an array of all HTTP Response Rules - -Returns all HTTP Response Rules that are configured in specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***GetHTTPResponseRulesOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetHTTPResponseRulesOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20014**](inline_response_200_14.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceHTTPResponseRule - -> HttpResponseRule ReplaceHTTPResponseRule(ctx, id, parentName, parentType, httpResponseRule, optional) - -Replace a HTTP Response Rule - -Replaces a HTTP Response Rule configuration by it's ID in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| HTTP Response Rule ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | -**httpResponseRule** | [**HttpResponseRule**](HttpResponseRule.md)| | - **optional** | ***ReplaceHTTPResponseRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceHTTPResponseRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**HttpResponseRule**](http_response_rule.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - diff --git a/contrib/haproxy/openapi/docs/HttpRequestRule.md b/contrib/haproxy/openapi/docs/HttpRequestRule.md deleted file mode 100644 index 1e48823c2b..0000000000 --- a/contrib/haproxy/openapi/docs/HttpRequestRule.md +++ /dev/null @@ -1,33 +0,0 @@ -# HttpRequestRule - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AclFile** | **string** | | [optional] -**AclKeyfmt** | **string** | | [optional] -**AuthRealm** | **string** | | [optional] -**Cond** | **string** | | [optional] -**CondTest** | **string** | | [optional] -**DenyStatus** | **int32** | | [optional] -**HdrFormat** | **string** | | [optional] -**HdrMatch** | **string** | | [optional] -**HdrName** | **string** | | [optional] -**Id** | Pointer to **int32** | | -**LogLevel** | **string** | | [optional] -**QueryFmt** | **string** | | [optional] -**RedirCode** | **int32** | | [optional] -**RedirOption** | **string** | | [optional] -**RedirType** | **string** | | [optional] -**RedirValue** | **string** | | [optional] -**SpoeEngine** | **string** | | [optional] -**SpoeGroup** | **string** | | [optional] -**Type** | **string** | | -**UriFmt** | **string** | | [optional] -**VarExpr** | **string** | | [optional] -**VarName** | **string** | | [optional] -**VarScope** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/HttpResponseRule.md b/contrib/haproxy/openapi/docs/HttpResponseRule.md deleted file mode 100644 index 49378538a2..0000000000 --- a/contrib/haproxy/openapi/docs/HttpResponseRule.md +++ /dev/null @@ -1,31 +0,0 @@ -# HttpResponseRule - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**AclFile** | **string** | | [optional] -**AclKeyfmt** | **string** | | [optional] -**Cond** | **string** | | [optional] -**CondTest** | **string** | | [optional] -**HdrFormat** | **string** | | [optional] -**HdrMatch** | **string** | | [optional] -**HdrName** | **string** | | [optional] -**Id** | Pointer to **int32** | | -**LogLevel** | **string** | | [optional] -**RedirCode** | **int32** | | [optional] -**RedirOption** | **string** | | [optional] -**RedirType** | **string** | | [optional] -**RedirValue** | **string** | | [optional] -**SpoeEngine** | **string** | | [optional] -**SpoeGroup** | **string** | | [optional] -**Status** | **int32** | | [optional] -**StatusReason** | **string** | | [optional] -**Type** | **string** | | -**VarExpr** | **string** | | [optional] -**VarName** | **string** | | [optional] -**VarScope** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/Httpchk.md b/contrib/haproxy/openapi/docs/Httpchk.md deleted file mode 100644 index 105c39781a..0000000000 --- a/contrib/haproxy/openapi/docs/Httpchk.md +++ /dev/null @@ -1,13 +0,0 @@ -# Httpchk - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Method** | **string** | | [optional] -**Uri** | **string** | | [optional] -**Version** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/Info.md b/contrib/haproxy/openapi/docs/Info.md deleted file mode 100644 index a466b14ebb..0000000000 --- a/contrib/haproxy/openapi/docs/Info.md +++ /dev/null @@ -1,12 +0,0 @@ -# Info - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Api** | [**InfoApi**](info_api.md) | | [optional] -**System** | [**InfoSystem**](info_system.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/InfoApi.md b/contrib/haproxy/openapi/docs/InfoApi.md deleted file mode 100644 index 3f097f8eac..0000000000 --- a/contrib/haproxy/openapi/docs/InfoApi.md +++ /dev/null @@ -1,12 +0,0 @@ -# InfoApi - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**BuildDate** | [**time.Time**](time.Time.md) | HAProxy Dataplane API build date | [optional] -**Version** | **string** | HAProxy Dataplane API version string | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/InfoSystem.md b/contrib/haproxy/openapi/docs/InfoSystem.md deleted file mode 100644 index 4036632b1a..0000000000 --- a/contrib/haproxy/openapi/docs/InfoSystem.md +++ /dev/null @@ -1,16 +0,0 @@ -# InfoSystem - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**CpuInfo** | [**InfoSystemCpuInfo**](info_system_cpu_info.md) | | [optional] -**Hostname** | **string** | Hostname where the HAProxy is running | [optional] -**MemInfo** | [**InfoSystemMemInfo**](info_system_mem_info.md) | | [optional] -**OsString** | **string** | OS string | [optional] -**Time** | **int32** | Current time in milliseconds since Epoch. | [optional] -**Uptime** | Pointer to **int32** | System uptime | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/InfoSystemCpuInfo.md b/contrib/haproxy/openapi/docs/InfoSystemCpuInfo.md deleted file mode 100644 index 93913a73c5..0000000000 --- a/contrib/haproxy/openapi/docs/InfoSystemCpuInfo.md +++ /dev/null @@ -1,12 +0,0 @@ -# InfoSystemCpuInfo - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Model** | **string** | | [optional] -**NumCpus** | **int32** | Number of logical CPUs | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/InfoSystemMemInfo.md b/contrib/haproxy/openapi/docs/InfoSystemMemInfo.md deleted file mode 100644 index 61537210b1..0000000000 --- a/contrib/haproxy/openapi/docs/InfoSystemMemInfo.md +++ /dev/null @@ -1,13 +0,0 @@ -# InfoSystemMemInfo - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**DataplaneapiMemory** | **int32** | | [optional] -**FreeMemory** | **int32** | | [optional] -**TotalMemory** | **int32** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/InformationApi.md b/contrib/haproxy/openapi/docs/InformationApi.md deleted file mode 100644 index 6478d1494f..0000000000 --- a/contrib/haproxy/openapi/docs/InformationApi.md +++ /dev/null @@ -1,70 +0,0 @@ -# \InformationApi - -All URIs are relative to *http://localhost/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**GetHaproxyProcessInfo**](InformationApi.md#GetHaproxyProcessInfo) | **Get** /services/haproxy/info | Return HAProxy process information -[**GetInfo**](InformationApi.md#GetInfo) | **Get** /info | Return API, hardware and OS information - - - -## GetHaproxyProcessInfo - -> ProcessInfo GetHaproxyProcessInfo(ctx, ) - -Return HAProxy process information - -Return HAProxy process information - -### Required Parameters - -This endpoint does not need any parameter. - -### Return type - -[**ProcessInfo**](process_info.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetInfo - -> Info GetInfo(ctx, ) - -Return API, hardware and OS information - -Return API, hardware and OS information - -### Required Parameters - -This endpoint does not need any parameter. - -### Return type - -[**Info**](info.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - diff --git a/contrib/haproxy/openapi/docs/InlineResponse200.md b/contrib/haproxy/openapi/docs/InlineResponse200.md deleted file mode 100644 index c35778cb02..0000000000 --- a/contrib/haproxy/openapi/docs/InlineResponse200.md +++ /dev/null @@ -1,12 +0,0 @@ -# InlineResponse200 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Version** | **int32** | | [optional] -**Data** | [**[]Site**](site.md) | Sites array. Sites are considered as one service and all farms connected to that service. Farms are connected to service using use-backend and default_backend directives. Sites let you configure simple HAProxy configurations, for more advanced options use /haproxy/configuration endpoints. | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/InlineResponse2001.md b/contrib/haproxy/openapi/docs/InlineResponse2001.md deleted file mode 100644 index f11b310fd0..0000000000 --- a/contrib/haproxy/openapi/docs/InlineResponse2001.md +++ /dev/null @@ -1,12 +0,0 @@ -# InlineResponse2001 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Version** | **int32** | | [optional] -**Data** | [**Site**](site.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/InlineResponse20010.md b/contrib/haproxy/openapi/docs/InlineResponse20010.md deleted file mode 100644 index 5f11d6a143..0000000000 --- a/contrib/haproxy/openapi/docs/InlineResponse20010.md +++ /dev/null @@ -1,12 +0,0 @@ -# InlineResponse20010 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Version** | **int32** | | [optional] -**Data** | [**[]Server**](server.md) | HAProxy backend servers array | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/InlineResponse20011.md b/contrib/haproxy/openapi/docs/InlineResponse20011.md deleted file mode 100644 index aedd274721..0000000000 --- a/contrib/haproxy/openapi/docs/InlineResponse20011.md +++ /dev/null @@ -1,12 +0,0 @@ -# InlineResponse20011 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Version** | **int32** | | [optional] -**Data** | [**Server**](server.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/InlineResponse20012.md b/contrib/haproxy/openapi/docs/InlineResponse20012.md deleted file mode 100644 index 60b32b8dd4..0000000000 --- a/contrib/haproxy/openapi/docs/InlineResponse20012.md +++ /dev/null @@ -1,12 +0,0 @@ -# InlineResponse20012 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Version** | **int32** | | [optional] -**Data** | [**[]HttpRequestRule**](http_request_rule.md) | HAProxy HTTP request rules array (corresponds to http-request directives) | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/InlineResponse20013.md b/contrib/haproxy/openapi/docs/InlineResponse20013.md deleted file mode 100644 index ddd7e40d77..0000000000 --- a/contrib/haproxy/openapi/docs/InlineResponse20013.md +++ /dev/null @@ -1,12 +0,0 @@ -# InlineResponse20013 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Version** | **int32** | | [optional] -**Data** | [**HttpRequestRule**](http_request_rule.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/InlineResponse20014.md b/contrib/haproxy/openapi/docs/InlineResponse20014.md deleted file mode 100644 index dba593802d..0000000000 --- a/contrib/haproxy/openapi/docs/InlineResponse20014.md +++ /dev/null @@ -1,12 +0,0 @@ -# InlineResponse20014 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Version** | **int32** | | [optional] -**Data** | [**[]HttpResponseRule**](http_response_rule.md) | HAProxy HTTP response rules array (corresponds to http-response directives) | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/InlineResponse20015.md b/contrib/haproxy/openapi/docs/InlineResponse20015.md deleted file mode 100644 index 4276eec772..0000000000 --- a/contrib/haproxy/openapi/docs/InlineResponse20015.md +++ /dev/null @@ -1,12 +0,0 @@ -# InlineResponse20015 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Version** | **int32** | | [optional] -**Data** | [**HttpResponseRule**](http_response_rule.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/InlineResponse20016.md b/contrib/haproxy/openapi/docs/InlineResponse20016.md deleted file mode 100644 index de0cd4d94d..0000000000 --- a/contrib/haproxy/openapi/docs/InlineResponse20016.md +++ /dev/null @@ -1,12 +0,0 @@ -# InlineResponse20016 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Version** | **int32** | | [optional] -**Data** | [**[]TcpRequestRule**](tcp_request_rule.md) | HAProxy TCP request rules array (corresponds to tcp-request directive) | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/InlineResponse20017.md b/contrib/haproxy/openapi/docs/InlineResponse20017.md deleted file mode 100644 index 06b5fb01cf..0000000000 --- a/contrib/haproxy/openapi/docs/InlineResponse20017.md +++ /dev/null @@ -1,12 +0,0 @@ -# InlineResponse20017 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Version** | **int32** | | [optional] -**Data** | [**TcpRequestRule**](tcp_request_rule.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/InlineResponse20018.md b/contrib/haproxy/openapi/docs/InlineResponse20018.md deleted file mode 100644 index 5dd7dc1947..0000000000 --- a/contrib/haproxy/openapi/docs/InlineResponse20018.md +++ /dev/null @@ -1,12 +0,0 @@ -# InlineResponse20018 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Version** | **int32** | | [optional] -**Data** | [**[]TcpResponseRule**](tcp_response_rule.md) | HAProxy TCP response rules array (corresponds to tcp-response directive) | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/InlineResponse20019.md b/contrib/haproxy/openapi/docs/InlineResponse20019.md deleted file mode 100644 index e888e5681e..0000000000 --- a/contrib/haproxy/openapi/docs/InlineResponse20019.md +++ /dev/null @@ -1,12 +0,0 @@ -# InlineResponse20019 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Version** | **int32** | | [optional] -**Data** | [**TcpResponseRule**](tcp_response_rule.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/InlineResponse2002.md b/contrib/haproxy/openapi/docs/InlineResponse2002.md deleted file mode 100644 index d1f0a3bf8a..0000000000 --- a/contrib/haproxy/openapi/docs/InlineResponse2002.md +++ /dev/null @@ -1,12 +0,0 @@ -# InlineResponse2002 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Version** | **int32** | | [optional] -**Data** | [**Global**](global.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/InlineResponse20020.md b/contrib/haproxy/openapi/docs/InlineResponse20020.md deleted file mode 100644 index 79b51b21aa..0000000000 --- a/contrib/haproxy/openapi/docs/InlineResponse20020.md +++ /dev/null @@ -1,12 +0,0 @@ -# InlineResponse20020 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Version** | **int32** | | [optional] -**Data** | [**[]BackendSwitchingRule**](backend_switching_rule.md) | HAProxy backend switching rules array (corresponds to use_backend directives) | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/InlineResponse20021.md b/contrib/haproxy/openapi/docs/InlineResponse20021.md deleted file mode 100644 index 00c64830ac..0000000000 --- a/contrib/haproxy/openapi/docs/InlineResponse20021.md +++ /dev/null @@ -1,12 +0,0 @@ -# InlineResponse20021 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Version** | **int32** | | [optional] -**Data** | [**BackendSwitchingRule**](backend_switching_rule.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/InlineResponse20022.md b/contrib/haproxy/openapi/docs/InlineResponse20022.md deleted file mode 100644 index 5a23a629bb..0000000000 --- a/contrib/haproxy/openapi/docs/InlineResponse20022.md +++ /dev/null @@ -1,12 +0,0 @@ -# InlineResponse20022 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Version** | **int32** | | [optional] -**Data** | [**[]ServerSwitchingRule**](server_switching_rule.md) | HAProxy backend server switching rules array (corresponds to use-server directives) | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/InlineResponse20023.md b/contrib/haproxy/openapi/docs/InlineResponse20023.md deleted file mode 100644 index 6b01ec22e2..0000000000 --- a/contrib/haproxy/openapi/docs/InlineResponse20023.md +++ /dev/null @@ -1,12 +0,0 @@ -# InlineResponse20023 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Version** | **int32** | | [optional] -**Data** | [**ServerSwitchingRule**](server_switching_rule.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/InlineResponse20024.md b/contrib/haproxy/openapi/docs/InlineResponse20024.md deleted file mode 100644 index d68c704e86..0000000000 --- a/contrib/haproxy/openapi/docs/InlineResponse20024.md +++ /dev/null @@ -1,12 +0,0 @@ -# InlineResponse20024 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Version** | **int32** | | [optional] -**Data** | [**[]Filter**](filter.md) | HAProxy filters array (corresponds to filter directive) | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/InlineResponse20025.md b/contrib/haproxy/openapi/docs/InlineResponse20025.md deleted file mode 100644 index 6b3d6929a1..0000000000 --- a/contrib/haproxy/openapi/docs/InlineResponse20025.md +++ /dev/null @@ -1,12 +0,0 @@ -# InlineResponse20025 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Version** | **int32** | | [optional] -**Data** | [**Filter**](filter.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/InlineResponse20026.md b/contrib/haproxy/openapi/docs/InlineResponse20026.md deleted file mode 100644 index 3a1a13a2e5..0000000000 --- a/contrib/haproxy/openapi/docs/InlineResponse20026.md +++ /dev/null @@ -1,12 +0,0 @@ -# InlineResponse20026 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Version** | **int32** | | [optional] -**Data** | [**[]StickRule**](stick_rule.md) | HAProxy backend stick rules array (corresponds to stick store-request, stick match, stick on, stick store-response) | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/InlineResponse20027.md b/contrib/haproxy/openapi/docs/InlineResponse20027.md deleted file mode 100644 index c6c201448f..0000000000 --- a/contrib/haproxy/openapi/docs/InlineResponse20027.md +++ /dev/null @@ -1,12 +0,0 @@ -# InlineResponse20027 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Version** | **int32** | | [optional] -**Data** | [**StickRule**](stick_rule.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/InlineResponse20028.md b/contrib/haproxy/openapi/docs/InlineResponse20028.md deleted file mode 100644 index 24b6b74781..0000000000 --- a/contrib/haproxy/openapi/docs/InlineResponse20028.md +++ /dev/null @@ -1,12 +0,0 @@ -# InlineResponse20028 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Version** | **int32** | | [optional] -**Data** | [**[]LogTarget**](log_target.md) | HAProxy log target array (corresponds to log directives) | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/InlineResponse20029.md b/contrib/haproxy/openapi/docs/InlineResponse20029.md deleted file mode 100644 index 90e40421cd..0000000000 --- a/contrib/haproxy/openapi/docs/InlineResponse20029.md +++ /dev/null @@ -1,12 +0,0 @@ -# InlineResponse20029 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Version** | **int32** | | [optional] -**Data** | [**LogTarget**](log_target.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/InlineResponse2003.md b/contrib/haproxy/openapi/docs/InlineResponse2003.md deleted file mode 100644 index 645c72840c..0000000000 --- a/contrib/haproxy/openapi/docs/InlineResponse2003.md +++ /dev/null @@ -1,12 +0,0 @@ -# InlineResponse2003 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Version** | **int32** | | [optional] -**Data** | [**Defaults**](defaults.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/InlineResponse20030.md b/contrib/haproxy/openapi/docs/InlineResponse20030.md deleted file mode 100644 index 6502d1419f..0000000000 --- a/contrib/haproxy/openapi/docs/InlineResponse20030.md +++ /dev/null @@ -1,12 +0,0 @@ -# InlineResponse20030 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Version** | **int32** | | [optional] -**Data** | [**[]Acl**](acl.md) | HAProxy ACL lines array (corresponds to acl directives) | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/InlineResponse20031.md b/contrib/haproxy/openapi/docs/InlineResponse20031.md deleted file mode 100644 index 484e62c49c..0000000000 --- a/contrib/haproxy/openapi/docs/InlineResponse20031.md +++ /dev/null @@ -1,12 +0,0 @@ -# InlineResponse20031 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Version** | **int32** | | [optional] -**Data** | [**Acl**](acl.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/InlineResponse20032.md b/contrib/haproxy/openapi/docs/InlineResponse20032.md deleted file mode 100644 index 8a23cf3810..0000000000 --- a/contrib/haproxy/openapi/docs/InlineResponse20032.md +++ /dev/null @@ -1,12 +0,0 @@ -# InlineResponse20032 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Version** | **int32** | | [optional] -**Data** | **string** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/InlineResponse2004.md b/contrib/haproxy/openapi/docs/InlineResponse2004.md deleted file mode 100644 index a5811081eb..0000000000 --- a/contrib/haproxy/openapi/docs/InlineResponse2004.md +++ /dev/null @@ -1,12 +0,0 @@ -# InlineResponse2004 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Version** | **int32** | | [optional] -**Data** | [**[]Frontend**](frontend.md) | HAProxy frontends array | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/InlineResponse2005.md b/contrib/haproxy/openapi/docs/InlineResponse2005.md deleted file mode 100644 index 476f53be54..0000000000 --- a/contrib/haproxy/openapi/docs/InlineResponse2005.md +++ /dev/null @@ -1,12 +0,0 @@ -# InlineResponse2005 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Version** | **int32** | | [optional] -**Data** | [**Frontend**](frontend.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/InlineResponse2006.md b/contrib/haproxy/openapi/docs/InlineResponse2006.md deleted file mode 100644 index c91a70e264..0000000000 --- a/contrib/haproxy/openapi/docs/InlineResponse2006.md +++ /dev/null @@ -1,12 +0,0 @@ -# InlineResponse2006 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Version** | **int32** | | [optional] -**Data** | [**[]Backend**](backend.md) | HAProxy backends array | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/InlineResponse2007.md b/contrib/haproxy/openapi/docs/InlineResponse2007.md deleted file mode 100644 index 37e7051495..0000000000 --- a/contrib/haproxy/openapi/docs/InlineResponse2007.md +++ /dev/null @@ -1,12 +0,0 @@ -# InlineResponse2007 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Version** | **int32** | | [optional] -**Data** | [**Backend**](backend.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/InlineResponse2008.md b/contrib/haproxy/openapi/docs/InlineResponse2008.md deleted file mode 100644 index b37bd9705f..0000000000 --- a/contrib/haproxy/openapi/docs/InlineResponse2008.md +++ /dev/null @@ -1,12 +0,0 @@ -# InlineResponse2008 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Version** | **int32** | | [optional] -**Data** | [**[]Bind**](bind.md) | HAProxy frontend binds array (corresponds to bind directives) | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/InlineResponse2009.md b/contrib/haproxy/openapi/docs/InlineResponse2009.md deleted file mode 100644 index 969ebe84bd..0000000000 --- a/contrib/haproxy/openapi/docs/InlineResponse2009.md +++ /dev/null @@ -1,12 +0,0 @@ -# InlineResponse2009 - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Version** | **int32** | | [optional] -**Data** | [**Bind**](bind.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/LogTarget.md b/contrib/haproxy/openapi/docs/LogTarget.md deleted file mode 100644 index 840df46599..0000000000 --- a/contrib/haproxy/openapi/docs/LogTarget.md +++ /dev/null @@ -1,19 +0,0 @@ -# LogTarget - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Address** | **string** | | [optional] -**Facility** | **string** | | [optional] -**Format** | **string** | | [optional] -**Global** | **bool** | | [optional] -**Id** | Pointer to **int32** | | -**Length** | **int32** | | [optional] -**Level** | **string** | | [optional] -**Minlevel** | **string** | | [optional] -**Nolog** | **bool** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/LogTargetApi.md b/contrib/haproxy/openapi/docs/LogTargetApi.md deleted file mode 100644 index 7da0d4b52a..0000000000 --- a/contrib/haproxy/openapi/docs/LogTargetApi.md +++ /dev/null @@ -1,264 +0,0 @@ -# \LogTargetApi - -All URIs are relative to *http://localhost/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**CreateLogTarget**](LogTargetApi.md#CreateLogTarget) | **Post** /services/haproxy/configuration/log_targets | Add a new Log Target -[**DeleteLogTarget**](LogTargetApi.md#DeleteLogTarget) | **Delete** /services/haproxy/configuration/log_targets/{id} | Delete a Log Target -[**GetLogTarget**](LogTargetApi.md#GetLogTarget) | **Get** /services/haproxy/configuration/log_targets/{id} | Return one Log Target -[**GetLogTargets**](LogTargetApi.md#GetLogTargets) | **Get** /services/haproxy/configuration/log_targets | Return an array of all Log Targets -[**ReplaceLogTarget**](LogTargetApi.md#ReplaceLogTarget) | **Put** /services/haproxy/configuration/log_targets/{id} | Replace a Log Target - - - -## CreateLogTarget - -> LogTarget CreateLogTarget(ctx, parentName, parentType, logTarget, optional) - -Add a new Log Target - -Adds a new Log Target of the specified type in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | -**logTarget** | [**LogTarget**](LogTarget.md)| | - **optional** | ***CreateLogTargetOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a CreateLogTargetOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**LogTarget**](log_target.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DeleteLogTarget - -> DeleteLogTarget(ctx, id, parentName, parentType, optional) - -Delete a Log Target - -Deletes a Log Target configuration by it's ID from the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Log Target ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***DeleteLogTargetOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a DeleteLogTargetOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - - (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetLogTarget - -> InlineResponse20029 GetLogTarget(ctx, id, parentName, parentType, optional) - -Return one Log Target - -Returns one Log Target configuration by it's ID in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Log Target ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***GetLogTargetOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetLogTargetOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20029**](inline_response_200_29.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetLogTargets - -> InlineResponse20028 GetLogTargets(ctx, parentName, parentType, optional) - -Return an array of all Log Targets - -Returns all Log Targets that are configured in specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***GetLogTargetsOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetLogTargetsOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20028**](inline_response_200_28.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceLogTarget - -> LogTarget ReplaceLogTarget(ctx, id, parentName, parentType, logTarget, optional) - -Replace a Log Target - -Replaces a Log Target configuration by it's ID in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Log Target ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | -**logTarget** | [**LogTarget**](LogTarget.md)| | - **optional** | ***ReplaceLogTargetOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceLogTargetOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**LogTarget**](log_target.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - diff --git a/contrib/haproxy/openapi/docs/ModelError.md b/contrib/haproxy/openapi/docs/ModelError.md deleted file mode 100644 index 2843862152..0000000000 --- a/contrib/haproxy/openapi/docs/ModelError.md +++ /dev/null @@ -1,12 +0,0 @@ -# ModelError - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Code** | Pointer to **int32** | | -**Message** | Pointer to **string** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/NativeStat.md b/contrib/haproxy/openapi/docs/NativeStat.md deleted file mode 100644 index ab3803861a..0000000000 --- a/contrib/haproxy/openapi/docs/NativeStat.md +++ /dev/null @@ -1,14 +0,0 @@ -# NativeStat - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**BackendName** | **string** | | [optional] -**Name** | **string** | | [optional] -**Stats** | [**NativeStatStats**](native_stat_stats.md) | | [optional] -**Type** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/NativeStatStats.md b/contrib/haproxy/openapi/docs/NativeStatStats.md deleted file mode 100644 index 578f4a749c..0000000000 --- a/contrib/haproxy/openapi/docs/NativeStatStats.md +++ /dev/null @@ -1,88 +0,0 @@ -# NativeStatStats - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Act** | Pointer to **int32** | | [optional] -**Addr** | **string** | | [optional] -**AgentCode** | Pointer to **int32** | | [optional] -**AgentDesc** | **string** | | [optional] -**AgentDuration** | Pointer to **int32** | | [optional] -**AgentFall** | Pointer to **int32** | | [optional] -**AgentHealth** | Pointer to **int32** | | [optional] -**AgentRise** | Pointer to **int32** | | [optional] -**AgentStatus** | **string** | | [optional] -**Algo** | **string** | | [optional] -**Bck** | Pointer to **int32** | | [optional] -**Bin** | Pointer to **int32** | | [optional] -**Bout** | Pointer to **int32** | | [optional] -**CheckCode** | Pointer to **int32** | | [optional] -**CheckDesc** | **string** | | [optional] -**CheckDuration** | Pointer to **int32** | | [optional] -**CheckFall** | Pointer to **int32** | | [optional] -**CheckHealth** | Pointer to **int32** | | [optional] -**CheckRise** | Pointer to **int32** | | [optional] -**CheckStatus** | **string** | | [optional] -**Chkdown** | Pointer to **int32** | | [optional] -**Chkfail** | Pointer to **int32** | | [optional] -**CliAbrt** | Pointer to **int32** | | [optional] -**CompByp** | Pointer to **int32** | | [optional] -**CompIn** | Pointer to **int32** | | [optional] -**CompOut** | Pointer to **int32** | | [optional] -**CompRsp** | Pointer to **int32** | | [optional] -**ConnRate** | Pointer to **int32** | | [optional] -**ConnRateMax** | Pointer to **int32** | | [optional] -**ConnTot** | Pointer to **int32** | | [optional] -**Cookie** | **string** | | [optional] -**Ctime** | Pointer to **int32** | | [optional] -**Dcon** | Pointer to **int32** | | [optional] -**Downtime** | Pointer to **int32** | | [optional] -**Dreq** | Pointer to **int32** | | [optional] -**Dresp** | Pointer to **int32** | | [optional] -**Dses** | Pointer to **int32** | | [optional] -**Econ** | Pointer to **int32** | | [optional] -**Ereq** | Pointer to **int32** | | [optional] -**Eresp** | Pointer to **int32** | | [optional] -**Hanafail** | **string** | | [optional] -**Hrsp1xx** | Pointer to **int32** | | [optional] -**Hrsp2xx** | Pointer to **int32** | | [optional] -**Hrsp3xx** | Pointer to **int32** | | [optional] -**Hrsp4xx** | Pointer to **int32** | | [optional] -**Hrsp5xx** | Pointer to **int32** | | [optional] -**HrspOther** | Pointer to **int32** | | [optional] -**Iid** | Pointer to **int32** | | [optional] -**Intercepted** | Pointer to **int32** | | [optional] -**Lastchg** | Pointer to **int32** | | [optional] -**Lastsess** | Pointer to **int32** | | [optional] -**Lbtot** | Pointer to **int32** | | [optional] -**Mode** | **string** | | [optional] -**Pid** | Pointer to **int32** | | [optional] -**Qcur** | Pointer to **int32** | | [optional] -**Qlimit** | Pointer to **int32** | | [optional] -**Qmax** | Pointer to **int32** | | [optional] -**Qtime** | Pointer to **int32** | | [optional] -**Rate** | Pointer to **int32** | | [optional] -**RateLim** | Pointer to **int32** | | [optional] -**RateMax** | Pointer to **int32** | | [optional] -**ReqRate** | Pointer to **int32** | | [optional] -**ReqRateMax** | Pointer to **int32** | | [optional] -**ReqTot** | Pointer to **int32** | | [optional] -**Rtime** | Pointer to **int32** | | [optional] -**Scur** | Pointer to **int32** | | [optional] -**Sid** | Pointer to **int32** | | [optional] -**Slim** | Pointer to **int32** | | [optional] -**Smax** | Pointer to **int32** | | [optional] -**SrvAbrt** | Pointer to **int32** | | [optional] -**Status** | **string** | | [optional] -**Stot** | Pointer to **int32** | | [optional] -**Throttle** | Pointer to **int32** | | [optional] -**Tracked** | Pointer to **int32** | | [optional] -**Ttime** | Pointer to **int32** | | [optional] -**Weight** | Pointer to **int32** | | [optional] -**Wredis** | Pointer to **int32** | | [optional] -**Wretr** | Pointer to **int32** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/ProcessInfo.md b/contrib/haproxy/openapi/docs/ProcessInfo.md deleted file mode 100644 index ab458a3546..0000000000 --- a/contrib/haproxy/openapi/docs/ProcessInfo.md +++ /dev/null @@ -1,11 +0,0 @@ -# ProcessInfo - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Haproxy** | [**ProcessInfoHaproxy**](process_info_haproxy.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/ProcessInfoHaproxy.md b/contrib/haproxy/openapi/docs/ProcessInfoHaproxy.md deleted file mode 100644 index 817125cf87..0000000000 --- a/contrib/haproxy/openapi/docs/ProcessInfoHaproxy.md +++ /dev/null @@ -1,15 +0,0 @@ -# ProcessInfoHaproxy - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Pid** | Pointer to **int32** | Process id of the replying worker process | [optional] -**Processes** | Pointer to **int32** | Number of spawned processes | [optional] -**ReleaseDate** | **string** | HAProxy version release date | [optional] -**Uptime** | Pointer to **int32** | HAProxy uptime in s | [optional] -**Version** | **string** | HAProxy version string | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/Redispatch.md b/contrib/haproxy/openapi/docs/Redispatch.md deleted file mode 100644 index ca728a0543..0000000000 --- a/contrib/haproxy/openapi/docs/Redispatch.md +++ /dev/null @@ -1,12 +0,0 @@ -# Redispatch - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Enabled** | **string** | | -**Interval** | **int32** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/Reload.md b/contrib/haproxy/openapi/docs/Reload.md deleted file mode 100644 index bc7e6c1325..0000000000 --- a/contrib/haproxy/openapi/docs/Reload.md +++ /dev/null @@ -1,14 +0,0 @@ -# Reload - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Id** | **string** | | [optional] -**ReloadTimestamp** | **int32** | | [optional] -**Response** | **string** | | [optional] -**Status** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/ReloadsApi.md b/contrib/haproxy/openapi/docs/ReloadsApi.md deleted file mode 100644 index 7a592fd595..0000000000 --- a/contrib/haproxy/openapi/docs/ReloadsApi.md +++ /dev/null @@ -1,74 +0,0 @@ -# \ReloadsApi - -All URIs are relative to *http://localhost/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**GetReload**](ReloadsApi.md#GetReload) | **Get** /services/haproxy/reloads/{id} | Return one HAProxy reload status -[**GetReloads**](ReloadsApi.md#GetReloads) | **Get** /services/haproxy/reloads | Return list of HAProxy Reloads. - - - -## GetReload - -> Reload GetReload(ctx, id) - -Return one HAProxy reload status - -Returns one HAProxy reload status. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string**| Reload id | - -### Return type - -[**Reload**](reload.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetReloads - -> []Reload GetReloads(ctx, ) - -Return list of HAProxy Reloads. - -Returns a list of HAProxy reloads. - -### Required Parameters - -This endpoint does not need any parameter. - -### Return type - -[**[]Reload**](reload.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - diff --git a/contrib/haproxy/openapi/docs/Server.md b/contrib/haproxy/openapi/docs/Server.md deleted file mode 100644 index 46711c15e1..0000000000 --- a/contrib/haproxy/openapi/docs/Server.md +++ /dev/null @@ -1,28 +0,0 @@ -# Server - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Address** | **string** | | [optional] -**Backup** | **string** | | [optional] -**Check** | **string** | | [optional] -**Cookie** | **string** | | [optional] -**Inter** | Pointer to **int32** | | [optional] -**Maintenance** | **string** | | [optional] -**Maxconn** | Pointer to **int32** | | [optional] -**Name** | **string** | | -**OnError** | **string** | | [optional] -**OnMarkedDown** | **string** | | [optional] -**OnMarkedUp** | **string** | | [optional] -**Port** | Pointer to **int32** | | [optional] -**Ssl** | **string** | | [optional] -**SslCafile** | **string** | | [optional] -**SslCertificate** | **string** | | [optional] -**TlsTickets** | **string** | | [optional] -**Verify** | **string** | | [optional] -**Weight** | Pointer to **int32** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/ServerApi.md b/contrib/haproxy/openapi/docs/ServerApi.md deleted file mode 100644 index 8fca0b7d72..0000000000 --- a/contrib/haproxy/openapi/docs/ServerApi.md +++ /dev/null @@ -1,254 +0,0 @@ -# \ServerApi - -All URIs are relative to *http://localhost/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**CreateServer**](ServerApi.md#CreateServer) | **Post** /services/haproxy/configuration/servers | Add a new server -[**DeleteServer**](ServerApi.md#DeleteServer) | **Delete** /services/haproxy/configuration/servers/{name} | Delete a server -[**GetServer**](ServerApi.md#GetServer) | **Get** /services/haproxy/configuration/servers/{name} | Return one server -[**GetServers**](ServerApi.md#GetServers) | **Get** /services/haproxy/configuration/servers | Return an array of servers -[**ReplaceServer**](ServerApi.md#ReplaceServer) | **Put** /services/haproxy/configuration/servers/{name} | Replace a server - - - -## CreateServer - -> Server CreateServer(ctx, backend, server, optional) - -Add a new server - -Adds a new server in the specified backend in the configuration file. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**backend** | **string**| Parent backend name | -**server** | [**Server**](Server.md)| | - **optional** | ***CreateServerOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a CreateServerOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**Server**](server.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DeleteServer - -> DeleteServer(ctx, name, backend, optional) - -Delete a server - -Deletes a server configuration by it's name in the specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**name** | **string**| Server name | -**backend** | **string**| Parent backend name | - **optional** | ***DeleteServerOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a DeleteServerOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - - (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetServer - -> InlineResponse20011 GetServer(ctx, name, backend, optional) - -Return one server - -Returns one server configuration by it's name in the specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**name** | **string**| Server name | -**backend** | **string**| Parent backend name | - **optional** | ***GetServerOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetServerOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20011**](inline_response_200_11.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetServers - -> InlineResponse20010 GetServers(ctx, backend, optional) - -Return an array of servers - -Returns an array of all servers that are configured in specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**backend** | **string**| Parent backend name | - **optional** | ***GetServersOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetServersOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20010**](inline_response_200_10.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceServer - -> Server ReplaceServer(ctx, name, backend, server, optional) - -Replace a server - -Replaces a server configuration by it's name in the specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**name** | **string**| Server name | -**backend** | **string**| Parent backend name | -**server** | [**Server**](Server.md)| | - **optional** | ***ReplaceServerOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceServerOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**Server**](server.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - diff --git a/contrib/haproxy/openapi/docs/ServerSwitchingRule.md b/contrib/haproxy/openapi/docs/ServerSwitchingRule.md deleted file mode 100644 index 8c87c2a75e..0000000000 --- a/contrib/haproxy/openapi/docs/ServerSwitchingRule.md +++ /dev/null @@ -1,14 +0,0 @@ -# ServerSwitchingRule - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Cond** | **string** | | [optional] -**CondTest** | **string** | | [optional] -**Id** | Pointer to **int32** | | -**TargetServer** | **string** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/ServerSwitchingRuleApi.md b/contrib/haproxy/openapi/docs/ServerSwitchingRuleApi.md deleted file mode 100644 index 13198b07ca..0000000000 --- a/contrib/haproxy/openapi/docs/ServerSwitchingRuleApi.md +++ /dev/null @@ -1,254 +0,0 @@ -# \ServerSwitchingRuleApi - -All URIs are relative to *http://localhost/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**CreateServerSwitchingRule**](ServerSwitchingRuleApi.md#CreateServerSwitchingRule) | **Post** /services/haproxy/configuration/server_switching_rules | Add a new Server Switching Rule -[**DeleteServerSwitchingRule**](ServerSwitchingRuleApi.md#DeleteServerSwitchingRule) | **Delete** /services/haproxy/configuration/server_switching_rules/{id} | Delete a Server Switching Rule -[**GetServerSwitchingRule**](ServerSwitchingRuleApi.md#GetServerSwitchingRule) | **Get** /services/haproxy/configuration/server_switching_rules/{id} | Return one Server Switching Rule -[**GetServerSwitchingRules**](ServerSwitchingRuleApi.md#GetServerSwitchingRules) | **Get** /services/haproxy/configuration/server_switching_rules | Return an array of all Server Switching Rules -[**ReplaceServerSwitchingRule**](ServerSwitchingRuleApi.md#ReplaceServerSwitchingRule) | **Put** /services/haproxy/configuration/server_switching_rules/{id} | Replace a Server Switching Rule - - - -## CreateServerSwitchingRule - -> ServerSwitchingRule CreateServerSwitchingRule(ctx, backend, serverSwitchingRule, optional) - -Add a new Server Switching Rule - -Adds a new Server Switching Rule of the specified type in the specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**backend** | **string**| Backend name | -**serverSwitchingRule** | [**ServerSwitchingRule**](ServerSwitchingRule.md)| | - **optional** | ***CreateServerSwitchingRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a CreateServerSwitchingRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**ServerSwitchingRule**](server_switching_rule.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DeleteServerSwitchingRule - -> DeleteServerSwitchingRule(ctx, id, backend, optional) - -Delete a Server Switching Rule - -Deletes a Server Switching Rule configuration by it's ID from the specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Switching Rule ID | -**backend** | **string**| Backend name | - **optional** | ***DeleteServerSwitchingRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a DeleteServerSwitchingRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - - (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetServerSwitchingRule - -> InlineResponse20023 GetServerSwitchingRule(ctx, id, backend, optional) - -Return one Server Switching Rule - -Returns one Server Switching Rule configuration by it's ID in the specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Switching Rule ID | -**backend** | **string**| Backend name | - **optional** | ***GetServerSwitchingRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetServerSwitchingRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20023**](inline_response_200_23.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetServerSwitchingRules - -> InlineResponse20022 GetServerSwitchingRules(ctx, backend, optional) - -Return an array of all Server Switching Rules - -Returns all Backend Switching Rules that are configured in specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**backend** | **string**| Backend name | - **optional** | ***GetServerSwitchingRulesOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetServerSwitchingRulesOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20022**](inline_response_200_22.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceServerSwitchingRule - -> ServerSwitchingRule ReplaceServerSwitchingRule(ctx, id, backend, serverSwitchingRule, optional) - -Replace a Server Switching Rule - -Replaces a Server Switching Rule configuration by it's ID in the specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Switching Rule ID | -**backend** | **string**| Backend name | -**serverSwitchingRule** | [**ServerSwitchingRule**](ServerSwitchingRule.md)| | - **optional** | ***ReplaceServerSwitchingRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceServerSwitchingRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**ServerSwitchingRule**](server_switching_rule.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - diff --git a/contrib/haproxy/openapi/docs/Site.md b/contrib/haproxy/openapi/docs/Site.md deleted file mode 100644 index 8e1b2eef4b..0000000000 --- a/contrib/haproxy/openapi/docs/Site.md +++ /dev/null @@ -1,13 +0,0 @@ -# Site - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Farms** | [**[]SiteFarms**](site_farms.md) | | [optional] -**Name** | **string** | | -**Service** | [**SiteService**](site_service.md) | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/SiteFarms.md b/contrib/haproxy/openapi/docs/SiteFarms.md deleted file mode 100644 index c602e380e5..0000000000 --- a/contrib/haproxy/openapi/docs/SiteFarms.md +++ /dev/null @@ -1,18 +0,0 @@ -# SiteFarms - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Balance** | [**Balance**](balance.md) | | [optional] -**Cond** | **string** | | [optional] -**CondTest** | **string** | | [optional] -**Forwardfor** | [**Forwardfor**](forwardfor.md) | | [optional] -**Mode** | **string** | | [optional] -**Name** | **string** | | -**Servers** | [**[]Server**](server.md) | | [optional] -**UseAs** | **string** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/SiteService.md b/contrib/haproxy/openapi/docs/SiteService.md deleted file mode 100644 index 729433ca50..0000000000 --- a/contrib/haproxy/openapi/docs/SiteService.md +++ /dev/null @@ -1,14 +0,0 @@ -# SiteService - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**HttpConnectionMode** | **string** | | [optional] -**Listeners** | [**[]Bind**](bind.md) | | [optional] -**Maxconn** | Pointer to **int32** | | [optional] -**Mode** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/SitesApi.md b/contrib/haproxy/openapi/docs/SitesApi.md deleted file mode 100644 index 5c3e0ed097..0000000000 --- a/contrib/haproxy/openapi/docs/SitesApi.md +++ /dev/null @@ -1,244 +0,0 @@ -# \SitesApi - -All URIs are relative to *http://localhost/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**CreateSite**](SitesApi.md#CreateSite) | **Post** /services/haproxy/sites | Add a site -[**DeleteSite**](SitesApi.md#DeleteSite) | **Delete** /services/haproxy/sites/{name} | Delete a site -[**GetSite**](SitesApi.md#GetSite) | **Get** /services/haproxy/sites/{name} | Return a site -[**GetSites**](SitesApi.md#GetSites) | **Get** /services/haproxy/sites | Return an array of sites -[**ReplaceSite**](SitesApi.md#ReplaceSite) | **Put** /services/haproxy/sites/{name} | Replace a site - - - -## CreateSite - -> Site CreateSite(ctx, site, optional) - -Add a site - -Adds a new site to the configuration file. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**site** | [**Site**](Site.md)| | - **optional** | ***CreateSiteOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a CreateSiteOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**Site**](site.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DeleteSite - -> DeleteSite(ctx, name, optional) - -Delete a site - -Deletes a site from the configuration by it's name. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**name** | **string**| Site frontend name | - **optional** | ***DeleteSiteOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a DeleteSiteOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - - (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetSite - -> InlineResponse2001 GetSite(ctx, name, optional) - -Return a site - -Returns one site configuration by it's name. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**name** | **string**| Site frontend name | - **optional** | ***GetSiteOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetSiteOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse2001**](inline_response_200_1.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetSites - -> InlineResponse200 GetSites(ctx, optional) - -Return an array of sites - -Returns an array of all configured sites. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. - **optional** | ***GetSitesOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetSitesOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse200**](inline_response_200.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceSite - -> Site ReplaceSite(ctx, name, site, optional) - -Replace a site - -Replaces a site configuration by it's name. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**name** | **string**| Site frontend name | -**site** | [**Site**](Site.md)| | - **optional** | ***ReplaceSiteOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceSiteOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**Site**](site.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - diff --git a/contrib/haproxy/openapi/docs/SpecificationApi.md b/contrib/haproxy/openapi/docs/SpecificationApi.md deleted file mode 100644 index 60ddaf698c..0000000000 --- a/contrib/haproxy/openapi/docs/SpecificationApi.md +++ /dev/null @@ -1,39 +0,0 @@ -# \SpecificationApi - -All URIs are relative to *http://localhost/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**GetSpecification**](SpecificationApi.md#GetSpecification) | **Get** /specification | Data Plane API Specification - - - -## GetSpecification - -> map[string]interface{} GetSpecification(ctx, ) - -Data Plane API Specification - -Return Data Plane API OpenAPI specification - -### Required Parameters - -This endpoint does not need any parameter. - -### Return type - -[**map[string]interface{}**](map[string]interface{}.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - diff --git a/contrib/haproxy/openapi/docs/StatsApi.md b/contrib/haproxy/openapi/docs/StatsApi.md deleted file mode 100644 index 8f712149d4..0000000000 --- a/contrib/haproxy/openapi/docs/StatsApi.md +++ /dev/null @@ -1,54 +0,0 @@ -# \StatsApi - -All URIs are relative to *http://localhost/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**GetStats**](StatsApi.md#GetStats) | **Get** /services/haproxy/stats/native | Gets stats - - - -## GetStats - -> []map[string]interface{} GetStats(ctx, optional) - -Gets stats - -Getting stats from the HAProxy. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. - **optional** | ***GetStatsOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetStatsOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **type_** | **optional.String**| Object type to get stats for (one of frontend, backend, server) | - **name** | **optional.String**| Object name to get stats for | - **parent** | **optional.String**| Object parent name to get stats for, in case the object is a server | - -### Return type - -[**[]map[string]interface{}**](map[string]interface{}.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - diff --git a/contrib/haproxy/openapi/docs/StickRule.md b/contrib/haproxy/openapi/docs/StickRule.md deleted file mode 100644 index 809eb7aa33..0000000000 --- a/contrib/haproxy/openapi/docs/StickRule.md +++ /dev/null @@ -1,16 +0,0 @@ -# StickRule - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Cond** | **string** | | [optional] -**CondTest** | **string** | | [optional] -**Id** | Pointer to **int32** | | -**Pattern** | **string** | | -**Table** | **string** | | [optional] -**Type** | **string** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/StickRuleApi.md b/contrib/haproxy/openapi/docs/StickRuleApi.md deleted file mode 100644 index 9a2e32cbdb..0000000000 --- a/contrib/haproxy/openapi/docs/StickRuleApi.md +++ /dev/null @@ -1,254 +0,0 @@ -# \StickRuleApi - -All URIs are relative to *http://localhost/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**CreateStickRule**](StickRuleApi.md#CreateStickRule) | **Post** /services/haproxy/configuration/stick_rules | Add a new Stick Rule -[**DeleteStickRule**](StickRuleApi.md#DeleteStickRule) | **Delete** /services/haproxy/configuration/stick_rules/{id} | Delete a Stick Rule -[**GetStickRule**](StickRuleApi.md#GetStickRule) | **Get** /services/haproxy/configuration/stick_rules/{id} | Return one Stick Rule -[**GetStickRules**](StickRuleApi.md#GetStickRules) | **Get** /services/haproxy/configuration/stick_rules | Return an array of all Stick Rules -[**ReplaceStickRule**](StickRuleApi.md#ReplaceStickRule) | **Put** /services/haproxy/configuration/stick_rules/{id} | Replace a Stick Rule - - - -## CreateStickRule - -> StickRule CreateStickRule(ctx, backend, stickRule, optional) - -Add a new Stick Rule - -Adds a new Stick Rule of the specified type in the specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**backend** | **string**| Backend name | -**stickRule** | [**StickRule**](StickRule.md)| | - **optional** | ***CreateStickRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a CreateStickRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**StickRule**](stick_rule.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DeleteStickRule - -> DeleteStickRule(ctx, id, backend, optional) - -Delete a Stick Rule - -Deletes a Stick Rule configuration by it's ID from the specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Stick Rule ID | -**backend** | **string**| Backend name | - **optional** | ***DeleteStickRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a DeleteStickRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - - (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetStickRule - -> InlineResponse20027 GetStickRule(ctx, id, backend, optional) - -Return one Stick Rule - -Returns one Stick Rule configuration by it's ID in the specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Stick Rule ID | -**backend** | **string**| Backend name | - **optional** | ***GetStickRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetStickRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20027**](inline_response_200_27.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetStickRules - -> InlineResponse20026 GetStickRules(ctx, backend, optional) - -Return an array of all Stick Rules - -Returns all Stick Rules that are configured in specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**backend** | **string**| Backend name | - **optional** | ***GetStickRulesOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetStickRulesOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20026**](inline_response_200_26.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceStickRule - -> StickRule ReplaceStickRule(ctx, id, backend, stickRule, optional) - -Replace a Stick Rule - -Replaces a Stick Rule configuration by it's ID in the specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| Stick Rule ID | -**backend** | **string**| Backend name | -**stickRule** | [**StickRule**](StickRule.md)| | - **optional** | ***ReplaceStickRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceStickRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**StickRule**](stick_rule.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - diff --git a/contrib/haproxy/openapi/docs/TCPRequestRuleApi.md b/contrib/haproxy/openapi/docs/TCPRequestRuleApi.md deleted file mode 100644 index 928d9285d3..0000000000 --- a/contrib/haproxy/openapi/docs/TCPRequestRuleApi.md +++ /dev/null @@ -1,264 +0,0 @@ -# \TCPRequestRuleApi - -All URIs are relative to *http://localhost/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**CreateTCPRequestRule**](TCPRequestRuleApi.md#CreateTCPRequestRule) | **Post** /services/haproxy/configuration/tcp_request_rules | Add a new TCP Request Rule -[**DeleteTCPRequestRule**](TCPRequestRuleApi.md#DeleteTCPRequestRule) | **Delete** /services/haproxy/configuration/tcp_request_rules/{id} | Delete a TCP Request Rule -[**GetTCPRequestRule**](TCPRequestRuleApi.md#GetTCPRequestRule) | **Get** /services/haproxy/configuration/tcp_request_rules/{id} | Return one TCP Request Rule -[**GetTCPRequestRules**](TCPRequestRuleApi.md#GetTCPRequestRules) | **Get** /services/haproxy/configuration/tcp_request_rules | Return an array of all TCP Request Rules -[**ReplaceTCPRequestRule**](TCPRequestRuleApi.md#ReplaceTCPRequestRule) | **Put** /services/haproxy/configuration/tcp_request_rules/{id} | Replace a TCP Request Rule - - - -## CreateTCPRequestRule - -> TcpRequestRule CreateTCPRequestRule(ctx, parentName, parentType, tcpRequestRule, optional) - -Add a new TCP Request Rule - -Adds a new TCP Request Rule of the specified type in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | -**tcpRequestRule** | [**TcpRequestRule**](TcpRequestRule.md)| | - **optional** | ***CreateTCPRequestRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a CreateTCPRequestRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**TcpRequestRule**](tcp_request_rule.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DeleteTCPRequestRule - -> DeleteTCPRequestRule(ctx, id, parentName, parentType, optional) - -Delete a TCP Request Rule - -Deletes a TCP Request Rule configuration by it's ID from the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| TCP Request Rule ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***DeleteTCPRequestRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a DeleteTCPRequestRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - - (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetTCPRequestRule - -> InlineResponse20017 GetTCPRequestRule(ctx, id, parentName, parentType, optional) - -Return one TCP Request Rule - -Returns one TCP Request Rule configuration by it's ID in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| TCP Request Rule ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***GetTCPRequestRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetTCPRequestRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20017**](inline_response_200_17.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetTCPRequestRules - -> InlineResponse20016 GetTCPRequestRules(ctx, parentName, parentType, optional) - -Return an array of all TCP Request Rules - -Returns all TCP Request Rules that are configured in specified parent and parent type. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | - **optional** | ***GetTCPRequestRulesOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetTCPRequestRulesOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20016**](inline_response_200_16.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceTCPRequestRule - -> TcpRequestRule ReplaceTCPRequestRule(ctx, id, parentName, parentType, tcpRequestRule, optional) - -Replace a TCP Request Rule - -Replaces a TCP Request Rule configuration by it's ID in the specified parent. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| TCP Request Rule ID | -**parentName** | **string**| Parent name | -**parentType** | **string**| Parent type | -**tcpRequestRule** | [**TcpRequestRule**](TcpRequestRule.md)| | - **optional** | ***ReplaceTCPRequestRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceTCPRequestRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**TcpRequestRule**](tcp_request_rule.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - diff --git a/contrib/haproxy/openapi/docs/TCPResponseRuleApi.md b/contrib/haproxy/openapi/docs/TCPResponseRuleApi.md deleted file mode 100644 index 3f8bb0e091..0000000000 --- a/contrib/haproxy/openapi/docs/TCPResponseRuleApi.md +++ /dev/null @@ -1,254 +0,0 @@ -# \TCPResponseRuleApi - -All URIs are relative to *http://localhost/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**CreateTCPResponseRule**](TCPResponseRuleApi.md#CreateTCPResponseRule) | **Post** /services/haproxy/configuration/tcp_response_rules | Add a new TCP Response Rule -[**DeleteTCPResponseRule**](TCPResponseRuleApi.md#DeleteTCPResponseRule) | **Delete** /services/haproxy/configuration/tcp_response_rules/{id} | Delete a TCP Response Rule -[**GetTCPResponseRule**](TCPResponseRuleApi.md#GetTCPResponseRule) | **Get** /services/haproxy/configuration/tcp_response_rules/{id} | Return one TCP Response Rule -[**GetTCPResponseRules**](TCPResponseRuleApi.md#GetTCPResponseRules) | **Get** /services/haproxy/configuration/tcp_response_rules | Return an array of all TCP Response Rules -[**ReplaceTCPResponseRule**](TCPResponseRuleApi.md#ReplaceTCPResponseRule) | **Put** /services/haproxy/configuration/tcp_response_rules/{id} | Replace a TCP Response Rule - - - -## CreateTCPResponseRule - -> TcpResponseRule CreateTCPResponseRule(ctx, backend, tcpResponseRule, optional) - -Add a new TCP Response Rule - -Adds a new TCP Response Rule of the specified type in the specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**backend** | **string**| Parent backend name | -**tcpResponseRule** | [**TcpResponseRule**](TcpResponseRule.md)| | - **optional** | ***CreateTCPResponseRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a CreateTCPResponseRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**TcpResponseRule**](tcp_response_rule.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DeleteTCPResponseRule - -> DeleteTCPResponseRule(ctx, id, backend, optional) - -Delete a TCP Response Rule - -Deletes a TCP Response Rule configuration by it's ID from the specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| TCP Response Rule ID | -**backend** | **string**| Parent backend name | - **optional** | ***DeleteTCPResponseRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a DeleteTCPResponseRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - - (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetTCPResponseRule - -> InlineResponse20019 GetTCPResponseRule(ctx, id, backend, optional) - -Return one TCP Response Rule - -Returns one TCP Response Rule configuration by it's ID in the specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| TCP Response Rule ID | -**backend** | **string**| Parent backend name | - **optional** | ***GetTCPResponseRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetTCPResponseRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20019**](inline_response_200_19.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetTCPResponseRules - -> InlineResponse20018 GetTCPResponseRules(ctx, backend, optional) - -Return an array of all TCP Response Rules - -Returns all TCP Response Rules that are configured in specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**backend** | **string**| Parent backend name | - **optional** | ***GetTCPResponseRulesOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetTCPResponseRulesOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - -### Return type - -[**InlineResponse20018**](inline_response_200_18.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## ReplaceTCPResponseRule - -> TcpResponseRule ReplaceTCPResponseRule(ctx, id, backend, tcpResponseRule, optional) - -Replace a TCP Response Rule - -Replaces a TCP Response Rule configuration by it's ID in the specified backend. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **int32**| TCP Response Rule ID | -**backend** | **string**| Parent backend name | -**tcpResponseRule** | [**TcpResponseRule**](TcpResponseRule.md)| | - **optional** | ***ReplaceTCPResponseRuleOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a ReplaceTCPResponseRuleOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - - - **transactionId** | **optional.String**| ID of the transaction where we want to add the operation. Cannot be used when version is specified. | - **version** | **optional.Int32**| Version used for checking configuration version. Cannot be used when transaction is specified, transaction has it's own version. | - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**TcpResponseRule**](tcp_response_rule.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: application/json -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - diff --git a/contrib/haproxy/openapi/docs/TcpRequestRule.md b/contrib/haproxy/openapi/docs/TcpRequestRule.md deleted file mode 100644 index f19c280810..0000000000 --- a/contrib/haproxy/openapi/docs/TcpRequestRule.md +++ /dev/null @@ -1,16 +0,0 @@ -# TcpRequestRule - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Action** | **string** | | [optional] -**Cond** | **string** | | [optional] -**CondTest** | **string** | | [optional] -**Id** | Pointer to **int32** | | -**Timeout** | Pointer to **int32** | | [optional] -**Type** | **string** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/TcpResponseRule.md b/contrib/haproxy/openapi/docs/TcpResponseRule.md deleted file mode 100644 index 1fd1db39e7..0000000000 --- a/contrib/haproxy/openapi/docs/TcpResponseRule.md +++ /dev/null @@ -1,16 +0,0 @@ -# TcpResponseRule - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Action** | **string** | | [optional] -**Cond** | **string** | | [optional] -**CondTest** | **string** | | [optional] -**Id** | Pointer to **int32** | | -**Timeout** | Pointer to **int32** | | [optional] -**Type** | **string** | | - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/Transaction.md b/contrib/haproxy/openapi/docs/Transaction.md deleted file mode 100644 index 4facfc9594..0000000000 --- a/contrib/haproxy/openapi/docs/Transaction.md +++ /dev/null @@ -1,13 +0,0 @@ -# Transaction - -## Properties - -Name | Type | Description | Notes ------------- | ------------- | ------------- | ------------- -**Version** | **int32** | | [optional] -**Id** | **string** | | [optional] -**Status** | **string** | | [optional] - -[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md) - - diff --git a/contrib/haproxy/openapi/docs/TransactionsApi.md b/contrib/haproxy/openapi/docs/TransactionsApi.md deleted file mode 100644 index ac163b1382..0000000000 --- a/contrib/haproxy/openapi/docs/TransactionsApi.md +++ /dev/null @@ -1,203 +0,0 @@ -# \TransactionsApi - -All URIs are relative to *http://localhost/v1* - -Method | HTTP request | Description -------------- | ------------- | ------------- -[**CommitTransaction**](TransactionsApi.md#CommitTransaction) | **Put** /services/haproxy/transactions/{id} | Commit transaction -[**DeleteTransaction**](TransactionsApi.md#DeleteTransaction) | **Delete** /services/haproxy/transactions/{id} | Delete a transaction -[**GetTransaction**](TransactionsApi.md#GetTransaction) | **Get** /services/haproxy/transactions/{id} | Return one HAProxy configuration transactions -[**GetTransactions**](TransactionsApi.md#GetTransactions) | **Get** /services/haproxy/transactions | Return list of HAProxy configuration transactions. -[**StartTransaction**](TransactionsApi.md#StartTransaction) | **Post** /services/haproxy/transactions | Start a new transaction - - - -## CommitTransaction - -> Transaction CommitTransaction(ctx, id, optional) - -Commit transaction - -Commit transaction, execute all operations in transaction and return msg - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string**| Transaction id | - **optional** | ***CommitTransactionOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a CommitTransactionOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - - **forceReload** | **optional.Bool**| If set, do a force reload, do not wait for the configured reload-delay. Cannot be used when transaction is specified, as changes in transaction are not applied directly to configuration. | [default to false] - -### Return type - -[**Transaction**](transaction.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## DeleteTransaction - -> DeleteTransaction(ctx, id) - -Delete a transaction - -Deletes a transaction. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string**| Transaction id | - -### Return type - - (empty response body) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetTransaction - -> Transaction GetTransaction(ctx, id) - -Return one HAProxy configuration transactions - -Returns one HAProxy configuration transactions. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**id** | **string**| Transaction id | - -### Return type - -[**Transaction**](transaction.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## GetTransactions - -> []Transaction GetTransactions(ctx, optional) - -Return list of HAProxy configuration transactions. - -Returns a list of HAProxy configuration transactions. Transactions can be filtered by their status. - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. - **optional** | ***GetTransactionsOpts** | optional parameters | nil if no parameters - -### Optional Parameters - -Optional parameters are passed through a pointer to a GetTransactionsOpts struct - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- - **status** | **optional.String**| Filter by transaction status | - -### Return type - -[**[]Transaction**](transaction.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - - -## StartTransaction - -> Transaction StartTransaction(ctx, version) - -Start a new transaction - -Starts a new transaction and returns it's id - -### Required Parameters - - -Name | Type | Description | Notes -------------- | ------------- | ------------- | ------------- -**ctx** | **context.Context** | context for authentication, logging, cancellation, deadlines, tracing, etc. -**version** | **int32**| Configuration version on which to work on | - -### Return type - -[**Transaction**](transaction.md) - -### Authorization - -[basic_auth](../README.md#basic_auth) - -### HTTP request headers - -- **Content-Type**: Not defined -- **Accept**: application/json - -[[Back to top]](#) [[Back to API list]](../README.md#documentation-for-api-endpoints) -[[Back to Model list]](../README.md#documentation-for-models) -[[Back to README]](../README.md) - diff --git a/docs/release/release-tasks.md b/docs/release/release-tasks.md new file mode 100644 index 0000000000..60f6ae2c02 --- /dev/null +++ b/docs/release/release-tasks.md @@ -0,0 +1,188 @@ +# Release Tasks + +**Notes**: + +- The examples in this document are based on the v1.8 release cycle. + + + + +- [Prepare main branch for development of the new release](#prepare-main-branch-for-development-of-the-new-release) +- [Remove previously deprecated code](#remove-previously-deprecated-code) +- [[Optional] Bump the Kubernetes version](#optional-bump-the-kubernetes-version) +- [Bump dependencies](#bump-dependencies) +- [Create a release branch](#create-a-release-branch) +- [Cut a release](#cut-a-release) +- [[Continuously] Reduce the amount of flaky tests](#continuously-reduce-the-amount-of-flaky-tests) + + + +## Prepare main branch for development of the new release + +TODO(sbueringer): Finalize this section once we do this for the first time + +The goal of this issue is to bump the versions on the main branch so that the upcoming release version +is used for e.g. local development and e2e tests. We also modify tests so that they are testing the previous release. + +This comes down to changing occurrences of the old version to the new version, e.g. `v1.7` to `v1.8`: + +1. Setup E2E tests for the new release: + 1. Goal is that our clusterctl upgrade tests are testing the right versions. For `v1.8` this means: + - v1beta1: `v1.7` (will change with each new release) + - v1alpha4: `v0.8` + 2. Update providers in `vsphere-ci.yaml`, `vsphere-dev.yaml`, `integration-dev.yaml`: + 1. Add a new `v1.7.0` entry. + 2. Remove providers that are not used anymore in clusterctl upgrade tests. + 3. Change `v1.7.99` to `v1.8.99`. + 3. Adjust `metadata.yaml`'s: + 1. Add new release to the top-level `metadata.yaml` + 2. Create a new `v1.7` `metadata.yaml` (`test/e2e/data/shared/v1.7/metadata.yaml`) by copying + `test/e2e/data/shared/main/metadata.yaml` + 3. Add the new v1.8 release to the main `metadata.yaml` (`test/e2e/data/shared/main/metadata.yaml`). + 4. Remove old `metadata.yaml`'s that are not used anymore in clusterctl upgrade tests. + 4. Adjust cluster templates in `test/e2e/data/infrastructure-vsphere`: + 1. Create a new `v1.7` folder. It should be created based on the `main` folder and only contain the templates + we use in the clusterctl upgrade tests (as of today `remote-management`). + 2. Remove old folders that are not used anymore in clusterctl upgrade tests. + 5. Modify the test specs in `test/e2e/capi_clusterctl_upgrade_test.go` (according to the versions we want to test described above). + Please note that both `InitWithKubernetesVersion` and `WorkloadKubernetesVersion` should be the highest mgmt cluster version supported by the respective Cluster API version. +2. Update `clusterctl-settings.json`: `v1.7.99` => `v1.8.99`. +3. Make sure all tests are green (also run `pull-cluster-api-provider-vsphere-e2e-full-main` and `pull-cluster-api-provider-vsphere-conformance-main`). + +Prior art: TODO(sbueringer): link example PR + +## Remove previously deprecated code + +The goal of this task is to remove all previously deprecated code that can be now removed. + +1. Check for deprecated code and remove it. + **Note**: We can't just remove all code flagged with `Deprecated`. In some cases like e.g. in API packages + we have to keep the old code. + +Prior art: TODO(sbueringer): link example PR + +## [Optional] Bump the Kubernetes version + +TODO(sbueringer): Write this when we do it the next time + +## Bump dependencies + +The goal of this task is to ensure that we have relatively up-to-date dependencies at the time of the release. +This reduces the risk that CVEs are found in outdated dependencies after our release. + +We should take a look at the following dependencies: + +- Go dependencies in the `go.mod` file. (usually dependabot takes care of that) +- Tools used in our Makefile (e.g. kustomize). + +## Create a release branch + +The goal of this task is to ensure we have a release branch with test coverage and results in testgrid. While we +add test coverage for the new release branch we will also drop the tests for old release branches if necessary. +The milestone applier should also apply milestones accordingly. +From this point forward changes which should land in the release have to be cherry-picked into the release branch. + +1. Create the release branch locally based on the latest commit on main and push it. + + ```bash + # Create the release branch + git checkout -b release-1.8 + + # Push the release branch + # Note: `upstream` must be the remote pointing to `github.com/kubernetes-sigs/cluster-api`. + git push -u upstream release-1.8 + ``` + +2. Create the milestone for the new release via [GitHub UI](https://github.com/kubernetes-sigs/cluster-api-provider-vsphere/milestones/new). +3. Update the [milestone applier config](https://github.com/kubernetes/test-infra/blob/151bab62dc023525f592e6d1fdc2a8de5305cd01/config/prow/plugins.yaml#L523) accordingly (e.g. `release-1.8: v1.8` + and `main: v1.9`) +4. Create new jobs based on the jobs running against our `main` branch: + 1. Copy `config/jobs/kubernetes-sigs/cluster-api-provider-vsphere/cluster-api-provider-vsphere-periodics-main.yaml` to `config/jobs/kubernetes-sigs/cluster-api-provider-vsphere/cluster-api-provider-vsphere-periodics-release-1.8.yaml`. + 2. Copy `config/jobs/kubernetes-sigs/cluster-api-provider-vsphere/cluster-api-provider-vsphere-presubmits-main.yaml` to `config/jobs/kubernetes-sigs/cluster-api-provider-vsphere/cluster-api-provider-vsphere-presubmits-release-1.8.yaml`. + 3. Modify the following: + 1. Rename the jobs, e.g.: `periodic-cluster-api-provider-vsphere-test-main` => `periodic-cluster-api-provider-vsphere-test-release-1-8`. + 2. Change `annotations.testgrid-tab-name`, e.g. `periodic-test-main` => `periodic-test-release-1-8`. + 3. For periodics additionally: + - Change `extra_refs[].base_ref` to `release-1.8` (for repo: `cluster-api-provider-vsphere`). + 4. For presubmits additionally: + - Adjust branches: `^main$` => `^release-1.8$`. +5. Remove tests for old release branches if necessary +6. Verify the jobs and dashboards a day later by taking a look at [testgrid](https://testgrid.k8s.io/sig-cluster-lifecycle-cluster-api-provider-vsphere) +7. Update `.github/workflows/weekly-security-scan.yaml` - to setup Trivy and govulncheck scanning - `.github/workflows/weekly-md-link-check.yaml` - to setup link checking in the CAPI book - and `.github/workflows/weekly-test-release.yaml` - to verify the release target is working - for the currently supported branches. + +## Cut a release + +1. Ensure via testgrid that CI is stable before cutting the release + Note: special attention should be given to image scan results, so we can avoid cutting a release with CVEs or document known CVEs in release notes. +2. Create and push the release tags to the GitHub repository: + + ```bash + # Export the tag of the release to be cut, e.g.: + export RELEASE_TAG=v1.8.0-beta.0 + # Create tags locally + # Warning: The test tag MUST NOT be an annotated tag. + git tag -s -a ${RELEASE_TAG} -m ${RELEASE_TAG} + + # Push tags + # Note: `upstream` must be the remote pointing to `github.com/kubernetes-sigs/cluster-api`. + git push upstream ${RELEASE_TAG} + ``` + + This will automatically trigger: + - a [GitHub Action](https://github.com/kubernetes-sigs/cluster-api-provider-vsphere/actions/workflows/release.yaml) to create a draft release and + - a [ProwJob](https://prow.k8s.io/?repo=kubernetes-sigs%2Fcluster-api-provider-vsphere&job=post-cluster-api-provider-vsphere-push-images) to publish images to the staging image repository. +3. Promote images from the staging repository to the production registry (`registry.k8s.io/cluster-api-vsphere`): + 1. Wait until images for the tag have been built and pushed to the [staging repository](https://console.cloud.google.com/gcr/images/k8s-staging-capi-vsphere/global/cluster-api-vsphere-controller) by + the [push images job](https://prow.k8s.io/?repo=kubernetes-sigs%2Fcluster-api-provider-vsphere&job=post-cluster-api-provider-vsphere-push-images). + 2. If you don't have a GitHub token, create one by going to your GitHub settings in [Personal access tokens](https://github.com/settings/tokens). Make sure you give the token the `repo` scope. + 3. Create a PR to promote the images to the production registry: + + ```bash + # Export the tag of the release to be cut, e.g.: + export RELEASE_TAG=v1.8.0-beta.0 + export GITHUB_TOKEN= + make promote-images + ``` + + **Notes**: + - `make promote-images` target tries to figure out your Github user handle in order to find the forked [k8s.io](https://github.com/kubernetes/k8s.io) repository. + If you have not forked the repo, please do it before running the Makefile target. + - if `make promote-images` fails with an error like `FATAL while checking fork of kubernetes/k8s.io` you may be able to solve it by manually setting the USER_FORK variable + i.e. `export USER_FORK=` + - `kpromo` uses `git@github.com:...` as remote to push the branch for the PR. If you don't have `ssh` set up you can configure + git to use `https` instead via `git config --global url."https://github.com/".insteadOf git@github.com:`. + - This will automatically create a PR in [k8s.io](https://github.com/kubernetes/k8s.io) and assign the CAPI maintainers. +4. Merge the PR (/lgtm + /hold cancel) and verify the images are available in the production registry: + - Wait for the [promotion prow job](https://prow.k8s.io/?repo=kubernetes%2Fk8s.io&job=post-k8sio-image-promo) to complete successfully. Then verify that the production images are accessible: + + ```bash + docker pull registry.k8s.io/cluster-api-vsphere/cluster-api-vsphere-controller:${RELEASE_TAG} + ``` + +5. Publish the release. + 1. Finalize release notes + 1. Pay close attention to the `## :question: Sort these by hand` section, as it contains items that need to be manually sorted. + 2. Ensure consistent formatting of entries (e.g. prefix). + 3. Merge dependency bump PR entries for the same dependency into a single entry. + 4. Move minor changes into a single line at the end of each section. + 5. Sort entries within a section alphabetically. + 6. Write highlights section based on the initial release notes doc. (for minor releases and important changes only) + 7. **For minor releases** Modify `Changes since v1.x.y` to `Changes since v1.x` + **Note**: The release notes tool includes all merges since the previous release branch was branched of. + 2. Publish the release and ensure release is flagged as `pre-release` for all `beta` and `rc` releases or `latest` for a new release in the most recent release branch. +6. **For minor releases** Update supported versions in versions.md. + +- Cutting a release as of today requires permissions to: + - Create a release tag on the GitHub repository. + - Create/update/publish GitHub releases. + +## [Continuously] Reduce the amount of flaky tests + +The CAPV tests are pretty stable, but there are still some flaky tests from time to time. To reduce the amount of flakes please periodically: + +1. Take a look at recent CI failures via `k8s-triage`: + - [periodic-cluster-api-provider-vsphere-test-main](https://storage.googleapis.com/k8s-triage/index.html?pr=1&job=periodic-cluster-api-provider-vsphere-test-main) + - [periodic-cluster-api-provider-vsphere-test-integration-main](https://storage.googleapis.com/k8s-triage/index.html?pr=1&job=periodic-cluster-api-provider-vsphere-test-integration-main) + - [periodic-cluster-api-provider-vsphere-e2e-full-main](https://storage.googleapis.com/k8s-triage/index.html?pr=1&job=periodic-cluster-api-provider-vsphere-e2e-full-main) + - [periodic-cluster-api-provider-vsphere-conformance-main](https://storage.googleapis.com/k8s-triage/index.html?pr=1&job=periodic-cluster-api-provider-vsphere-conformance-main) +2. Open issues for occurring flakes and ideally fix them or find someone who can. diff --git a/hack/check-shell.sh b/hack/generate-doctoc.sh similarity index 63% rename from hack/check-shell.sh rename to hack/generate-doctoc.sh index db38eb02a8..f7adc62fa4 100755 --- a/hack/check-shell.sh +++ b/hack/generate-doctoc.sh @@ -1,4 +1,4 @@ -#!/bin/bash +#!/usr/bin/env bash # Copyright 2019 The Kubernetes Authors. # @@ -18,11 +18,14 @@ set -o errexit set -o nounset set -o pipefail -# Change directories to the parent directory of the one in which this -# script is located. -cd "$(dirname "${BASH_SOURCE[0]}")/.." +if [[ "${TRACE-0}" == "1" ]]; then + set -o xtrace +fi -# This file has been deprecated in favor of the Makefile target "lint-shell". -# This file remains as a backwards-compatible stub for the CI tests since -# older release branches still expect this file to exist. -make lint-shell +if [[ -z "$(command -v doctoc)" ]]; then + echo "doctoc is not available on your system, skipping verification" + echo "Note: The doctoc module can be installed via npm (https://www.npmjs.com/package/doctoc)" + exit 0 +fi + +doctoc docs/release/release-tasks.md diff --git a/hack/match-release-tag.sh b/hack/match-release-tag.sh deleted file mode 100755 index 96a6688611..0000000000 --- a/hack/match-release-tag.sh +++ /dev/null @@ -1,108 +0,0 @@ -#!/bin/bash - -# Copyright 2019 The Kubernetes Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -set -o errexit -set -o nounset -set -o pipefail - -# Change directories to the parent directory of the one in which this -# script is located. -cd "$(dirname "${BASH_SOURCE[0]}")/.." - -usage() { - cat <&2; exit 1 - ;; - x) - EXAMPLES=1 - ;; - \?) - { echo "invalid option: -${OPTARG}"; usage; } 1>&2; exit 1 - ;; - :) - echo "option -${OPTARG} requires an argument" 1>&2; exit 1 - ;; - esac -done -shift $((OPTIND-1)) - -# The regular expression matches the following strings: -# * v1.0.0-alpha.0 -# * v1.0.0-beta.0 -# * v1.0.0-rc.0 -# * v1.0.0 -# Any occurence of a digit in the above examples may be multiple digits. -REGEX='^[[:space:]]{0,}v[[:digit:]]{1,}\.[[:digit:]]{1,}\.[[:digit:]]{1,}(-(alpha|beta|rc)\.[[:digit:]]{1,}){0,1}[[:space:]]{0,}$' - -# Match the tag against the regular expression for a release tag. -match() { - if [[ ${1} =~ ${REGEX} ]]; then - echo "yay: ${1}" - else - exit_code="${?}" - echo "nay: ${1}" - return "${exit_code}" - fi -} - -# Run examples to illustrate valid and invalid values. -examples() { - local semvers=" \ - v1.0.0-alpha.0 \ - v1.0.0-beta.0 \ - v1.0.0-rc.0 \ - v1.0.0 \ - v10.0.0 \ - v1.10.0 \ - v1.0.10 \ - v10.0.0-alpha.10 \ - v1.10.0-beta.10 \ - v1.0.10-rc.10 \ - 1.0.0 \ - v1.0.0+rc.0 \ - v10a.0.0 \ - 1.1.0-alpha.1 \ - v1.0.0-alpha.0a" - set +o errexit - for v in ${semvers}; do match "${v}"; done - return 0 -} - -main() { - # Get the tag from the remaining arguments or from "git describe --dirty" - [ "${#}" -eq "0" ] || tag="${1}" - [ -n "${tag-}" ] || tag="$(git describe --dirty)" - - # Match the tag against the regular expression for a release tag. - match "${tag}" 1>&2 -} - -{ [ "${EXAMPLES-}" ] && examples; } || main "${@-}" diff --git a/hack/tools/shellcheck/Dockerfile b/hack/tools/shellcheck/Dockerfile deleted file mode 100644 index 483d05be12..0000000000 --- a/hack/tools/shellcheck/Dockerfile +++ /dev/null @@ -1,31 +0,0 @@ -# syntax=docker/dockerfile:1.4 - -# Copyright 2019 The Kubernetes Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -################################################################################ -## INSTALL SHELLCHECK ## -################################################################################ -ARG SHELLCHECK_VERSION=v0.6.0 -FROM koalaman/shellcheck:${SHELLCHECK_VERSION} as build - -################################################################################ -## MAIN ## -################################################################################ -FROM debian:stretch-slim -LABEL "maintainer" "Andrew Kutz " -COPY --from=build /bin/shellcheck /bin/ -COPY shellcheck.sh /bin/shellcheck.sh -WORKDIR /build -ENTRYPOINT [ "/bin/shellcheck.sh" ] diff --git a/hack/tools/shellcheck/Makefile b/hack/tools/shellcheck/Makefile deleted file mode 100644 index 0f30c4dc46..0000000000 --- a/hack/tools/shellcheck/Makefile +++ /dev/null @@ -1,27 +0,0 @@ -# Copyright 2019 The Kubernetes Authors. -# -# Licensed under the Apache License, Version 2.0 (the "License"); -# you may not use this file except in compliance with the License. -# You may obtain a copy of the License at -# -# http://www.apache.org/licenses/LICENSE-2.0 -# -# Unless required by applicable law or agreed to in writing, software -# distributed under the License is distributed on an "AS IS" BASIS, -# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. -# See the License for the specific language governing permissions and -# limitations under the License. - -all: build - -IMAGE_VERSION ?= v0.6.0 -IMAGE_NAME ?= gcr.io/cluster-api-provider-vsphere/extra/shellcheck -IMAGE_TAG ?= $(IMAGE_NAME):$(IMAGE_VERSION) - -build: - docker build --build-arg SHELLCHECK_VERSION=$(IMAGE_VERSION) -t $(IMAGE_TAG) . -.PHONY: build - -push: - docker push $(IMAGE_TAG) -.PHONY: push diff --git a/hack/tools/shellcheck/shellcheck.sh b/hack/utils.sh old mode 100755 new mode 100644 similarity index 79% rename from hack/tools/shellcheck/shellcheck.sh rename to hack/utils.sh index 472ed15fdd..df96561ad1 --- a/hack/tools/shellcheck/shellcheck.sh +++ b/hack/utils.sh @@ -1,5 +1,4 @@ -#!/bin/bash - +#!/usr/bin/env bash # Copyright 2019 The Kubernetes Authors. # # Licensed under the Apache License, Version 2.0 (the "License"); @@ -14,8 +13,7 @@ # See the License for the specific language governing permissions and # limitations under the License. -set -o errexit -set -o nounset -set -o pipefail - -find . -path ./vendor -prune -o -name "*.*sh" -type f -print0 | xargs -0 shellcheck "${@}" +# get_root_path returns the root path of the project source tree +get_root_path() { + git rev-parse --show-toplevel +} diff --git a/hack/verify-container-images.sh b/hack/verify-container-images.sh index 0a983ea2e3..d99c2da64a 100755 --- a/hack/verify-container-images.sh +++ b/hack/verify-container-images.sh @@ -66,7 +66,7 @@ NC='\033[0m' # No if [ "$R1" -ne "0" ] then - echo -e "${BRed}Check container images failed! There are vulnerability to be fixed${NC}" + echo -e "${BRed}Check container images failed! There are vulnerabilities to be fixed${NC}" exit 1 fi diff --git a/hack/verify-shellcheck.sh b/hack/verify-shellcheck.sh new file mode 100755 index 0000000000..e29007bad8 --- /dev/null +++ b/hack/verify-shellcheck.sh @@ -0,0 +1,79 @@ +#!/usr/bin/env bash +# Copyright 2019 The Kubernetes Authors. +# +# Licensed under the Apache License, Version 2.0 (the "License"); +# you may not use this file except in compliance with the License. +# You may obtain a copy of the License at +# +# http://www.apache.org/licenses/LICENSE-2.0 +# +# Unless required by applicable law or agreed to in writing, software +# distributed under the License is distributed on an "AS IS" BASIS, +# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. +# See the License for the specific language governing permissions and +# limitations under the License. + +set -o errexit +set -o nounset +set -o pipefail + +if [[ "${TRACE-0}" == "1" ]]; then + set -o xtrace +fi + +if [ $# -ne 1 ]; then + echo 1>&2 "$0: usage: ./verify-shellcheck.sh " + exit 2 +fi + +VERSION=${1} + +OS="unknown" +if [[ "${OSTYPE}" == "linux"* ]]; then + OS="linux" +elif [[ "${OSTYPE}" == "darwin"* ]]; then + OS="darwin" +fi + +# shellcheck source=./hack/utils.sh +source "$(dirname "$0")/utils.sh" +ROOT_PATH=$(get_root_path) + +# create a temporary directory +TMP_DIR=$(mktemp -d) +OUT="${TMP_DIR}/out.log" + +# cleanup on exit +cleanup() { + ret=0 + if [[ -s "${OUT}" ]]; then + echo "Found errors:" + cat "${OUT}" + ret=1 + fi + echo "Cleaning up..." + rm -rf "${TMP_DIR}" + exit ${ret} +} +trap cleanup EXIT + + +SHELLCHECK="./$(dirname "$0")/tools/bin/shellcheck/${VERSION}/shellcheck" + +if [ ! -f "$SHELLCHECK" ]; then + # install buildifier + cd "${TMP_DIR}" || exit + DOWNLOAD_FILE="shellcheck-${VERSION}.${OS}.x86_64.tar.xz" + curl -L "https://github.com/koalaman/shellcheck/releases/download/${VERSION}/${DOWNLOAD_FILE}" -o "${TMP_DIR}/shellcheck.tar.xz" + tar xf "${TMP_DIR}/shellcheck.tar.xz" + cd "${ROOT_PATH}" + mkdir -p "$(dirname "$0")/tools/bin/shellcheck/${VERSION}" + mv "${TMP_DIR}/shellcheck-${VERSION}/shellcheck" "$SHELLCHECK" +fi + +echo "Running shellcheck..." +cd "${ROOT_PATH}" || exit +FILES=$(find . -name "*.sh") +while read -r file; do + "$SHELLCHECK" -x "$file" >> "${OUT}" 2>&1 +done <<< "$FILES"