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

Add swagger for dataset create api #441

Merged
merged 4 commits into from
Sep 26, 2022

Conversation

1000TurquoisePogs
Copy link
Member

This PR updates the swagger document for the dataset create api, but also the dataset delete api
This PR depends upon the following PRs: zowe/zss#473

Type of change

Please delete options that are not relevant.

  • Change in a documentation
  • Chore, repository cleanup, updates the dependencies.

Signed-off-by: 1000TurquoisePogs <[email protected]>
Signed-off-by: 1000TurquoisePogs <[email protected]>
blkln:
description: The average data block length
type: number
ndisp:
Copy link
Member

Choose a reason for hiding this comment

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

I think normal termination disposition for a data set deserves a description (because I've been in the industry for a few years now and I didn't know what it was)

Copy link
Member Author

Choose a reason for hiding this comment

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

I wish I knew what it meant, too.

space:
type: string
enum: [CYL, TRK]
dir:
Copy link
Member

Choose a reason for hiding this comment

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

Think this deserves descr too, dir of what?

Copy link
Member Author

Choose a reason for hiding this comment

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

I wish I knew what it meant, too.

DD Allocation Error:
Unable to allocate a DD for ACB
Unalloc error:
"error: ds unalloc dsn={dataset} dd=ddname, rc=rc sysRC=rc, sysRSN=rsn"
Copy link
Member

Choose a reason for hiding this comment

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

Was this intended bracketing? [...] {dataset} dd={ddname} ?

Copy link
Member Author

Choose a reason for hiding this comment

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

i dont think ddname resolves to a variable thats present in the swagger doc so no bracket.

type: string
examples:
Member deletion:
{msg: Data set member membername was deleted successfully}
Copy link
Member

Choose a reason for hiding this comment

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

Was this intended bracketing? [...] msg: Dataset member {membername} was [...]

Copy link
Member Author

Choose a reason for hiding this comment

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

Yes, following pre-existing examples of how to do json in here.

@1000TurquoisePogs 1000TurquoisePogs merged commit 41cca87 into v2.x/staging Sep 26, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants