diff --git a/documentation/API-cheatsheet.md b/documentation/API-cheatsheet.md new file mode 100644 index 00000000..b74fe340 --- /dev/null +++ b/documentation/API-cheatsheet.md @@ -0,0 +1,24 @@ +# CAMARA syntax cheatsheet + + + +## Case conventions + +| Information item | Convention | Example | +|------------------|------------|---------| +| API name | kebab-case | simple-edge-discovery | +| 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`