-
Notifications
You must be signed in to change notification settings - Fork 77
correcting yaml cp errors #516
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
correcting yaml cp errors #516
Conversation
d0bfcdb to
00ab5e2
Compare
|
BUILD on-http #2736 : FAILURE
|
|
test this please |
|
Jenkins failed with the following error which has nothing to do with this PR: Error: dihelper incapable of finding specified file for require filename:apache-crypt, directories:(/var/lib/jenkins/jobs/on-http/workspace/build/node_modules/on-core, /var/lib/jenkins/jobs/on-http/workspace/build/node_modules/on-core/lib) |
|
BUILD on-http #2739 : UNSTABLE
|
static/monorail-2.0.yaml
Outdated
| responses: | ||
| 201: | ||
| description: Successfully posted the specified task | ||
| description: Successfully started a specific task |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is not "start a task", POST /task/:identifier is used in microkernel to send back the command execution result to RackHD.
static/monorail-2.0.yaml
Outdated
| delete: | ||
| description: | ||
| Delete the workflow task with the specified value of the injectableName property. | ||
| Delete the workflow task with a specific value of the injectableName property. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggest to emphasize this is task definition, to avoid misunderstand it as task instance.
static/monorail-2.0.yaml
Outdated
| get: | ||
| description: | ||
| Get the workflow graph with the specified value of the injectableName property. | ||
| Get the workflow graph with a specific value of the injectableName property. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Suggest to emphasize this is graph definition, to avoid misunderstand it as graph instance.
static/monorail-2.0.yaml
Outdated
| schema: | ||
| $ref: '#/definitions/Error' | ||
| summary: Put a single template | ||
| summary: Put a specific template |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
To align the description for other PUT method, suggest changing to "Create or update a specific template"
| info: | ||
| title: RackHD 2.0 | ||
| version: 0.0.1 | ||
| version: 0.1.0 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
What's the reason to update the version number? If only some description words changed, I think it's not necessary to update version number.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I need to change the version number or these changes won't be published into bintray. The bintray pdf only updates when it sees the version has changed
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
For such simple description modification, how about only change the last version number? 0.0.1 => 0.0.2?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
After discussing with Brian he thinks the minor changes are for something that's pre-alpha.
At this point, we feel pretty comfortable with the documentation and are ready for it to get consumed by users which is why we wanted to do 0.1.0
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
that's ok
|
👍 after at least following items done:
|
static/monorail-2.0.yaml
Outdated
| type: array | ||
| 404: | ||
| description: The specified node was not found | ||
| description: The specified node was not. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
lack of 'found'
static/monorail-2.0.yaml
Outdated
| type: object | ||
| 404: | ||
| description: The node with the identifier was not found | ||
| description: The specific node was not found. |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
should be 'The specified node was not found' like most other places?
30b7315 to
a1ffeee
Compare
clean up descriptions and error codes in the yaml file
@RackHD/corecommitters @dalebremner @srinia6 @keedya @tannoa2 @uppalk1 @geoff-reid