docs(api): correct Admin AccessToken API reference against implementation (15.7)#382
Merged
Merged
Conversation
…tion (15.7)
Verified the Admin AccessToken API documentation against the source
(ApiAdminAccesstokenAction, CreateForm/EditForm, AccessTokenService,
BaseSearchBody, and fess_config.properties) and fixed inaccuracies.
- List parameters: default `size` is 25 (paging.page.size), not 20; `page`
is 1-based with default 1, not 0-based. Added the `id` filter parameter.
- Responses: documented the full token object fields actually returned
(createdBy/createdTime/updatedBy/updatedTime/versionNo), noted that
null fields are omitted and `permissions` is a newline-separated string,
and included the `version` envelope field.
- Create: clarified that the token string is always generated server-side
(a supplied `token` is ignored) and is not returned in the create response.
- Update: documented `id` and `versionNo` as required; `token` is immutable.
- Corrected `parameterName`: it names a request parameter whose values are
merged into the token permissions, and has no default of "token".
- Auth: noted the token must match `api.admin.access.permissions`
(default `{role}admin-api`).
- Replaced the deprecated `/json/` search example with `/api/v2/search`.
- Fixed list-table `:widths:` to match their column counts.
Applied the same corrections to all languages (en, de, es, fr, ko, zh-cn).
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Reviewed the Admin AccessToken API documentation (
15.7/api/admin/api-admin-accesstoken.rst) against the actual implementation and corrected several inaccuracies. The same fixes are applied across all languages (ja, en, de, es, fr, ko, zh-cn).Source of truth verified
ApiAdminAccesstokenAction(@Executemethods, token generation, response envelope)CreateForm/EditForm(required/optional fields, validation)AccessTokenService.getPermissions()(actualparameterNamebehavior)BaseSearchBody+fess_config.properties(paging.page.size,api.admin.access.permissions,api.access.token.request.parameter)Fixes
sizedefaultpaging.page.size)pageparameterNametoken"tokenon createtokenis ignored; not returned in the create responsetokenon update/json/?q=.../api/v2/search?q=...Additions
createdBy,createdTime,updatedBy,updatedTime,versionNo); notednullfields are omitted andpermissionsis newline-separated.idlist filter parameter and theversionresponse-envelope field.idandversionNoas required on update.api.admin.access.permissions(default{role}admin-api).list-table:widths:so the column counts match (was rendering-broken).Verification
jafiles.