moby / moby/libnetwork

The `DisableGatewayService` field on the `NetworkDriver.Join` is not documented

Open
#2,569 0 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Go
Stars
2.2k
Forks
875
PR merge metrics
No merged PRs in 30d

Description

Documentation of the https://github.com/moby/libnetwork/blob/master/docs/remote.md#join NetworkDriver.Join response does not list the DisableGatewayService field, but apparently it's supported in the GO implementation (https://github.com/moby/libnetwork/blob/master/drivers/remote/api/api.go#L175)

Is this an officially supported field? If so I suggest to add it to the documentation.

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Read docs/remote.md at the NetworkDriver.Join response and compare it with drivers/remote/api/api.go around line 175. Confirm whether DisableGatewayService is officially supported; done means the support status is resolved and the Join documentation lists the field when appropriate.

Written by the indexing model from the issue text.

Assessment

Tech stack
go
Domain
documentation, networking
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.