Added oicp create/ping/sendevsestatus/sendevses documentation
MODIFY
src/assets/server/rest/v1/docs/e-mobility-oas.json
src/assets/server/rest/v1/docs/e-mobility-oas.json
}
}
}
+ },
+ "/api/oicp/endpoints": {
+ "post": {
+ "security": [
+ {
+ "bearerAuth": []
+ }
+ ],
+ "description": "Create an OICP Endpoint",
+ "tags": [
+ "OICP"
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OICPEndpoint"
+ }
+ }
+ }
+ },
+ "responses": {
+ "201": {
+ "description": "OICP Endpoint created successfully",
+ "content": {
+ "application/json": {
+ "example": {
+ "id": "###",
+ "status": "Success"
+ }
+ }
+ }
+ },
+ "401": {
+ "$ref": "#/components/responses/UnauthorizedError"
+ },
+ "403": {
+ "$ref": "#/components/responses/ForbiddenError"
+ },
+ "500": {
+ "$ref": "#/components/responses/BackendError"
+ }
+ }
+ }
+ },
+ "/api/oicp/endpoints/{id}/ping": {
+ "put": {
+ "security": [
+ {
+ "bearerAuth": []
+ }
+ ],
+ "description": "Ping an OICP Endpoint",
+ "tags": [
+ "OICP"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/OICPEndpointID"
+ }
+ ],
+ "requestBody": {
+ "content": {
+ "application/json": {
+ "schema": {
+ "$ref": "#/components/schemas/OICPEndpoint"
+ }
+ }
+ }
+ },
+ "responses": {
+ "200": {
+ "description": "OICP Endpoint is reachable",
+ "content": {
+ "application/json": {
+ "example": {
+ "status": "Success",
+ "statusCode": "000",
+ "statusText": "OK"
+ }
+ }
+ }
+ },
+ "401": {
+ "$ref": "#/components/responses/UnauthorizedError"
+ },
+ "403": {
+ "$ref": "#/components/responses/ForbiddenError"
+ },
+ "500": {
+ "$ref": "#/components/responses/BackendError"
+ },
+ "550": {
+ "$ref": "#/components/responses/ResourceDoesNotExists"
+ }
+ }
+ }
+ },
+ "/api/oicp/endpoints/:id/evses/statuses/send": {
+ "put": {
+ "security": [
+ {
+ "bearerAuth": []
+ }
+ ],
+ "description": "Send OICP EVSE's statuses",
+ "tags": [
+ "OICP"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/OICPEndpointID"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OICP Endpoint's EVSE's statuses sent",
+ "content": {
+ "application/json": {
+ "example": {
+ "status": "Success"
+ }
+ }
+ }
+ },
+ "401": {
+ "$ref": "#/components/responses/UnauthorizedError"
+ },
+ "403": {
+ "$ref": "#/components/responses/ForbiddenError"
+ },
+ "500": {
+ "$ref": "#/components/responses/BackendError"
+ },
+ "550": {
+ "$ref": "#/components/responses/ResourceDoesNotExists"
+ }
+ }
+ }
+ },
+ "/api/oicp/endpoints/:id/evses/send": {
+ "put": {
+ "security": [
+ {
+ "bearerAuth": []
+ }
+ ],
+ "description": "Send OICP EVSEs",
+ "tags": [
+ "OICP"
+ ],
+ "parameters": [
+ {
+ "$ref": "#/components/parameters/OICPEndpointID"
+ }
+ ],
+ "responses": {
+ "200": {
+ "description": "OICP Endpoint's EVSEs sent",
+ "content": {
+ "application/json": {
+ "example": {
+ "status": "Success"
+ }
+ }
+ }
+ },
+ "401": {
+ "$ref": "#/components/responses/UnauthorizedError"
+ },
+ "403": {
+ "$ref": "#/components/responses/ForbiddenError"
+ },
+ "500": {
+ "$ref": "#/components/responses/BackendError"
+ },
+ "550": {
+ "$ref": "#/components/responses/ResourceDoesNotExists"
+ }
+ }
+ }
}
},
"components": {
"type": "boolean"
}
}
+ },
+ "OICPEndpoint": {
+ "type": "object",
+ "required": [
+ "name",
+ "role",
+ "baseUrl"
+ ],
+ "properties": {
+ "id": {
+ "type": "string",
+ "readOnly": true
+ },
+ "name": {
+ "type": "string"
+ },
+ "role": {
+ "type": "string",
+ "enum": [
+ "CPO",
+ "EMSP"
+ ]
+ },
+ "baseUrl": {
+ "type": "string"
+ },
+ "countryCode": {
+ "type": "string"
+ },
+ "partyId": {
+ "type": "string"
+ },
+ "backgroundPatchJob": {
+ "type": "boolean"
+ }
+ }
}
},
"parameters": {
"schema": {
"type": "string"
}
+ },
+ "OICPEndpointID": {
+ "in": "path",
+ "name": "id",
+ "description": "OICP Endpoint ID",
+ "required": true,
+ "schema": {
+ "type": "string"
+ }
}
}
}

Added oicp create/ping/sendevsestatus/sendevses documentation