extern/netbird
1
0
Fork 0
mirror of https://github.com/netbirdio/netbird.git synced 2025-02-02 19:39:17 +01:00
Code Issues Packages Projects Releases Wiki Activity

add examples

Browse Source
This commit is contained in:
Pascal Fischer 2023-06-02 01:50:15 +02:00
parent 2dcfa1efa3
commit 5028450133
1 changed files with 8 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
management/server/http/api/openapi.yml
View File

@ -578,10 +578,12 @@ components:
enabled: enabled:
description: Policy rule status description: Policy rule status
type: boolean type: boolean
example: true
action: action:
description: Policy rule accept or drops packets description: Policy rule accept or drops packets
type: string type: string
enum: ["accept","drop"] enum: ["accept","drop"]
example: "accept"
bidirectional: bidirectional:
description: Define if the rule is applicable in both directions, sources, and destinations. description: Define if the rule is applicable in both directions, sources, and destinations.
type: boolean type: boolean
@ -596,7 +598,7 @@ components:
type: array type: array
items: items:
type: string type: string
example: [80,443] example: "80"
required: required:
- name - name
- enabled - enabled
@ -613,11 +615,13 @@ components:
type: array type: array
items: items:
type: string type: string
example: "ch8i4ug6lnn4g9hqv797"
destinations: destinations:
description: Policy rule destination groups description: Policy rule destination groups
type: array type: array
items: items:
type: string type: string
example: "ch8i4ug6lnn4g9h7v7m0"
required: required:
- sources - sources
- destinations - destinations
@ -645,6 +649,7 @@ components:
id: id:
description: Policy ID description: Policy ID
type: string type: string
example: ch8i4ug6lnn4g9hqv7mg
name: name:
description: Policy name identifier description: Policy name identifier
type: string type: string
@ -660,6 +665,7 @@ components:
query: query:
description: Policy Rego query description: Policy Rego query
type: string type: string
example: "package netbird\\n\\nall[rule] {\\n is_peer_in_any_group([\\\"ch8i4ug6lnn4g9hqv7m0\\\",\\\"ch8i4ug6lnn4g9hqv7m0\\\"])\\n rule := {\\n rules_from_group(\\\"ch8i4ug6lnn4g9hqv7m0\\\", \\\"dst\\\", \\\"accept\\\", \\\"\\\"),\\n rules_from_group(\\\"ch8i4ug6lnn4g9hqv7m0\\\", \\\"src\\\", \\\"accept\\\", \\\"\\\"),\\n }[_][_]\\n}\\n"
required: required:
- name - name
- description - description