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 CAMARA cheatsheet.md #319

Open
Kevsy opened this issue Oct 17, 2024 · 2 comments · May be fixed by #320
Open

Create a CAMARA cheatsheet.md #319

Kevsy opened this issue Oct 17, 2024 · 2 comments · May be fixed by #320
Labels
enhancement New feature or request Spring25

Comments

@Kevsy
Copy link
Collaborator

Kevsy commented Oct 17, 2024

Problem description

'Cheatsheets' are a convenient way to summarise editing rules and examples, e.g. GitHub Markdown Cheatsheet.

A CAMARA Cheatsheet would help API editors quickly check rules and conventions. I suggest this cheatsheet.md to be a separate document to the new slimline design guidelines (#64), and would need to be synchronised with any new or change design rules.

Example content:

CAMARA syntax cheatsheet

Case conventions

Information item Convention Example
API name kebab-case simple-edge-discovery
Path kebab-case /customer-segments
OperationId camelCase getData

Scopes

Structure: api-name:[resource:]action
Format: kebab-case, colon separated
Example: qod:qos-profiles:read

etc.

Possible evolution

Alternative solution

The cheatsheet could be incorporated into the new slimline design guidelines (#306) as an appendix.

Additional context

@Kevsy Kevsy added the enhancement New feature or request label Oct 17, 2024
@Kevsy Kevsy linked a pull request Oct 17, 2024 that will close this issue
2 tasks
@patrice-conil
Copy link
Collaborator

Hi @Kevsy,
Great idea!

@PedroDiez
Copy link
Collaborator

Yes, think it is very useful.

Maybe could be also a good idea to reference this document in "Create Camara-OAS-Sections-Guidelines.md" PR#317 within section ## Introduction, so as the information is linked and a reader can easily find it. cc @shilpa-padgaonkar

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request Spring25
Projects
None yet
Development

Successfully merging a pull request may close this issue.

3 participants