Skip to content
This repository has been archived by the owner on Nov 9, 2020. It is now read-only.

WIP: API specification for Column REST service #20

Open
wants to merge 1 commit into
base: master
Choose a base branch
from

Conversation

kars7e
Copy link
Contributor

@kars7e kars7e commented Jun 15, 2017

This WIP for API specification for column REST service. all comments & feedback welcome!


This change is Reviewable

@vmwclabot
Copy link

@kars7e, you must sign every commit in this pull request acknowledging our Developer Certificate of Origin before your changes are merged. This can be done by adding Signed-off-by: John Doe <john.doe@email.org> to the last line of each Git commit message. The e-mail address used to sign must match the e-mail address of the Git author. Click here to view the Developer Certificate of Origin agreement.

options:
type: "object"
$ref: '#/definitions/Options'
extra_vars:
Copy link
Contributor

Choose a reason for hiding this comment

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

why is extra_vars out of 'options' ?

Copy link
Contributor

@sihanwang41 sihanwang41 left a comment

Choose a reason for hiding this comment

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

i didn't find the ssh_extra_args, scp_extra_args, sftp_extra_args and ssh_common_args in the swager file.

- http
basePath: /v1
paths:
/tasks:
Copy link
Contributor

Choose a reason for hiding this comment

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

I think "tasks" might be confused with Ansible tasks in a playbook. Rather some other noun not already used such as "job", "run", etc

Copy link
Contributor

Choose a reason for hiding this comment

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

yes, 'run' would be better.
I will pushed a scratch patch by using flask api.

info:
description: Column - Ansible as a service
title: Column
version: 0.0.1
Copy link
Contributor

Choose a reason for hiding this comment

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

Is this supposed to be a separate version from column version?

type: array
skip_tags:
type: array
susbset:
Copy link
Contributor

Choose a reason for hiding this comment

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

Should be subset

get:
summary: "Retrieve Task by its ID"
description: "Returns single task given its ID"
operationID: "getTaskByID"
Copy link
Contributor

Choose a reason for hiding this comment

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

some parameters are using camelcase others using underscore (playbook_path)

Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

4 participants