You are viewing a plain text version of this content. The canonical link for it is here.
Posted to issues@flink.apache.org by GitBox <gi...@apache.org> on 2020/04/07 13:39:34 UTC

[GitHub] [flink] zentol opened a new pull request #11658: [FLINK-16696][rest] Properly document async responses

zentol opened a new pull request #11658: [FLINK-16696][rest] Properly document async responses 
URL: https://github.com/apache/flink/pull/11658
 
 
   Fixes an issue where the REST API status response for asynchronous operations wasn't documented properly.
   
   The async operation result has a generic parameter, which obviously doesn't work with the REST API generation since it relies on classes. As a result the generator always considered the inner (generic) result as an `Object`, basically not documenting anything.
   
   This PR provides a stop-gap solution by hard-coding additional logic for `AsynchronousOperationStatusMessageHeaders`.
   I exposed the inner class by making `AsynchronousOperationStatusMessageHeaders#getValueClass` public, generate a separate schema for it, and overwrite the corresponding property entry of the outer schema.
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [flink] zentol merged pull request #11658: [FLINK-16696][rest] Properly document async responses

Posted by GitBox <gi...@apache.org>.
zentol merged pull request #11658: [FLINK-16696][rest] Properly document async responses 
URL: https://github.com/apache/flink/pull/11658
 
 
   

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [flink] flinkbot commented on issue #11658: [FLINK-16696][rest] Properly document async responses

