From f142fa218901d465eea7013cd96529980b6bf7b4 Mon Sep 17 00:00:00 2001 From: Kevin Smith Date: Thu, 17 Oct 2024 15:15:47 +0100 Subject: [PATCH 1/2] Create API-cheatsheet.md --- documentation/API-cheatsheet.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) create mode 100644 documentation/API-cheatsheet.md diff --git a/documentation/API-cheatsheet.md b/documentation/API-cheatsheet.md new file mode 100644 index 00000000..dc76e7c2 --- /dev/null +++ b/documentation/API-cheatsheet.md @@ -0,0 +1,23 @@ +# 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` From aaa23156303230a3f95a7533a7a416d23d1d423f Mon Sep 17 00:00:00 2001 From: Kevin Smith Date: Wed, 6 Nov 2024 16:27:11 +0000 Subject: [PATCH 2/2] Added OAS name --- documentation/API-cheatsheet.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/documentation/API-cheatsheet.md b/documentation/API-cheatsheet.md index dc76e7c2..b74fe340 100644 --- a/documentation/API-cheatsheet.md +++ b/documentation/API-cheatsheet.md @@ -1,7 +1,7 @@ # CAMARA syntax cheatsheet -