control-service: Data Jobs API documentation changes - #77
Merged
Conversation
Documentation revised. API license specified. API descriptions changes. Data Job Development Lifecycle diagram added. Testing Done: model generated Signed-off-by: ikoleva <ikoleva@vmware.com>
doks5
previously requested changes
Aug 12, 2021
antoniivanov
approved these changes
Aug 12, 2021
antoniivanov
left a comment
antoniivanov
left a comment
Contributor
There was a problem hiding this comment.
Looks good to me.
My only issue is that I am not sure the Lifecycle.png image would render in swagger.
mrMoZ1
reviewed
Aug 12, 2021
mrMoZ1
reviewed
Aug 12, 2021
mrMoZ1
reviewed
Aug 12, 2021
mrMoZ1
reviewed
Aug 12, 2021
Documentation revised. API license specified. API descriptions changes. Data Job Development Lifecycle diagram added. Testing Done: model generated Signed-off-by: ikoleva <ikoleva@vmware.com>
Documentation revised. API license specified. API descriptions changes. Data Job Development Lifecycle diagram added. Testing Done: model generated, control-service started locally to verify Swagger docs Signed-off-by: ikoleva <ikoleva@vmware.com>
Documentation revised. API license specified. API descriptions changes. Data Job Development Lifecycle diagram added. Testing Done: model generated, control-service started locally to verify Swagger docs Signed-off-by: ikoleva <ikoleva@vmware.com>
Documentation revised. Data Jobs Deployment Lifecycle state diagram added to the Wiki, and expected to be publicly accessible, after publishing the project. API license specified. API descriptions changes. Data Job Development Lifecycle diagram added. Testing Done: model generated, control-service started locally to verify Swagger docs Signed-off-by: ikoleva <ikoleva@vmware.com>
ivakoleva
dismissed
doks5’s stale review
August 18, 2021 13:22
Did agree to incremental changes with Dako Dakov
# Conflicts: # projects/control-service/projects/model/apidefs/datajob-api/api.yaml
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
5 participants
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.
Documentation revised.
API license specified. API descriptions changes.
Data Job Development Lifecycle diagram added.
Testing Done: model generated; what needs to be verified is the relative image included is visualised properly (did consider including base64 directly, however it is quite some data to paste into docs).
An open question is, do we need to edit:
"sourceUrl": "https://github.com/product-analytics/data-jobs/tree/master/starshot-processing-vmc-fact-daily",