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

Create a REST method map/translation to verbs used in function names #76

Open
MariusStorhaug opened this issue Oct 26, 2023 · 0 comments

Comments

@MariusStorhaug
Copy link
Contributor

MariusStorhaug commented Oct 26, 2023

Verb Method Description
Get Get
New/Add Post
Remove Delete
Update Patch

Special cases:
Method Put - Depends on endpoint I.e enable/disable, Start/Stop

Verb Set - Reserved for anything that is of a declarative nature. For endpoints that are not declarative already, create a wrapper function that provides the declarative functionality by combining methods Get + patch/put. The declarative functions should also provide a diff if running with -WhatIf.

Use impact on functions to determine if confirmation should be requested. This could be on activities such as remove/delete org/repo. For these we add -Force switch.

Places where there are only get and put methods available, create wrapper functions that provide add and remove functionality.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: Todo
Development

No branches or pull requests

1 participant