Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

control-service: Data Jobs API documentation changes #77

Merged
merged 7 commits into from
Aug 18, 2021

Conversation

ivakoleva
Copy link
Contributor

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",

Documentation revised.

API license specified. API descriptions changes.
Data Job Development Lifecycle diagram added.

Testing Done: model generated

Signed-off-by: ikoleva <[email protected]>
Copy link
Collaborator

@antoniivanov antoniivanov left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me.

My only issue is that I am not sure the Lifecycle.png image would render in swagger.

Documentation revised.

API license specified. API descriptions changes.
Data Job Development Lifecycle diagram added.

Testing Done: model generated

Signed-off-by: ikoleva <[email protected]>
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 <[email protected]>
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 <[email protected]>
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 <[email protected]>
@ivakoleva ivakoleva requested a review from doks5 August 18, 2021 13:20
@ivakoleva 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
@ivakoleva ivakoleva enabled auto-merge (squash) August 18, 2021 14:20
@ivakoleva ivakoleva merged commit d1dbb25 into main Aug 18, 2021
@ivakoleva ivakoleva deleted the person/ikoleva/api_docs_changes branch August 18, 2021 14:27
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants