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

Make naming scheme for path parameters consistent #412

Open
msporny opened this issue Aug 13, 2024 · 1 comment
Open

Make naming scheme for path parameters consistent #412

msporny opened this issue Aug 13, 2024 · 1 comment
Assignees
Labels
ready for PR Issue ready to be resolved via a Pull Request

Comments

@msporny
Copy link
Contributor

msporny commented Aug 13, 2024

There are a number of path parameters that we have in the specification today, such as id, localWorkflowId, and localExchangeId, where the meaning of the word "local" and "id" are not clear from the specification text.

We might want to distinguish between relative/local IDs and global IDs. Also consider that developers arrange databases using relative/local IDs. Maybe put the word path in the name for parameters that are non-global and only used in paths.

@msporny
Copy link
Contributor Author

msporny commented Aug 13, 2024

The group discussed this on the 2024-08-13 telecon and noted that we might want to distinguish between relative/local IDs and global IDs. Also consider that developers arrange databases using relative/local IDs. Maybe put the word path in the name for parameters that are non-global and only used in paths.

A PR should be raised to rename all identifiers that are a part of the path to the name of the resource they appear on and PathId appended to them, such as: workflowPathId and credentialPathId and exchangePathId. There should also be a meta explanation about what "PathId" means when used in paths in the specification.

@msporny msporny added the ready for PR Issue ready to be resolved via a Pull Request label Aug 13, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
ready for PR Issue ready to be resolved via a Pull Request
Projects
None yet
Development

No branches or pull requests

2 participants