Skip to content

Commit e7ed20d

Browse files
committed
update openAPI & docs
1 parent 98f6ca8 commit e7ed20d

File tree

5 files changed

+37
-14
lines changed

5 files changed

+37
-14
lines changed

daikoku/public/swaggers/admin-api-openapi.json

+9-2
Original file line numberDiff line numberDiff line change
@@ -865,11 +865,18 @@
865865
"$ref": "#/components/schemas/UserWithPermission"
866866
}
867867
},
868-
"authorizedOtoroshiGroups": {
868+
"authorizedEntities": {
869869
"type": "array",
870870
"nullable": true,
871871
"items": {
872-
"type": "string"
872+
"properties": {
873+
"otoroshiSettingsId": {
874+
"type": "string"
875+
},
876+
"authorizedEntities": {
877+
"$ref": "#/components/schemas/AuthorizedEntities"
878+
}
879+
}
873880
}
874881
},
875882
"apiKeyVisibility": {

daikoku/public/swaggers/admin-api-openapi.yaml

+7-2
Original file line numberDiff line numberDiff line change
@@ -611,11 +611,16 @@ components:
611611
type: array
612612
items:
613613
$ref: '#/components/schemas/UserWithPermission'
614-
authorizedOtoroshiGroups:
614+
authorizedEntities:
615615
type: array
616616
nullable: true
617617
items:
618-
type: string
618+
properties:
619+
otoroshiSettingsId:
620+
type: string
621+
authorizedEntities:
622+
$ref: '#/components/schemas/AuthorizedEntities'
623+
619624
apiKeyVisibility:
620625
type: string
621626
enum:

manual/docs/02-usages/08-tenantusage/2-teams.md

+2-3
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,7 @@
22

33
Go to `settings/Organizations settings` and then click `teams` on the left menu. You should see the list of existing `teams`
44

5-
## Add a new team
6-
7-
Click on the `Create` button.
5+
`Teams` can only be updated (or deleted) by admin, mainly to update metadata or authorizedEntities (2 properties editable only by a tenant admin).
86
A team needs the folowing informations :
97

108
* Tenant (By default, the current tenant)
@@ -13,6 +11,7 @@ A team needs the folowing informations :
1311
* Team contact, an email address for a simple contact
1412
* Team avatar, it could be an URl or an asset from the object manager
1513
* Metadata, some extra informations that will be sent with the api calls with team apikeys
14+
* Authorized entities, a collection of otoroshi entities visible to the team, the others are not accessible.
1615

1716
## Update an existing team
1817
Hover over team's avatar and click the `update` button (Pen icon). All the informations filled during the team creation can be overwritten.

manual/static/openapi/admin-api-openapi.json

+11-4
Original file line numberDiff line numberDiff line change
@@ -865,11 +865,18 @@
865865
"$ref": "#/components/schemas/UserWithPermission"
866866
}
867867
},
868-
"authorizedOtoroshiGroups": {
868+
"authorizedEntities": {
869869
"type": "array",
870870
"nullable": true,
871871
"items": {
872-
"type": "string"
872+
"properties": {
873+
"otoroshiSettingsId": {
874+
"type": "string"
875+
},
876+
"authorizedEntities": {
877+
"$ref": "#/components/schemas/AuthorizedEntities"
878+
}
879+
}
873880
}
874881
},
875882
"apiKeyVisibility": {
@@ -1013,7 +1020,8 @@
10131020
}
10141021
},
10151022
"defaultUsagePlan": {
1016-
"type": "string"
1023+
"type": "string",
1024+
"nullable": true
10171025
},
10181026
"authorizedTeams": {
10191027
"type": "array",
@@ -1076,7 +1084,6 @@
10761084
"documentation",
10771085
"visibility",
10781086
"possibleUsagePlans",
1079-
"defaultUsagePlan",
10801087
"state"
10811088
]
10821089
},

manual/static/openapi/admin-api-openapi.yaml

+8-3
Original file line numberDiff line numberDiff line change
@@ -611,11 +611,16 @@ components:
611611
type: array
612612
items:
613613
$ref: '#/components/schemas/UserWithPermission'
614-
authorizedOtoroshiGroups:
614+
authorizedEntities:
615615
type: array
616616
nullable: true
617617
items:
618-
type: string
618+
properties:
619+
otoroshiSettingsId:
620+
type: string
621+
authorizedEntities:
622+
$ref: '#/components/schemas/AuthorizedEntities'
623+
619624
apiKeyVisibility:
620625
type: string
621626
enum:
@@ -719,6 +724,7 @@ components:
719724
type: string
720725
defaultUsagePlan:
721726
type: string
727+
nullable: true
722728
authorizedTeams:
723729
type: array
724730
nullable: true
@@ -765,7 +771,6 @@ components:
765771
- documentation
766772
- visibility
767773
- possibleUsagePlans
768-
- defaultUsagePlan
769774
- state
770775
ApiIssueTag:
771776
description: ApiIssueTag

0 commit comments

Comments
 (0)