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

method naming conventions #169

Closed
shanejonas opened this issue Jun 9, 2019 · 7 comments
Closed

method naming conventions #169

shanejonas opened this issue Jun 9, 2019 · 7 comments
Assignees
Labels
discuss enhancement New feature or request stale

Comments

@shanejonas
Copy link
Member

shanejonas commented Jun 9, 2019

Is your feature request related to a problem? Please describe.
As a developer, i'd like clear naming conventions to remove unnecessary variation.

I've also outlined my thoughts around how this naming and it being a foundational layer to get a RESTful style interface with JSON-RPC here.

gRPC's naming conventions:

https://cloud.google.com/apis/design/naming_convention#method_names

Carefully consider use of names that may conflict with keywords in common programming languages. Such names may be used but will likely trigger additional scrutiny during API review. Use them judiciously and sparingly.

VerbNoun

The verb portion of the method name should use the imperative mood, which is for orders or commands rather than the indicative mood which is for questions.

@shanejonas
Copy link
Member Author

From the article here.

Path to API Enlightenment - REST over JSON-RPC

Based on Richardson Maturity Model description of the different layers of REST APIs. But applied with OpenRPC in mind:

  • Level 0 - Basic transport agnostic JSON-RPC API

  • Level 1 - Break down complexity into multiple resources or services.

  • Level 2 - Use a standard set of verbs and nouns removing unnecessary variation.

  • Level 3 - Introduce service discovery and links via the OpenRPC interface definition, -providing a self-documenting protocol.

@shanejonas
Copy link
Member Author

shanejonas commented Jun 29, 2019

Another resource reinforcing naming with actionResource: the art of naming variables.

@stale
Copy link

stale bot commented Aug 28, 2019

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale label Aug 28, 2019
@stale stale bot closed this as completed Sep 4, 2019
@BelfordZ
Copy link
Member

@shanejonas is there something still to be done here?

@BelfordZ BelfordZ reopened this Dec 12, 2019
@stale stale bot removed the stale label Dec 12, 2019
@stale
Copy link

stale bot commented Feb 10, 2020

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale label Feb 10, 2020
@shanejonas
Copy link
Member Author

would be great to follow the naming conventions outlined here

@stale stale bot removed the stale label Feb 12, 2020
@stale
Copy link

stale bot commented Apr 12, 2020

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions.

@stale stale bot added the stale label Apr 12, 2020
@stale stale bot closed this as completed Apr 19, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
discuss enhancement New feature or request stale
Projects
None yet
Development

No branches or pull requests

4 participants