Skip to content

[Tech] Corrections in json api files + modif of github action to fail if API does not compile #95

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

Merged
danisoler-charin merged 1 commit into from
Aug 11, 2025
Merged

[Tech] Corrections in json api files + modif of github action to fail if API does not compile #95

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
2 changes: 1 addition & 1 deletion .github/workflows/redocly.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -48,7 +48,7 @@ jobs:
BUNDLE_ERR=$(npx redocly bundle "$spec_path" -o "docs/$api/$api.api.consolidated.v1.json" 2>&1)
if [ $? -ne 0 ]; then
echo "::warning::❌ Failed to bundle $api:\n$BUNDLE_ERR"
continue
exit 1
else
echo "✅ Bundled $api"
fi
Expand Down
2 changes: 1 addition & 1 deletion specification/apis/cps/cps.api.v1.cpsCertificates.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,7 @@
"content": {
"application/json": {
"schema": {
"$ref": "../../components/responses/GetCpsCertificatesRes.v1.json"
"$ref": "../../components/responses/getCpsCertificatesRes.v1.json"
}
},
"multipart/form-data": {
Expand Down
21 changes: 11 additions & 10 deletions specification/apis/pki/pki.api.v1.cacerts.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,19 +38,20 @@
}
},
{
"name": "algorithm",
"in": "path",
"description": "Defines the algorithm for the PKI which shall be used."
"schema": {
"type": "string",
"enum": [
"secp256r1",
"secp521r1",
"ed448"
"name": "algorithm",
"in": "path",
"description": "Defines the algorithm for the PKI which shall be used.",
"schema": {
"type": "string",
"enum": [
"secp256r1",
"secp521r1",
"ed448"
],
"default": "secp256r1",
"example": "secp521r1"
}
}
}
],
"responses": {
"200": {
Expand Down
4 changes: 2 additions & 2 deletions specification/apis/pki/pki.api.v1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -22,10 +22,10 @@
"tags": [],
"paths": {
"/est/simpleenroll": {
"$ref": "./pki.api.v1.simpleEnroll.json"
"$ref": "./pki.api.v1.simpleenroll.json"
},
"/est/cacerts": {
"$ref": "./pki.api.v1.caCerts.json"
"$ref": "./pki.api.v1.cacerts.json"
},
"/pki/revokeCertificate" : {
"$ref": "./pki.api.v1.revokeCert.json"
Expand Down
21 changes: 11 additions & 10 deletions specification/apis/pki/pki.api.v1.simpleenroll.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -38,19 +38,20 @@
}
},
{
"name": "algorithm",
"in": "path",
"description": "Defines the algorithm for the PKI which shall be used."
"schema": {
"type": "string",
"enum": [
"secp256r1",
"secp521r1",
"ed448"
"name": "algorithm",
"in": "path",
"description": "Defines the algorithm for the PKI which shall be used.",
"schema": {
"type": "string",
"enum": [
"secp256r1",
"secp521r1",
"ed448"
],
"default": "secp256r1",
"example": "secp521r1"
}
}
}
],
"requestBody": {
"content": {
Expand Down
2 changes: 1 addition & 1 deletion specification/apis/rcp/rcp.api.v1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@
"$ref": "./rcp.api.v1.rootCertificateById.json"
},
"/rootcertificates": {
"$ref": "./rcp.api.v1.rootCertificates.json"
"$ref": "./rcp.api.v1.rootcertificates.json"
}
}

Expand Down
2 changes: 1 addition & 1 deletion specification/components/responses/getSignedContractDataRes.v1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4,7 +4,7 @@
"properties": {
"signedContractDataCollection": {
"type": "array",
"description": "Collection of signed contract data objects incl. `certificateInstallationRes`.\n> #### Default Contract\n> The CCP will provide in the ISO15118-2 just one item back - the Contract which is set to Default! The defined array is a preparation for the ISO15118-20"
"description": "Collection of signed contract data objects incl. `certificateInstallationRes`.\n> #### Default Contract\n> The CCP will provide in the ISO15118-2 just one item back - the Contract which is set to Default! The defined array is a preparation for the ISO15118-20",
"items": {
"$ref": "../schemas/signedContractData.v1.json"
}
Expand Down
2 changes: 1 addition & 1 deletion specification/components/schemas/contractCertificateData.v1.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,7 @@
"contractCertificate": {
"type": "string",
"description": "Contract Certificate in base64 encoded PEM form",
"example": "MIIB+zCCAaGgAwIBAgIQayalVTpSmBQQpxCvOm/wVTAKBggqhkjOPQQDAjBDMQswCQYDVQQGEwJERTEVMBMGA1UEChMMSHViamVjdCBHbWJIMR0wGwYDVQQDExRNTyBTdWIyIENBIFFBIEcxLjIuMTAeFw0yNDA3MDQxNjEwNTlaFw0yNjA3MDExNDMyMDBaMDAxFTATBgNVBAoTDEh1YmplY3QgR21iSDEXMBUGA1UEAxMOREVJQ0VDT1BOQ0NFUlQwWTATBgcqhkjOPQIBBggqhkjOPQMBBwNCAAQ16OPJzNDcXsmWi88Onr5lEDgs3TGhj/AhmTUfJUM3SWq+GX34hfaC/ZHuzt6n907QTCI2PUwBsysBMC+t2bWGo4GJMIGGMA8GA1UdEwEB/wQFMAMBAQAwEQYDVR0OBAoECEWCpUe1d7/dMBMGA1UdIwQMMAqACEUuaaE2ImxIMDsGCCsGAQUFBwEBBC8wLTArBggrBgEFBQcwAYYfaHR0cDovL29jc3AtcWEuaHViamVjdC5jb206ODA4MDAOBgNVHQ8BAf8EBAMCA+gwCgYIKoZIzj0EAwIDSAAwRQIhAPk8rji0H9sFcE/sCQsid18dRGV78vjAwkLVuPpPa/QBAiAyFzUS7SjsuFoARXuEi8HXfngnIUXfEngJ3/Q9c14UQw=="
"example": "MIIB+zCCAaGgAwIBAgIQayalVTpSmBQQpxCvOm/wVTAKBggqhkjOPQQDAjBDMQswCQYDVQQGEwJERTEVMBMGA1UEChMMSHViamVjdCBHbWJIMR0wGwYDVQQDExRNTyBTdWIyIENBIFFBIEcxLjIuMTAeFw0yNDA3MDQxNjEwNTlaFw0yNjA3MDExNDMyMDBaMDAxFTATBgNVBAoTDEh1YmplY3QgR21iSDEXMBUGA1UEAxMOREVJQ0VDT1BOQ0NFUlQwWTATBgcqhkjOPQIBBggqhkjOPQMBBwNCAAQ16OPJzNDcXsmWi88Onr5lEDgs3TGhj/AhmTUfJUM3SWq+GX34hfaC/ZHuzt6n907QTCI2PUwBsysBMC+t2bWGo4GJMIGGMA8GA1UdEwEB/wQFMAMBAQAwEQYDVR0OBAoECEWCpUe1d7/dMBMGA1UdIwQMMAqACEUuaaE2ImxIMDsGCCsGAQUFBwEBBC8wLTArBggrBgEFBQcwAYYfaHR0cDovL29jc3AtcWEuaHViamVjdC5jb206ODA4MDAOBgNVHQ8BAf8EBAMCA+gwCgYIKoZIzj0EAwIDSAAwRQIhAPk8rji0H9sFcE/sCQsid18dRGV78vjAwkLVuPpPa/QBAiAyFzUS7SjsuFoARXuEi8HXfngnIUXfEngJ3/Q9c14UQw==",
"pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=)?$",
"maxLength": 800
},
Expand Down