Skip to content

Commit

Permalink
Merge pull request #39641 from nextcloud/fix/openapi
Browse files Browse the repository at this point in the history 
Fix OpenAPI specs
  • Loading branch information
@julien-nc
julien-nc committed Aug 3, 2023
2 parents c7c94a3 + 89c941f commit 15e2ca2
Show file tree
Hide file tree
Showing 5 changed files with 61 additions and 53 deletions.
8 changes: 6 additions & 2 deletions apps/dashboard/openapi.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -231,11 +231,15 @@
}
},
{
"name": "widgets",
"name": "widgets[]",
"in": "query",
"description": "Limit results to specific widgets",
"schema": {
"type": "string"
"type": "array",
"default": [],
"items": {
"type": "string"
}
}
},
{
Expand Down
25 changes: 18 additions & 7 deletions apps/provisioning_api/openapi.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -1781,19 +1781,27 @@
}
},
{
"name": "groups",
"name": "groups[]",
"in": "query",
"description": "Groups of the user",
"schema": {
"type": "string"
"type": "array",
"default": [],
"items": {
"type": "string"
}
}
},
{
"name": "subadmin",
"name": "subadmin[]",
"in": "query",
"description": "Groups where the user is subadmin",
"schema": {
"type": "string"
"type": "array",
"default": [],
"items": {
"type": "string"
}
}
},
{
Expand Down Expand Up @@ -3563,7 +3571,7 @@
{
"name": "app",
"in": "path",
"description": "ID if the app",
"description": "ID of the app",
"required": true,
"schema": {
"type": "string"
Expand Down Expand Up @@ -4260,12 +4268,15 @@
],
"parameters": [
{
"name": "configKeys",
"name": "configKeys[]",
"in": "query",
"description": "Keys to delete",
"required": true,
"schema": {
"type": "string"
"type": "array",
"items": {
"type": "string"
}
}
},
{
Expand Down
2 changes: 1 addition & 1 deletion apps/user_ldap/openapi.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -120,7 +120,7 @@
"get": {
"operationId": "configapi-show",
"summary": "Get a configuration",
"description": "This endpoint requires admin access",
"description": "Output can look like this: <?xml version=\"1.0\"?> <ocs> <meta> <status>ok</status> <statuscode>200</statuscode> <message>OK</message> </meta> <data> <ldapHost>ldaps://my.ldap.server</ldapHost> <ldapPort>7770</ldapPort> <ldapBackupHost></ldapBackupHost> <ldapBackupPort></ldapBackupPort> <ldapBase>ou=small,dc=my,dc=ldap,dc=server</ldapBase> <ldapBaseUsers>ou=users,ou=small,dc=my,dc=ldap,dc=server</ldapBaseUsers> <ldapBaseGroups>ou=small,dc=my,dc=ldap,dc=server</ldapBaseGroups> <ldapAgentName>cn=root,dc=my,dc=ldap,dc=server</ldapAgentName> <ldapAgentPassword>clearTextWithShowPassword=1</ldapAgentPassword> <ldapTLS>1</ldapTLS> <turnOffCertCheck>0</turnOffCertCheck> <ldapIgnoreNamingRules/> <ldapUserDisplayName>displayname</ldapUserDisplayName> <ldapUserDisplayName2>uid</ldapUserDisplayName2> <ldapUserFilterObjectclass>inetOrgPerson</ldapUserFilterObjectclass> <ldapUserFilterGroups></ldapUserFilterGroups> <ldapUserFilter>(&amp;(objectclass=nextcloudUser)(nextcloudEnabled=TRUE))</ldapUserFilter> <ldapUserFilterMode>1</ldapUserFilterMode> <ldapGroupFilter>(&amp;(|(objectclass=nextcloudGroup)))</ldapGroupFilter> <ldapGroupFilterMode>0</ldapGroupFilterMode> <ldapGroupFilterObjectclass>nextcloudGroup</ldapGroupFilterObjectclass> <ldapGroupFilterGroups></ldapGroupFilterGroups> <ldapGroupDisplayName>cn</ldapGroupDisplayName> <ldapGroupMemberAssocAttr>memberUid</ldapGroupMemberAssocAttr> <ldapLoginFilter>(&amp;(|(objectclass=inetOrgPerson))(uid=%uid))</ldapLoginFilter> <ldapLoginFilterMode>0</ldapLoginFilterMode> <ldapLoginFilterEmail>0</ldapLoginFilterEmail> <ldapLoginFilterUsername>1</ldapLoginFilterUsername> <ldapLoginFilterAttributes></ldapLoginFilterAttributes> <ldapQuotaAttribute></ldapQuotaAttribute> <ldapQuotaDefault></ldapQuotaDefault> <ldapEmailAttribute>mail</ldapEmailAttribute> <ldapCacheTTL>20</ldapCacheTTL> <ldapUuidUserAttribute>auto</ldapUuidUserAttribute> <ldapUuidGroupAttribute>auto</ldapUuidGroupAttribute> <ldapOverrideMainServer></ldapOverrideMainServer> <ldapConfigurationActive>1</ldapConfigurationActive> <ldapAttributesForUserSearch>uid;sn;givenname</ldapAttributesForUserSearch> <ldapAttributesForGroupSearch></ldapAttributesForGroupSearch> <ldapExperiencedAdmin>0</ldapExperiencedAdmin> <homeFolderNamingRule></homeFolderNamingRule> <hasMemberOfFilterSupport></hasMemberOfFilterSupport> <useMemberOfToDetectMembership>1</useMemberOfToDetectMembership> <ldapExpertUsernameAttr>uid</ldapExpertUsernameAttr> <ldapExpertUUIDUserAttr>uid</ldapExpertUUIDUserAttr> <ldapExpertUUIDGroupAttr></ldapExpertUUIDGroupAttr> <lastJpegPhotoLookup>0</lastJpegPhotoLookup> <ldapNestedGroups>0</ldapNestedGroups> <ldapPagingSize>500</ldapPagingSize> <turnOnPasswordChange>1</turnOnPasswordChange> <ldapDynamicGroupMemberURL></ldapDynamicGroupMemberURL> </data> </ocs>\nThis endpoint requires admin access",
"tags": [
"configapi"
],
Expand Down
7 changes: 5 additions & 2 deletions apps/weather_status/openapi.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -847,12 +847,15 @@
],
"parameters": [
{
"name": "favorites",
"name": "favorites[]",
"in": "query",
"description": "Favorite addresses",
"required": true,
"schema": {
"type": "string"
"type": "array",
"items": {
"type": "string"
}
}
},
{
Expand Down
72 changes: 31 additions & 41 deletions core/openapi.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -394,28 +394,8 @@
"type": "string"
},
"status": {
"oneOf": [
{
"type": "integer",
"format": "int64"
},
{
"type": "integer",
"format": "int64"
},
{
"type": "integer",
"format": "int64"
},
{
"type": "integer",
"format": "int64"
},
{
"type": "integer",
"format": "int64"
}
]
"type": "integer",
"format": "int64"
},
"userId": {
"type": "string",
Expand Down Expand Up @@ -1628,11 +1608,15 @@
}
},
{
"name": "shareTypes",
"name": "shareTypes[]",
"in": "query",
"description": "Types of shares to search for",
"schema": {
"type": "string"
"type": "array",
"items": {
"type": "integer",
"format": "int64"
}
}
},
{
Expand Down Expand Up @@ -3251,12 +3235,15 @@
],
"parameters": [
{
"name": "references",
"name": "references[]",
"in": "query",
"description": "References to resolve",
"required": true,
"schema": {
"type": "string"
"type": "array",
"items": {
"type": "string"
}
}
},
{
Expand Down Expand Up @@ -4300,21 +4287,24 @@
],
"properties": {
"types": {
"type": "object",
"required": [
"id",
"name",
"description"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
"type": "array",
"items": {
"type": "object",
"required": [
"id",
"name",
"description"
],
"properties": {
"id": {
"type": "string"
},
"name": {
"type": "string"
},
"description": {
"type": "string"
}
}
}
}
Expand Down

0 comments on commit 15e2ca2

Please sign in to comment.