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.

Sign up for GitHub

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

Jump to bottom

Create API-cheatsheet.md #320

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open

Create API-cheatsheet.md #320

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
f142fa2
Create API-cheatsheet.md
Kevsy Oct 17, 2024
aaa2315
Added OAS name
Kevsy Nov 6, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
24 changes: 24 additions & 0 deletions documentation/API-cheatsheet.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# CAMARA syntax cheatsheet

<!--Note for PR#320: The text below is an example for illustration
and is incomplete. If the PR is approved then anyone can suggest additions.

The intention is for this cheatsheet to be expanded to
incorporate all design guidelines that can be quickly represented
(such as syntax conventions). More detailed guidelines would only
appear in the main design guidelines document.
-->

## Case conventions

| Information item | Convention | Example |
|------------------|------------|---------|
| API name | kebab-case | simple-edge-discovery |
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

add: | OAS file name | kebab-case | simple-edge-discovery.yaml |

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@tanjadegroot thanks, added.

| OAS file name | kebab-case | simple-edge-discovery.yaml |
| Path| kebab-case | `/customer-segments` |
| OperationId | camelCase | getData |

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