Skip to content
GitLab
Verified Commit 44ad4892 authored by Côme Chilliet's avatar Côme Chilliet
Browse files

:sparkles: feat(webservice) Document the new b64 option for searched attributes 

issue #6014
parent 5ff88b90
dev 6104-mail-methods-refactor 6231-give-the-ability-to-the-webservice-to-notice-if-an-attribute-is-monovalued-or-multivalued 6237-add-requiredattrs-array-to-the-webservice-informations 6245-adapt-the-ci-to-the-reorganisation-of-the-dev-tools-and-fixing-the-trigger-downstream-pipelines 6250-supann-configuration-backend-requires-account-life-cycle-section 6280-plugins-update-plugins-to-take-into-consideration-the-new-directory-of-core-structure 6310-tasks-reminder-error-in-the-schema-duplicate-attribute-id 6311-put-the-version-1-5-in-all-yaml-for-fusiondirectory-1-5 6322-template-issue-when-creating-a-template-with-empty-password-error-message-should-not-be-seen-2 6332-zimbra-allows-update-of-data-for-unknown-domain-name-for-specific-individual-aliases 6337-webservice-issue-with-archiving-post-request-not-responding-but-successfully-archiving-user 6341-supann-extract-resources-states-sub-states-from-backend-configuration-to-their-own-objects 6346-lifecycle-adaptation-to-select-supann-resources-and-related-states-via-regex-mechanism master fusiondirectory-1.5 fusiondirectory-1.4
No related merge requests found
Hide whitespace changes
Inline Side-by-side
Showing
with 9 additions and 3 deletions
+9 -3
webservice/contrib/docs/jsonrpc.php.doc
+ 4
− 2
View file @ 44ad4892
...@@ -67,9 +67,11 @@ class fdRPCService ...@@ -67,9 +67,11 @@ class fdRPCService
* \param string $type the objectType to list * \param string $type the objectType to list
* \param mixed $attrs The attributes to fetch. * \param mixed $attrs The attributes to fetch.
* If this is a single value, the resulting associative array will have for each dn the value of this attribute. * If this is a single value, the resulting associative array will have for each dn the value of this attribute.
* If this is an array, the keys must be the wanted attributes, and the values can be either 1, '*' or 'raw' * If this is an array, the keys must be the wanted attributes, and the values can be either 1, '*', 'b64' or 'raw'
* depending if you want a single value or an array of values. 'raw' means untouched LDAP value and is only useful for dns. * depending if you want a single value or an array of values.
* Other values are considered to be 1. * Other values are considered to be 1.
* 'raw' means untouched LDAP value and is only useful for dns.
* 'b64' means an array of base64 encoded values and is mainly useful for binary attributes.
* \param string $ou the LDAP branch to search in, base will be used if it is NULL * \param string $ou the LDAP branch to search in, base will be used if it is NULL
* \param string $filter an additional filter to use in the LDAP search. * \param string $filter an additional filter to use in the LDAP search.
* *
......
webservice/html/openapi.yaml
+ 5
− 1
View file @ 44ad4892
...@@ -235,7 +235,11 @@ paths: ...@@ -235,7 +235,11 @@ paths:
- name: attrs - name: attrs
in: query in: query
required: false required: false
description: The attributes to return description: "The attributes to return: the keys must be the wanted attributes,
and the values can be either 1, '*', 'b64' or 'raw' depending if you want a
single value or an array of values. Other values are considered to be 1.
'raw' means untouched LDAP value and is only useful for dns.
'b64' means an array of base64 encoded values and is mainly useful for binary attributes."
schema: schema:
type: object type: object
example: example:
......
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment