Skip to content

Addition of CorrelationId and RequestId headers on all req/res #38

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

Open
guillaumeFRANCOIS wants to merge 1 commit into
base: main
Choose a base branch
from
Open

Addition of CorrelationId and RequestId headers on all req/res #38

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
85 changes: 41 additions & 44 deletions specification/apis/ccp/ccp.api.v1.contractDataByEmaid.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@
"GetContractDataByEmaid"
],
"parameters": [
{
"$ref": "../../components/parameters/headers/opncCorrelationId.v1.json"
},
{
"$ref": "../../components/parameters/headers/opncRequestId.v1.json"
},
{
"$ref": "../../components/parameters/headers/opncFromPartyType.v1.json"
},
Expand Down Expand Up @@ -46,54 +52,45 @@
}
],
"responses": {
"200": {
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "../../components/responses/getContractDataRes.v1.json"
}
}
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "../../components/schemas/error.v1.json"
"200": {
"headers": {
"OPNC-Correlation-ID": {
"$ref": "../../components/parameters/headers/opncCorrelationId.v1.json"
},
"OPNC-Request-ID": {
"$ref": "../../components/parameters/headers/opncRequestId.v1.json"
}
},
"examples": {
"Invalid EMAID": {
"value": {
"errorMessages": [
"emaid : must match \"^[A-Za-z]{2}[-]?\\w{3}[-]?\\w{9,28}[-]?(\\w{1})?$\""
],
"traceId": "02be5c05-298b-4503-a685-8126951e0233"
"description": "OK",
"content": {
"application/json": {
"schema": {
"$ref": "../../components/responses/getContractDataRes.v1.json"
}
}
}
}
}
},
"400": {
"$ref": "../../components/responses/errorResponses/BadRequest.json"
},
"401": {
"$ref": "../../components/responses/errorResponses/Unauthorized.json"
},
"403": {
"$ref": "../../components/responses/errorResponses/Forbidden.json"
},
"404": {
"$ref": "../../components/responses/errorResponses/NotFound.json"
},
"500": {
"$ref": "../../components/responses/errorResponses/InternalServerError.json"
},
"502": {
"$ref": "../../components/responses/errorResponses/BadGataway.json"
},
"503": {
"$ref": "../../components/responses/errorResponses/ServiceUnavailable.json"
}
},
"401": {
"description": "Unauthorized"
},
"403": {
"description": "Forbidden"
},
"404": {
"description": "Not Found"
},
"500": {
"description": "Internal Server Error"
},
"502": {
"description": "Bad Gateway"
},
"503": {
"description": "Service Unavailable"
}
}
}
}
35 changes: 21 additions & 14 deletions specification/apis/ccp/ccp.api.v1.contractDataByPcid.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@
"GetContractDataByPcid"
],
"parameters": [
{
"$ref": "../../components/parameters/headers/opncCorrelationId.v1.json"
},
{
"$ref": "../../components/parameters/headers/opncRequestId.v1.json"
},
{
"$ref": "../../components/parameters/headers/opncFromPartyType.v1.json"
},
Expand Down Expand Up @@ -39,6 +45,14 @@
],
"responses": {
"200": {
"headers": {
"OPNC-Correlation-ID": {
"$ref": "../../components/parameters/headers/opncCorrelationId.v1.json"
},
"OPNC-Request-ID": {
"$ref": "../../components/parameters/headers/opncRequestId.v1.json"
}
},
"description": "OK",
"content": {
"application/json": {
Expand All @@ -49,32 +63,25 @@
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "../../components/schemas/error.v1.json"
}
}
}
"$ref": "../../components/responses/errorResponses/BadRequest.json"
},
"401": {
"description": "Unauthorized"
"$ref": "../../components/responses/errorResponses/Unauthorized.json"
},
"403": {
"description": "Forbidden"
"$ref": "../../components/responses/errorResponses/Forbidden.json"
},
"404": {
"description": "Not Found"
"$ref": "../../components/responses/errorResponses/NotFound.json"
},
"500": {
"description": "Internal Server Error"
"$ref": "../../components/responses/errorResponses/InternalServerError.json"
},
"502": {
"description": "Bad Gateway"
"$ref": "../../components/responses/errorResponses/BadGataway.json"
},
"503": {
"description": "Service Unavailable"
"$ref": "../../components/responses/errorResponses/ServiceUnavailable.json"
}
}
}
Expand Down
89 changes: 46 additions & 43 deletions specification/apis/ccp/ccp.api.v1.signedContractData.json
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,12 @@
"GetSignedContractDataByCertificateInstallationReq"
],
"parameters": [
{
"$ref": "../../components/parameters/headers/opncCorrelationId.v1.json"
},
{
"$ref": "../../components/parameters/headers/opncRequestId.v1.json"
},
{
"$ref": "../../components/parameters/headers/opncFromPartyType.v1.json"
},
Expand Down Expand Up @@ -46,6 +52,14 @@
"responses": {
"200": {
"description": "OK",
"headers": {
"OPNC-Correlation-ID": {
"$ref": "../../components/parameters/headers/opncCorrelationId.v1.json"
},
"OPNC-Request-ID": {
"$ref": "../../components/parameters/headers/opncRequestId.v1.json"
}
},
"content": {
"application/json": {
"schema": {
Expand All @@ -55,49 +69,25 @@
}
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "../../components/schemas/error.v1.json"
},
"examples": {
"Invalid EXI": {
"value": {
"errorMessages": [
"EXI format is invalid!"
],
"traceId": "f61bc043-9697-436f-8df6-3274f0befb1d"
}
}
}
}
}
"$ref": "../../components/responses/errorResponses/BadRequest.json"
},
"401": {
"description": "Unauthorized"
"$ref": "../../components/responses/errorResponses/Unauthorized.json"
},
"403": {
"description": "Forbidden"
"$ref": "../../components/responses/errorResponses/Forbidden.json"
},
"404": {
"description": "Not Found",
"content": {
"application/json": {
"schema": {
"$ref": "../../components/schemas/error.v1.json"
}
}
}
"$ref": "../../components/responses/errorResponses/NotFound.json"
},
"500": {
"description": "Internal Server Error"
"$ref": "../../components/responses/errorResponses/InternalServerError.json"
},
"502": {
"description": "Bad Gateway"
"$ref": "../../components/responses/errorResponses/BadGataway.json"
},
"503": {
"description": "Service Unavailable"
"$ref": "../../components/responses/errorResponses/ServiceUnavailable.json"
}
}
},
Expand All @@ -112,6 +102,12 @@
"$ref": "../../components/requestBodies/putSignedContractDataReq.v1.json"
},
"parameters": [
{
"$ref": "../../components/parameters/headers/opncCorrelationId.v1.json"
},
{
"$ref": "../../components/parameters/headers/opncRequestId.v1.json"
},
{
"$ref": "../../components/parameters/headers/opncFromPartyType.v1.json"
},
Expand All @@ -127,29 +123,36 @@
],
"responses": {
"201": {
"headers": {
"OPNC-Correlation-ID": {
"$ref": "../../components/parameters/headers/opncCorrelationId.v1.json"
},
"OPNC-Request-ID": {
"$ref": "../../components/parameters/headers/opncRequestId.v1.json"
}
},
"description": "Signed contract data added."
},
"400": {
"description": "Bad Request",
"content": {
"application/json": {
"schema": {
"$ref": "../../components/schemas/error.v1.json"
}
}
}
"$ref": "../../components/responses/errorResponses/BadRequest.json"
},
"401": {
"description": "Unauthorized"
"$ref": "../../components/responses/errorResponses/Unauthorized.json"
},
"403": {
"description": "Forbidden"
"$ref": "../../components/responses/errorResponses/Forbidden.json"
},
"404": {
"description": "Not Found"
"$ref": "../../components/responses/errorResponses/NotFound.json"
},
"500": {
"description": "Internal Server Error"
"$ref": "../../components/responses/errorResponses/InternalServerError.json"
},
"502": {
"$ref": "../../components/responses/errorResponses/BadGataway.json"
},
"503": {
"$ref": "../../components/responses/errorResponses/ServiceUnavailable.json"
}
}
}
Expand Down
Loading