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

Inconsistent naming of "sshsftpUser" functions #154

Open
martin-helmich opened this issue Jul 23, 2024 · 0 comments
Open

Inconsistent naming of "sshsftpUser" functions #154

martin-helmich opened this issue Jul 23, 2024 · 0 comments
Labels
bug Something isn't working

Comments

@martin-helmich
Copy link
Member

For all API operations, we strip the OpenAPI tag from the actual operation ID to determine the method name; for example, app-get-app becomes client.app.getApp.

This works for all operations, EXCEPT the "SSH/SFTP USER" tag; operations using this tags have their ID starting with either sftp-user or ssh-user, but not sshsftp-user. This leads to clunky method names that are inconsistent with the rest of the client:

public readonly sshsftpUser = {
/** Get all SFTPUsers for a Project. */
sftpUserListSftpUsers: this.requestFunctionFactory(
descriptors.sftpUserListSftpUsers,
),
/** Create an SFTPUser for a Project. */
sftpUserCreateSftpUser: this.requestFunctionFactory(
descriptors.sftpUserCreateSftpUser,
),

This could probably be easily fixed by adding a few substitution rules in the client generation; however, this would constitute a breaking change.

@martin-helmich martin-helmich added the bug Something isn't working label Jul 23, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
bug Something isn't working
Projects
None yet
Development

No branches or pull requests

1 participant