Skip to content

Commit

Permalink
Rename Domains.network_mode to Domains.automatic_networking which is
Browse files Browse the repository at this point in the history
    what the existing domain-server code uses.
Update documentation to remove "network_mode" and replace with "automatic_networking"
  • Loading branch information
Misterblue committed Nov 3, 2020
1 parent 2928148 commit ec220c2
Show file tree
Hide file tree
Showing 3 changed files with 5 additions and 16 deletions.
4 changes: 2 additions & 2 deletions docs/API-Domains.md
Expand Up @@ -30,7 +30,7 @@ A request returns an array of domain descriptions:
"version": stringSoftwareVersion,
"protocol_version": stringProtocolVersion,
"network_address": stringNetworkAddress,
"networking_mode": stringMode, // one of "full", ...
"automatic_networking": stringMode, // one of "full", "ip", or "disabled"
"restricted": boolWhetherRestricted,
"num_users": intCurrentLoggedInUsers,
"anon_users": intCurrentAnonomousUsers,
Expand Down Expand Up @@ -141,7 +141,7 @@ The domain fields that can be fetched:
| version | all | domain | string |
| protocol | all | domain | string |
| network_address | all | domain | string |
| networking_mode | all | domain | string |
| automatic_networking | all | domain | string |
| num_users | all | domain | string |
| num_anon_users | all | domain | string |
| restricted | all | domain sponsor admin | string |
Expand Down
14 changes: 2 additions & 12 deletions src/Entities/DomainEntity.ts
Expand Up @@ -39,8 +39,7 @@ export class DomainEntity implements Entity {
public protocol: string; // Protocol version
public networkAddr: string; // reported network address
public networkPort: string; // reported network address
public networkingMode: string; // one of "full", ?
public automaticNetworking: string; // one of "disabled", ?
public networkingMode: string; // one of "full", "ip", "disabled"
public restricted: boolean; // 'true' if restricted to users with accounts
public numUsers: number; // regular users logged in
public anonUsers: number; // number of anonymous users
Expand Down Expand Up @@ -191,17 +190,8 @@ export const domainFields: { [key: string]: FieldDefn } = {
getter: simpleGetter
},
'automatic_networking': {
entity_field: 'automaticNetworking',
request_field_name: 'automatic_networking',
get_permissions: [ 'all' ],
set_permissions: [ 'domain' ],
validate: isStringValidator,
setter: simpleSetter,
getter: simpleGetter
},
'networking_mode': {
entity_field: 'networkingMode',
request_field_name: 'networking_mode',
request_field_name: 'automatic_networking',
get_permissions: [ 'all' ],
set_permissions: [ 'domain' ],
validate: isStringValidator,
Expand Down
3 changes: 1 addition & 2 deletions src/route-tools/Util.ts
Expand Up @@ -153,8 +153,7 @@ export async function buildDomainInfoV1(pDomain: DomainEntity): Promise<any> {
'protocol_version': pDomain.protocol,
'network_address': pDomain.networkAddr,
'network_port': pDomain.networkPort,
'networking_mode': pDomain.networkingMode,
'automatic_networking': pDomain.automaticNetworking,
'automatic_networking': pDomain.networkingMode,
'restricted': pDomain.restricted,
'num_users': pDomain.numUsers,
'anon_users': pDomain.anonUsers,
Expand Down

0 comments on commit ec220c2

Please sign in to comment.