Skip to content

Doc: FCP templates API calls and other fixes #843

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.

Sign up for GitHub

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

Jump to bottom
Merged
mfriesenegger merged 5 commits into from
Feb 9, 2025
Merged

Doc: FCP templates API calls and other fixes #843

mfriesenegger merged 5 commits into from
Feb 9, 2025

Conversation

@Bischoff
Copy link
Contributor

@Bischoff Bischoff commented Nov 17, 2024 •
edited
Loading

Documentation fixes

  1. Move method to vswitch section
  • Get vswitch info

  1. Fix typography and English

  2. Fix parameters of existing volume functions

  • Refresh volume bootstrap info
  • Get volume connector
  • Attach volume
  • Detach volume
  • Get FCP usage
  • Set FCP usage
  1. Add FCP templates API calls
  • Create FCP template
  • Delete FCP template
  • Get FCP templates
  • Edit FCP template
  • Get FCP templates details
  1. Remove unused parameters

Fixes #772

@Bischoff Bischoff changed the title WIP - Doc: FCP templates WIP - Doc: FCP templates API calls Nov 17, 2024
@Bischoff Bischoff mentioned this pull request Nov 17, 2024
Closed
@Bischoff Bischoff force-pushed the doc-fcp-templates branch 2 times, most recently from a36ba74 to 5056e09 Compare November 17, 2024 18:41
@Bischoff Bischoff force-pushed the doc-fcp-templates branch 25 times, most recently from 3186383 to 381a63f Compare November 19, 2024 21:50
@Bischoff Bischoff force-pushed the doc-fcp-templates branch 2 times, most recently from 7d05a10 to 549a979 Compare November 21, 2024 19:55
@Bischoff Bischoff changed the title WIP - Doc: FCP templates API calls and other fixes Doc: FCP templates API calls and other fixes Nov 21, 2024
@Bischoff Bischoff force-pushed the doc-fcp-templates branch 7 times, most recently from 2a3234d to 1c85fbd Compare November 26, 2024 08:50
@mfriesenegger mfriesenegger force-pushed the doc-fcp-templates branch 2 times, most recently from f478247 to 909117e Compare February 3, 2025 00:31
mfriesenegger
mfriesenegger requested changes Feb 3, 2025
View reviewed changes
Copy link
Collaborator

@mfriesenegger mfriesenegger left a comment

Choose a reason for hiding this comment

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

Thank you for the great work on this! I used the tox -e docs command that you shared with me to generate a readable local copy for myself. I have pointed out a number of items that should be updated before merging this PR.

@mfriesenegger
Copy link
Collaborator

mfriesenegger commented Feb 3, 2025

I will take your word that this fixes #772. Please help me to remember to close issue #772 when this PR is merged!

@Bischoff
Move a call to "VSwitch(es)" section of API documentation
02c167d 
Signed-off-by: Eric Bischoff <ebischoff@suse.com>
@Bischoff
Fix typography and English of API documentation
80903d5 
Signed-off-by: Eric Bischoff <ebischoff@suse.com>
@Bischoff
Fix parameters of volume functions in API documentation
a5338d8 
Signed-off-by: Eric Bischoff <ebischoff@suse.com>
@Bischoff
Copy link
Contributor Author

Bischoff commented Feb 4, 2025

Suggestions applied, please review again.

@Bischoff
Copy link
Contributor Author

Bischoff commented Feb 4, 2025 •
edited
Loading

I will take your word that this fixes #772. Please help me to remember to close issue #772 when this PR is merged!

@dongyanyang wrote in that issue: "The doc of CRUD of fcp_template and the attach_volume/detach_volume APIs are missing, need to add them."

The following API calls were indeed undocumented:

  • Create FCP template
  • Delete FCP template
  • Get FCP templates
  • Edit FCP template
  • Get FCP templates details

I do not see what I might have missed, but one never knows.

I suggest that we close #772, and if we detect a missing doc piece, we reopen a new issue.

@Bischoff
Add FCP templates API calls
f572bce 
Signed-off-by: Eric Bischoff <ebischoff@suse.com>
@Bischoff
Remove unused parameters from API doc
3c2fd57 
Signed-off-by: Eric Bischoff <ebischoff@suse.com>
@mfriesenegger
Copy link
Collaborator

mfriesenegger commented Feb 9, 2025

@Bischoff Thank you for all of your work on this PR!

@mfriesenegger mfriesenegger merged commit 8d81dfd into openmainframeproject:master Feb 9, 2025
2 checks passed
@Bischoff Bischoff deleted the doc-fcp-templates branch February 20, 2025 12:50
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Reviewers

@mfriesenegger mfriesenegger mfriesenegger approved these changes

Assignees

@Bischoff Bischoff

Labels

None yet

Projects

None yet

Milestone

No milestone

Development

Successfully merging this pull request may close these issues.

Doc: add doc of new fcp_template and attach/detach APIs

2 participants

@Bischoff @mfriesenegger