mirror of https://github.com/portainer/portainer
docs(api): update Swagger documentation
parent
50f547a6e7
commit
d55212e9da
|
@ -2964,7 +2964,29 @@ definitions:
|
||||||
type: "string"
|
type: "string"
|
||||||
example: "member"
|
example: "member"
|
||||||
description: "LDAP attribute which denotes the group membership."
|
description: "LDAP attribute which denotes the group membership."
|
||||||
|
UserAccessPolicies:
|
||||||
|
type: "object"
|
||||||
|
description: "User access policies associated to a registry/endpoint/endpoint group. RoleID is not required for registry access policies and can be set to 0."
|
||||||
|
additionalProperties:
|
||||||
|
$ref: "#/definitions/AccessPolicy"
|
||||||
|
example:
|
||||||
|
1: { RoleID: 1 }
|
||||||
|
2: { RoleID: 3 }
|
||||||
|
TeamAccessPolicies:
|
||||||
|
type: "object"
|
||||||
|
description: "Team access policies associated to a registry/endpoint/endpoint group. RoleID is not required for registry access policies and can be set to 0."
|
||||||
|
additionalProperties:
|
||||||
|
$ref: "#/definitions/AccessPolicy"
|
||||||
|
example:
|
||||||
|
1: { RoleID: 1 }
|
||||||
|
2: { RoleID: 3 }
|
||||||
|
AccessPolicy:
|
||||||
|
type: "object"
|
||||||
|
properties:
|
||||||
|
RoleID:
|
||||||
|
type: "integer"
|
||||||
|
example: "1"
|
||||||
|
description: "Role identifier. Reference the role that will be associated to this access policy"
|
||||||
LDAPSettings:
|
LDAPSettings:
|
||||||
type: "object"
|
type: "object"
|
||||||
properties:
|
properties:
|
||||||
|
@ -3416,40 +3438,10 @@ definitions:
|
||||||
type: "string"
|
type: "string"
|
||||||
example: "cOrXoK/1D35w8YQ8nH1/8ZGwzz45JIYD5jxHKXEQknk="
|
example: "cOrXoK/1D35w8YQ8nH1/8ZGwzz45JIYD5jxHKXEQknk="
|
||||||
description: "Azure authentication key"
|
description: "Azure authentication key"
|
||||||
EndpointAccessUpdateRequest:
|
UserAccessPolicies:
|
||||||
type: "object"
|
$ref: "#/definitions/UserAccessPolicies"
|
||||||
properties:
|
TeamAccessPolicies:
|
||||||
AuthorizedUsers:
|
$ref: "#/definitions/TeamAccessPolicies"
|
||||||
type: "array"
|
|
||||||
description: "List of user identifiers authorized to connect to this endpoint"
|
|
||||||
items:
|
|
||||||
type: "integer"
|
|
||||||
example: 1
|
|
||||||
description: "User identifier"
|
|
||||||
AuthorizedTeams:
|
|
||||||
type: "array"
|
|
||||||
description: "List of team identifiers authorized to connect to this endpoint"
|
|
||||||
items:
|
|
||||||
type: "integer"
|
|
||||||
example: 1
|
|
||||||
description: "Team identifier"
|
|
||||||
EndpointGroupAccessUpdateRequest:
|
|
||||||
type: "object"
|
|
||||||
properties:
|
|
||||||
AuthorizedUsers:
|
|
||||||
type: "array"
|
|
||||||
description: "List of user identifiers authorized to connect to this endpoint"
|
|
||||||
items:
|
|
||||||
type: "integer"
|
|
||||||
example: 1
|
|
||||||
description: "User identifier"
|
|
||||||
AuthorizedTeams:
|
|
||||||
type: "array"
|
|
||||||
description: "List of team identifiers authorized to connect to this endpoint"
|
|
||||||
items:
|
|
||||||
type: "integer"
|
|
||||||
example: 1
|
|
||||||
description: "Team identifier"
|
|
||||||
RegistryCreateRequest:
|
RegistryCreateRequest:
|
||||||
type: "object"
|
type: "object"
|
||||||
required:
|
required:
|
||||||
|
@ -3514,23 +3506,10 @@ definitions:
|
||||||
type: "string"
|
type: "string"
|
||||||
example: "registry_password"
|
example: "registry_password"
|
||||||
description: "Password used to authenticate against this registry"
|
description: "Password used to authenticate against this registry"
|
||||||
RegistryAccessUpdateRequest:
|
UserAccessPolicies:
|
||||||
type: "object"
|
$ref: "#/definitions/UserAccessPolicies"
|
||||||
properties:
|
TeamAccessPolicies:
|
||||||
AuthorizedUsers:
|
$ref: "#/definitions/TeamAccessPolicies"
|
||||||
type: "array"
|
|
||||||
description: "List of user identifiers authorized to use thi registry"
|
|
||||||
items:
|
|
||||||
type: "integer"
|
|
||||||
example: 1
|
|
||||||
description: "User identifier"
|
|
||||||
AuthorizedTeams:
|
|
||||||
type: "array"
|
|
||||||
description: "List of team identifiers authorized to use thi registry"
|
|
||||||
items:
|
|
||||||
type: "integer"
|
|
||||||
example: 1
|
|
||||||
description: "Team identifier"
|
|
||||||
ResourceControlCreateRequest:
|
ResourceControlCreateRequest:
|
||||||
type: "object"
|
type: "object"
|
||||||
required:
|
required:
|
||||||
|
@ -3681,6 +3660,10 @@ definitions:
|
||||||
type: "integer"
|
type: "integer"
|
||||||
example: 1
|
example: 1
|
||||||
description: "Endpoint identifier"
|
description: "Endpoint identifier"
|
||||||
|
UserAccessPolicies:
|
||||||
|
$ref: "#/definitions/UserAccessPolicies"
|
||||||
|
TeamAccessPolicies:
|
||||||
|
$ref: "#/definitions/TeamAccessPolicies"
|
||||||
UserCreateRequest:
|
UserCreateRequest:
|
||||||
type: "object"
|
type: "object"
|
||||||
required:
|
required:
|
||||||
|
|
Loading…
Reference in New Issue