Posted by GitBox <gi...@apache.org>.
flinkbot commented on issue #11658: [FLINK-16696][rest] Properly document async responses 
URL: https://github.com/apache/flink/pull/11658#issuecomment-610407691
 
 
   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "61b35088fbb874de965dfb0fb7f2672a041786e4",
       "status" : "UNKNOWN",
       "url" : "TBD",
       "triggerID" : "61b35088fbb874de965dfb0fb7f2672a041786e4",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * 61b35088fbb874de965dfb0fb7f2672a041786e4 UNKNOWN
   
   <details>
   <summary>Bot commands</summary>
     The @flinkbot bot supports the following commands:
   
    - `@flinkbot run travis` re-run the last Travis build
    - `@flinkbot run azure` re-run the last Azure build
   </details>

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [flink] flinkbot edited a comment on issue #11658: [FLINK-16696][rest] Properly document async responses

Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on issue #11658: [FLINK-16696][rest] Properly document async responses 
URL: https://github.com/apache/flink/pull/11658#issuecomment-610407691
 
 
   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "61b35088fbb874de965dfb0fb7f2672a041786e4",
       "status" : "PENDING",
       "url" : "https://travis-ci.com/github/flink-ci/flink/builds/159061930",
       "triggerID" : "61b35088fbb874de965dfb0fb7f2672a041786e4",
       "triggerType" : "PUSH"
     }, {
       "hash" : "61b35088fbb874de965dfb0fb7f2672a041786e4",
       "status" : "PENDING",
       "url" : "https://dev.azure.com/rmetzger/5bd3ef0a-4359-41af-abca-811b04098d2e/_build/results?buildId=7163",
       "triggerID" : "61b35088fbb874de965dfb0fb7f2672a041786e4",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * 61b35088fbb874de965dfb0fb7f2672a041786e4 Travis: [PENDING](https://travis-ci.com/github/flink-ci/flink/builds/159061930) Azure: [PENDING](https://dev.azure.com/rmetzger/5bd3ef0a-4359-41af-abca-811b04098d2e/_build/results?buildId=7163) 
   
   <details>
   <summary>Bot commands</summary>
     The @flinkbot bot supports the following commands:
   
    - `@flinkbot run travis` re-run the last Travis build
    - `@flinkbot run azure` re-run the last Azure build
   </details>

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [flink] flinkbot edited a comment on issue #11658: [FLINK-16696][rest] Properly document async responses

Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on issue #11658: [FLINK-16696][rest] Properly document async responses 
URL: https://github.com/apache/flink/pull/11658#issuecomment-610407691
 
 
   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "61b35088fbb874de965dfb0fb7f2672a041786e4",
       "status" : "SUCCESS",
       "url" : "https://travis-ci.com/github/flink-ci/flink/builds/159061930",
       "triggerID" : "61b35088fbb874de965dfb0fb7f2672a041786e4",
       "triggerType" : "PUSH"
     }, {
       "hash" : "61b35088fbb874de965dfb0fb7f2672a041786e4",
       "status" : "PENDING",
       "url" : "https://dev.azure.com/rmetzger/5bd3ef0a-4359-41af-abca-811b04098d2e/_build/results?buildId=7163",
       "triggerID" : "61b35088fbb874de965dfb0fb7f2672a041786e4",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * 61b35088fbb874de965dfb0fb7f2672a041786e4 Travis: [SUCCESS](https://travis-ci.com/github/flink-ci/flink/builds/159061930) Azure: [PENDING](https://dev.azure.com/rmetzger/5bd3ef0a-4359-41af-abca-811b04098d2e/_build/results?buildId=7163) 
   
   <details>
   <summary>Bot commands</summary>
     The @flinkbot bot supports the following commands:
   
    - `@flinkbot run travis` re-run the last Travis build
    - `@flinkbot run azure` re-run the last Azure build
   </details>

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [flink] flinkbot commented on issue #11658: [FLINK-16696][rest] Properly document async responses

Posted by GitBox <gi...@apache.org>.
flinkbot commented on issue #11658: [FLINK-16696][rest] Properly document async responses 
URL: https://github.com/apache/flink/pull/11658#issuecomment-610394736
 
 
   Thanks a lot for your contribution to the Apache Flink project. I'm the @flinkbot. I help the community
   to review your pull request. We will use this comment to track the progress of the review.
   
   
   ## Automated Checks
   Last check on commit 61b35088fbb874de965dfb0fb7f2672a041786e4 (Tue Apr 07 13:43:24 UTC 2020)
   
   **Warnings:**
    * No documentation files were touched! Remember to keep the Flink docs up to date!
   
   
   <sub>Mention the bot in a comment to re-run the automated checks.</sub>
   ## Review Progress
   
   * ❓ 1. The [description] looks good.
   * ❓ 2. There is [consensus] that the contribution should go into to Flink.
   * ❓ 3. Needs [attention] from.
   * ❓ 4. The change fits into the overall [architecture].
   * ❓ 5. Overall code [quality] is good.
   
   Please see the [Pull Request Review Guide](https://flink.apache.org/contributing/reviewing-prs.html) for a full explanation of the review process.<details>
    The Bot is tracking the review progress through labels. Labels are applied according to the order of the review items. For consensus, approval by a Flink committer of PMC member is required <summary>Bot commands</summary>
     The @flinkbot bot supports the following commands:
   
    - `@flinkbot approve description` to approve one or more aspects (aspects: `description`, `consensus`, `architecture` and `quality`)
    - `@flinkbot approve all` to approve all aspects
    - `@flinkbot approve-until architecture` to approve everything until `architecture`
    - `@flinkbot attention @username1 [@username2 ..]` to require somebody's attention
    - `@flinkbot disapprove architecture` to remove an approval you gave earlier
   </details>

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services

[GitHub] [flink] flinkbot edited a comment on issue #11658: [FLINK-16696][rest] Properly document async responses

Posted by GitBox <gi...@apache.org>.
flinkbot edited a comment on issue #11658: [FLINK-16696][rest] Properly document async responses 
URL: https://github.com/apache/flink/pull/11658#issuecomment-610407691
 
 
   <!--
   Meta data
   {
     "version" : 1,
     "metaDataEntries" : [ {
       "hash" : "61b35088fbb874de965dfb0fb7f2672a041786e4",
       "status" : "SUCCESS",
       "url" : "https://travis-ci.com/github/flink-ci/flink/builds/159061930",
       "triggerID" : "61b35088fbb874de965dfb0fb7f2672a041786e4",
       "triggerType" : "PUSH"
     }, {
       "hash" : "61b35088fbb874de965dfb0fb7f2672a041786e4",
       "status" : "SUCCESS",
       "url" : "https://dev.azure.com/rmetzger/5bd3ef0a-4359-41af-abca-811b04098d2e/_build/results?buildId=7163",
       "triggerID" : "61b35088fbb874de965dfb0fb7f2672a041786e4",
       "triggerType" : "PUSH"
     } ]
   }-->
   ## CI report:
   
   * 61b35088fbb874de965dfb0fb7f2672a041786e4 Travis: [SUCCESS](https://travis-ci.com/github/flink-ci/flink/builds/159061930) Azure: [SUCCESS](https://dev.azure.com/rmetzger/5bd3ef0a-4359-41af-abca-811b04098d2e/_build/results?buildId=7163) 
   
   <details>
   <summary>Bot commands</summary>
     The @flinkbot bot supports the following commands:
   
    - `@flinkbot run travis` re-run the last Travis build
    - `@flinkbot run azure` re-run the last Azure build
   </details>

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services