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

feat: define how to handle reserved keywords #25

Conversation

jonaslagoni
Copy link
Member

This PR adds a section on how to handle reserved keywords alongside a list of reserved keywords, that we initially found for Modelina. This list of keywords makes it easier for implementors to quick copy-paste the list into their code.

Fixes #18

@yordis
Copy link

yordis commented Mar 1, 2022

Although I understand you would like to tackle such a problem, I think the specification shouldn't try to be prescriptive of the allowed values. Such responsibility is too much of a burden to take in my opinion.

Developers should understand such technicalities based on their generators or whatever they are doing language-specific.

I think doing something like OpenAPI on this one is prudent

From: https://spec.openapis.org/oas/latest.html

Unique string used to identify the operation. The id MUST be unique among all operations described in the API. The operationId value is case-sensitive. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is RECOMMENDED to follow common programming naming conventions.

@jonaslagoni
Copy link
Member Author

Although I understand you would like to tackle such a problem, I think the specification shouldn't try to be prescriptive of the allowed values. Such responsibility is too much of a burden to take in my opinion.

Developers should understand such technicalities based on their generators or whatever they are doing language-specific.

I think doing something like OpenAPI on this one is prudent

I agree that there should be no section defining what is allowed from a JSON schema perspective, anything should.

However, once it reaches a generator for a specific language, you will need to know about these things. This section is only aimed to help everyone more easily to get started. That once you as a provider of such generator find inconsistency in the reserved keywords, we can keep this documentation up to date 🙂

@yordis
Copy link

yordis commented Mar 1, 2022

Got it

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

Successfully merging this pull request may close these issues.

Define how to handle reserved keywords
2 participants