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

OpenAPI suggests that "operationId" (or "operationref") is mandatory. #6326

Merged
merged 6 commits into from
Jul 11, 2024
Merged

OpenAPI suggests that "operationId" (or "operationref") is mandatory. #6326

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
6 commits
Select commit Hold shift + click to select a range
39f319e
Add a `nonstd::camel_case` util function
eddyashton Jul 10, 2024
06906a5
Canonical test case
eddyashton Jul 10, 2024
13baf57
https://spec.openapis.org/oas/latest.html suggests that "operationId"…
lemmy Jul 3, 2024
1d7aac2
Update OpenAPI
achamayou Jul 4, 2024
a799d02
Merge remote-tracking branch 'eddyashton/add_camel_case_util_function…
lemmy Jul 10, 2024
c940601
- Remove '_' as deliminator between http verb and path
lemmy Jul 10, 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
36 changes: 35 additions & 1 deletion doc/schemas/app_openapi.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -263,12 +263,13 @@
"info": {
"description": "This CCF sample app implements a simple logging application, securely recording messages at client-specified IDs. It demonstrates most of the features available to CCF apps.",
"title": "CCF Sample Logging App",
"version": "2.3.1"
"version": "2.4.1"
},
"openapi": "3.0.0",
"paths": {
"/app/api": {
"get": {
"operationId": "GetAppApi",
"responses": {
"200": {
"content": {
Expand All @@ -294,6 +295,7 @@
"get": {
"deprecated": true,
"description": "Permitted SGX code identities",
"operationId": "GetAppCode",
"responses": {
"200": {
"content": {
Expand All @@ -318,6 +320,7 @@
"/app/commit": {
"get": {
"description": "Latest transaction ID that has been committed on the service",
"operationId": "GetAppCommit",
"parameters": [
{
"in": "query",
Expand Down Expand Up @@ -359,6 +362,7 @@
},
"/app/custom_auth": {
"get": {
"operationId": "GetAppCustomAuth",
"responses": {
"200": {
"content": {
Expand All @@ -381,6 +385,7 @@
},
"/app/log/cose_signed_content": {
"post": {
"operationId": "PostAppLogCoseSignedContent",
"responses": {
"200": {
"content": {
Expand Down Expand Up @@ -408,6 +413,7 @@
},
"/app/log/private": {
"delete": {
"operationId": "DeleteAppLogPrivate",
"parameters": [
{
"in": "query",
Expand Down Expand Up @@ -446,6 +452,7 @@
}
},
"get": {
"operationId": "GetAppLogPrivate",
"parameters": [
{
"in": "query",
Expand Down Expand Up @@ -484,6 +491,7 @@
}
},
"post": {
"operationId": "PostAppLogPrivate",
"requestBody": {
"content": {
"application/json": {
Expand Down Expand Up @@ -524,6 +532,7 @@
},
"/app/log/private/admin_only": {
"post": {
"operationId": "PostAppLogPrivateAdminOnly",
"requestBody": {
"content": {
"application/json": {
Expand Down Expand Up @@ -556,6 +565,7 @@
},
"/app/log/private/all": {
"delete": {
"operationId": "DeleteAppLogPrivateAll",
"responses": {
"200": {
"content": {
Expand Down Expand Up @@ -586,6 +596,7 @@
},
"/app/log/private/anonymous": {
"post": {
"operationId": "PostAppLogPrivateAnonymous",
"requestBody": {
"content": {
"application/json": {
Expand Down Expand Up @@ -618,6 +629,7 @@
},
"/app/log/private/anonymous/v2": {
"post": {
"operationId": "PostAppLogPrivateAnonymousV2",
"requestBody": {
"content": {
"application/json": {
Expand Down Expand Up @@ -650,6 +662,7 @@
},
"/app/log/private/backup": {
"get": {
"operationId": "GetAppLogPrivateBackup",
"parameters": [
{
"in": "query",
Expand Down Expand Up @@ -690,6 +703,7 @@
},
"/app/log/private/committed": {
"get": {
"operationId": "GetAppLogPrivateCommitted",
"parameters": [
{
"in": "query",
Expand Down Expand Up @@ -722,6 +736,7 @@
},
"/app/log/private/count": {
"get": {
"operationId": "GetAppLogPrivateCount",
"responses": {
"200": {
"content": {
Expand Down Expand Up @@ -752,6 +767,7 @@
},
"/app/log/private/historical": {
"get": {
"operationId": "GetAppLogPrivateHistorical",
"parameters": [
{
"in": "query",
Expand Down Expand Up @@ -792,6 +808,7 @@
},
"/app/log/private/historical/sparse": {
"get": {
"operationId": "GetAppLogPrivateHistoricalSparse",
"parameters": [
{
"in": "query",
Expand Down Expand Up @@ -840,6 +857,7 @@
},
"/app/log/private/historical_receipt": {
"get": {
"operationId": "GetAppLogPrivateHistoricalReceipt",
"parameters": [
{
"in": "query",
Expand Down Expand Up @@ -880,6 +898,7 @@
},
"/app/log/private/install_committed_index": {
"post": {
"operationId": "PostAppLogPrivateInstallCommittedIndex",
"responses": {
"204": {
"description": "Default response description"
Expand All @@ -895,6 +914,7 @@
},
"/app/log/private/prefix_cert": {
"post": {
"operationId": "PostAppLogPrivatePrefixCert",
"requestBody": {
"content": {
"application/json": {
Expand Down Expand Up @@ -937,6 +957,7 @@
}
],
"post": {
"operationId": "PostAppLogPrivateRawTextId",
"responses": {
"200": {
"description": "Default response description"
Expand All @@ -960,6 +981,7 @@
},
"/app/log/private/uninstall_committed_index": {
"post": {
"operationId": "PostAppLogPrivateUninstallCommittedIndex",
"responses": {
"204": {
"description": "Default response description"
Expand All @@ -975,6 +997,7 @@
},
"/app/log/public": {
"delete": {
"operationId": "DeleteAppLogPublic",
"parameters": [
{
"in": "query",
Expand Down Expand Up @@ -1013,6 +1036,7 @@
}
},
"get": {
"operationId": "GetAppLogPublic",
"parameters": [
{
"in": "query",
Expand Down Expand Up @@ -1051,6 +1075,7 @@
}
},
"post": {
"operationId": "PostAppLogPublic",
"requestBody": {
"content": {
"application/json": {
Expand Down Expand Up @@ -1091,6 +1116,7 @@
},
"/app/log/public/all": {
"delete": {
"operationId": "DeleteAppLogPublicAll",
"responses": {
"200": {
"content": {
Expand Down Expand Up @@ -1121,6 +1147,7 @@
},
"/app/log/public/backup": {
"get": {
"operationId": "GetAppLogPublicBackup",
"parameters": [
{
"in": "query",
Expand Down Expand Up @@ -1161,6 +1188,7 @@
},
"/app/log/public/count": {
"get": {
"operationId": "GetAppLogPublicCount",
"responses": {
"200": {
"content": {
Expand Down Expand Up @@ -1191,6 +1219,7 @@
},
"/app/log/public/historical/range": {
"get": {
"operationId": "GetAppLogPublicHistoricalRange",
"parameters": [
{
"in": "query",
Expand Down Expand Up @@ -1247,6 +1276,7 @@
},
"/app/log/public/historical_receipt": {
"get": {
"operationId": "GetAppLogPublicHistoricalReceipt",
"parameters": [
{
"in": "query",
Expand Down Expand Up @@ -1287,6 +1317,7 @@
},
"/app/log/request_query": {
"get": {
"operationId": "GetAppLogRequestQuery",
"responses": {
"200": {
"content": {
Expand All @@ -1309,6 +1340,7 @@
},
"/app/multi_auth": {
"post": {
"operationId": "PostAppMultiAuth",
"responses": {
"200": {
"content": {
Expand Down Expand Up @@ -1341,6 +1373,7 @@
"/app/receipt": {
"get": {
"description": "A signed statement from the service over a transaction entry in the ledger",
"operationId": "GetAppReceipt",
"parameters": [
{
"in": "query",
Expand Down Expand Up @@ -1375,6 +1408,7 @@
"/app/tx": {
"get": {
"description": "Possible statuses returned are Unknown, Pending, Committed or Invalid.",
"operationId": "GetAppTx",
"parameters": [
{
"in": "query",
Expand Down
Loading