Skip to content

Commit e504bc5

Browse files
Isidore Reinhardtstgraber
Isidore Reinhardt
authored and
stgraber
committed
doc/rest-api: Refresh swagger YAML
Signed-off-by: Isidore Reinhardt <[email protected]>
1 parent 7b84b80 commit e504bc5

File tree

1 file changed

+377
-0
lines changed

1 file changed

+377
-0
lines changed

‎doc/rest-api.yaml

Lines changed: 377 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -2964,6 +2964,109 @@ definitions:
29642964
title: NetworkACLsPost used for creating an ACL.
29652965
type: object
29662966
x-go-package: github.com/lxc/incus/v6/shared/api
2967+
NetworkAddressSet:
2968+
description: Refer to doc/howto/network_address_sets.md for details.
2969+
properties:
2970+
addresses:
2971+
description: Updated addresses
2972+
items:
2973+
type: string
2974+
type: array
2975+
x-go-name: Addresses
2976+
description:
2977+
description: Description of the ACL
2978+
example: Web servers
2979+
type: string
2980+
x-go-name: Description
2981+
external_ids:
2982+
additionalProperties:
2983+
type: string
2984+
description: Updated external_ids
2985+
type: object
2986+
x-go-name: ExternalIDs
2987+
name:
2988+
description: The new name of the address set
2989+
example: '"bar"'
2990+
type: string
2991+
x-go-name: Name
2992+
project:
2993+
description: Project name
2994+
example: project1
2995+
type: string
2996+
x-go-name: Project
2997+
used_by:
2998+
description: List of URLs of objects using this profile
2999+
example:
3000+
- /1.0/instances/c1
3001+
- /1.0/instances/v1
3002+
- /1.0/networks/mybr0
3003+
items:
3004+
type: string
3005+
readOnly: true
3006+
type: array
3007+
x-go-name: UsedBy
3008+
title: NetworkAddressSet represents an address set.
3009+
type: object
3010+
x-go-package: github.com/lxc/incus/v6/shared/api
3011+
NetworkAddressSetPost:
3012+
properties:
3013+
name:
3014+
description: The new name of the address set
3015+
example: '"bar"'
3016+
type: string
3017+
x-go-name: Name
3018+
title: NetworkAddressSetPost used for renaming an Address Set.
3019+
type: object
3020+
x-go-package: github.com/lxc/incus/v6/shared/api
3021+
NetworkAddressSetPut:
3022+
properties:
3023+
addresses:
3024+
description: Updated addresses
3025+
items:
3026+
type: string
3027+
type: array
3028+
x-go-name: Addresses
3029+
description:
3030+
description: Description of the ACL
3031+
example: Web servers
3032+
type: string
3033+
x-go-name: Description
3034+
external_ids:
3035+
additionalProperties:
3036+
type: string
3037+
description: Updated external_ids
3038+
type: object
3039+
x-go-name: ExternalIDs
3040+
title: NetworkAddressSetPut used for updating an Address Set.
3041+
type: object
3042+
x-go-package: github.com/lxc/incus/v6/shared/api
3043+
NetworkAddressSetsPost:
3044+
properties:
3045+
addresses:
3046+
description: Updated addresses
3047+
items:
3048+
type: string
3049+
type: array
3050+
x-go-name: Addresses
3051+
description:
3052+
description: Description of the ACL
3053+
example: Web servers
3054+
type: string
3055+
x-go-name: Description
3056+
external_ids:
3057+
additionalProperties:
3058+
type: string
3059+
description: Updated external_ids
3060+
type: object
3061+
x-go-name: ExternalIDs
3062+
name:
3063+
description: The new name of the address set
3064+
example: '"bar"'
3065+
type: string
3066+
x-go-name: Name
3067+
title: NetworkAddressSetsPost used for creating a new Address Set.
3068+
type: object
3069+
x-go-package: github.com/lxc/incus/v6/shared/api
29673070
NetworkAllocations:
29683071
description: |-
29693072
NetworkAllocations used for displaying network addresses used by a consuming entity
@@ -11112,6 +11215,280 @@ paths:
1111211215
summary: Get the network ACLs
1111311216
tags:
1111411217
- network-acls
11218+
/1.0/network-address-sets:
11219+
get:
11220+
description: Returns a list of network address sets (URLs).
11221+
operationId: network_address_sets_get
11222+
parameters:
11223+
- description: Project name
11224+
example: default
11225+
in: query
11226+
name: project
11227+
type: string
11228+
- description: Retrieve network address sets from all projects
11229+
example: true
11230+
in: query
11231+
name: all-projects
11232+
type: boolean
11233+
- description: Collection filter
11234+
example: default
11235+
in: query
11236+
name: filter
11237+
type: string
11238+
produces:
11239+
- application/json
11240+
responses:
11241+
"200":
11242+
description: API endpoints
11243+
schema:
11244+
description: Sync response
11245+
properties:
11246+
metadata:
11247+
description: List of endpoints
11248+
example: |-
11249+
[
11250+
"/1.0/network-address-sets/foo",
11251+
"/1.0/network-address-sets/bar"
11252+
]
11253+
items:
11254+
type: string
11255+
type: array
11256+
status:
11257+
description: Status description
11258+
example: Success
11259+
type: string
11260+
status_code:
11261+
description: Status code
11262+
example: 200
11263+
type: integer
11264+
type:
11265+
description: Response type
11266+
example: sync
11267+
type: string
11268+
type: object
11269+
"403":
11270+
$ref: '#/responses/Forbidden'
11271+
"500":
11272+
$ref: '#/responses/InternalServerError'
11273+
summary: Get the network address sets
11274+
tags:
11275+
- network-address-sets
11276+
post:
11277+
consumes:
11278+
- application/json
11279+
description: Creates a new network address set.
11280+
operationId: network_address_sets_post
11281+
parameters:
11282+
- description: Project name
11283+
example: default
11284+
in: query
11285+
name: project
11286+
type: string
11287+
- description: address set
11288+
in: body
11289+
name: address set
11290+
required: true
11291+
schema:
11292+
$ref: '#/definitions/NetworkAddressSetPost'
11293+
produces:
11294+
- application/json
11295+
responses:
11296+
"200":
11297+
$ref: '#/responses/EmptySyncResponse'
11298+
"400":
11299+
$ref: '#/responses/BadRequest'
11300+
"403":
11301+
$ref: '#/responses/Forbidden'
11302+
"500":
11303+
$ref: '#/responses/InternalServerError'
11304+
summary: Add a network address set
11305+
tags:
11306+
- network-address-sets
11307+
/1.0/network-address-sets/{name}:
11308+
delete:
11309+
description: Removes the network address set.
11310+
operationId: network_address_set_delete
11311+
parameters:
11312+
- description: Project name
11313+
example: default
11314+
in: query
11315+
name: project
11316+
type: string
11317+
produces:
11318+
- application/json
11319+
responses:
11320+
"200":
11321+
$ref: '#/responses/EmptySyncResponse'
11322+
"400":
11323+
$ref: '#/responses/BadRequest'
11324+
"403":
11325+
$ref: '#/responses/Forbidden'
11326+
"500":
11327+
$ref: '#/responses/InternalServerError'
11328+
summary: Delete the network address set
11329+
tags:
11330+
- network-address-sets
11331+
get:
11332+
description: Gets a specific network address set.
11333+
operationId: network_address_set_get
11334+
parameters:
11335+
- description: Project name
11336+
example: default
11337+
in: query
11338+
name: project
11339+
type: string
11340+
produces:
11341+
- application/json
11342+
responses:
11343+
"200":
11344+
description: address set
11345+
schema:
11346+
description: Sync response
11347+
properties:
11348+
metadata:
11349+
$ref: '#/definitions/NetworkAddressSet'
11350+
status:
11351+
description: Status description
11352+
example: Success
11353+
type: string
11354+
status_code:
11355+
description: Status code
11356+
example: 200
11357+
type: integer
11358+
type:
11359+
description: Response type
11360+
example: sync
11361+
type: string
11362+
type: object
11363+
"403":
11364+
$ref: '#/responses/Forbidden'
11365+
"500":
11366+
$ref: '#/responses/InternalServerError'
11367+
summary: Get the network address set
11368+
tags:
11369+
- network-address-sets
11370+
patch:
11371+
consumes:
11372+
- application/json
11373+
description: Updates a subset of the network address set configuration.
11374+
operationId: network_address_set_patch
11375+
parameters:
11376+
- description: Project name
11377+
example: default
11378+
in: query
11379+
name: project
11380+
type: string
11381+
- description: Address set configuration
11382+
in: body
11383+
name: address set
11384+
required: true
11385+
schema:
11386+
$ref: '#/definitions/NetworkAddressSetPut'
11387+
produces:
11388+
- application/json
11389+
responses:
11390+
"200":
11391+
$ref: '#/responses/EmptySyncResponse'
11392+
"400":
11393+
$ref: '#/responses/BadRequest'
11394+
"403":
11395+
$ref: '#/responses/Forbidden'
11396+
"412":
11397+
$ref: '#/responses/PreconditionFailed'
11398+
"500":
11399+
$ref: '#/responses/InternalServerError'
11400+
summary: Partially update the network address set
11401+
tags:
11402+
- network-address-sets
11403+
post:
11404+
consumes:
11405+
- application/json
11406+
description: Renames an existing network address set.
11407+
operationId: network_address_set_post
11408+
parameters:
11409+
- description: Project name
11410+
example: default
11411+
in: query
11412+
name: project
11413+
type: string
11414+
- description: Address set rename request
11415+
in: body
11416+
name: address set
11417+
required: true
11418+
schema:
11419+
$ref: '#/definitions/NetworkAddressSetPost'
11420+
produces:
11421+
- application/json
11422+
responses:
11423+
"200":
11424+
$ref: '#/responses/EmptySyncResponse'
11425+
"400":
11426+
$ref: '#/responses/BadRequest'
11427+
"403":
11428+
$ref: '#/responses/Forbidden'
11429+
"500":
11430+
$ref: '#/responses/InternalServerError'
11431+
summary: Rename the network address set
11432+
tags:
11433+
- network-address-sets
11434+
put:
11435+
consumes:
11436+
- application/json
11437+
description: Updates the entire network address set configuration.
11438+
operationId: network_address_set_put
11439+
parameters:
11440+
- description: Project name
11441+
example: default
11442+
in: query
11443+
name: project
11444+
type: string
11445+
- description: Address set configuration
11446+
in: body
11447+
name: address set
11448+
required: true
11449+
schema:
11450+
$ref: '#/definitions/NetworkAddressSetPut'
11451+
produces:
11452+
- application/json
11453+
responses:
11454+
"200":
11455+
$ref: '#/responses/EmptySyncResponse'
11456+
"400":
11457+
$ref: '#/responses/BadRequest'
11458+
"403":
11459+
$ref: '#/responses/Forbidden'
11460+
"412":
11461+
$ref: '#/responses/PreconditionFailed'
11462+
"500":
11463+
$ref: '#/responses/InternalServerError'
11464+
summary: Update the network address set
11465+
tags:
11466+
- network-address-sets
11467+
/1.0/network-address-sets?recursion=1:
11468+
get:
11469+
description: Returns a list of network address sets (structs).
11470+
operationId: network_address_sets_get_recursion1
11471+
parameters:
11472+
- description: Project name
11473+
example: default
11474+
in: query
11475+
name: project
11476+
type: string
11477+
- description: Retrieve network address sets from all projects
11478+
example: true
11479+
in: query
11480+
name: all-projects
11481+
type: boolean
11482+
- description: Collection filter
11483+
example: default
11484+
in: query
11485+
name: filter
11486+
type: string
11487+
produces:
11488+
- application/json
11489+
summary: Get the network address sets
11490+
tags:
11491+
- network-address-sets
1111511492
/1.0/network-allocations:
1111611493
get:
1111711494
description: Returns a list of network allocations.

0 commit comments

Comments
 (0)