jackrabbit-oak-issues mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From "Alexander Klimetschek (JIRA)" <j...@apache.org>
Subject [jira] [Updated] (OAK-7695) [DirectBinaryAccess] Fix and improve javadocs of new API
Date Wed, 08 Aug 2018 17:09:00 GMT

     [ https://issues.apache.org/jira/browse/OAK-7695?page=com.atlassian.jira.plugin.system.issuetabpanels:all-tabpanel
]

Alexander Klimetschek updated OAK-7695:
---------------------------------------
    Description: 
Here are some changes to the javadocs for the new API: [OAK-7569-api-javadoc-improvements.patch|https://issues.apache.org/jira/secure/attachment/12934364/12934364_OAK-7569-api-javadoc-improvements.patch]

* more concise descriptions
* correcting some inaccuracies (clients cannot choose whether to do single or multipart upload,
multipart might be strictly required depending on the size)
* most importantly the upload algorithm (standard partSize calculation was wrong)
* focus on API users, separated notes to implementors
* for BinaryDownloadOptions added note from which jcr properties a client would normally take
these values from
* added security considerations

  was:
Here are some changes to the javadocs for the new API: [^OAK-7569-api-javadoc-improvements.patch]

* more concise descriptions
* correcting some inaccuracies (clients cannot choose whether to do single or multipart upload,
multipart might be strictly required depending on the size)
* most importantly the upload algorithm (standard partSize calculation was wrong)
* focus on API users, separated notes to implementors
* for BinaryDownloadOptions added note from which jcr properties a client would normally take
these values from
* added security considerations


> [DirectBinaryAccess] Fix and improve javadocs of new API
> --------------------------------------------------------
>
>                 Key: OAK-7695
>                 URL: https://issues.apache.org/jira/browse/OAK-7695
>             Project: Jackrabbit Oak
>          Issue Type: Technical task
>          Components: api
>            Reporter: Alexander Klimetschek
>            Assignee: Alexander Klimetschek
>            Priority: Major
>
> Here are some changes to the javadocs for the new API: [OAK-7569-api-javadoc-improvements.patch|https://issues.apache.org/jira/secure/attachment/12934364/12934364_OAK-7569-api-javadoc-improvements.patch]
> * more concise descriptions
> * correcting some inaccuracies (clients cannot choose whether to do single or multipart
upload, multipart might be strictly required depending on the size)
> * most importantly the upload algorithm (standard partSize calculation was wrong)
> * focus on API users, separated notes to implementors
> * for BinaryDownloadOptions added note from which jcr properties a client would normally
take these values from
> * added security considerations



--
This message was sent by Atlassian JIRA
(v7.6.3#76005)

Mime
View raw message