Skip to content

Commit

Permalink
[#IOPAE-592] Remove Old Services Deprecated APIs (#696)
Browse files Browse the repository at this point in the history
  • Loading branch information
@StefanoDoc
StefanoDoc authored Oct 2, 2023
1 parent c677b3a commit d6425fb
Showing 1 changed file with 0 additions and 246 deletions.
246 changes: 0 additions & 246 deletions src/core/api/io_services/v1/_swagger.json.tpl
View file
Original file line number Diff line number Diff line change
Expand Up @@ -425,252 +425,6 @@
]
}
},
"/services": {
"post": {
"operationId": "createService",
"summary": "Create Service",
"description": "Create a new Service with the attributes provided in the request payload.\n",
"parameters": [
{
"in": "body",
"name": "body",
"description": "A service can invoke the IO API by providing the relative API key\n(every service has an associated primary and secondary API key).\nThrough the API a service can send messages to the IO users\nthat haven't opted out from it. Service metadata are used\nto qualify the sender of these messages to the recipient.",
"schema": {
"$ref": "#/definitions/ServicePayload"
}
}
],
"responses": {
"200": {
"description": "Service created.",
"schema": {
"$ref": "#/definitions/ServiceWithSubscriptionKeys"
}
},
"400": {
"description": "Invalid payload.",
"schema": {
"$ref": "#/definitions/ProblemJson"
}
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden."
},
"429": {
"description": "Too many requests."
},
"500": {
"description": "The service cannot be created.",
"schema": {
"$ref": "#/definitions/ProblemJson"
}
}
}
},
"get": {
"operationId": "getUserServices",
"summary": "Get User Services",
"description": "Retrieve the identifiers of the services owned by the calling user\n",
"responses": {
"200": {
"description": "The list of service ids.",
"schema": {
"$ref": "#/definitions/ServiceIdCollection"
}
},
"401": {
"description": "Unauthorized."
},
"429": {
"description": "Too many requests."
}
}
}
},
"/services/{service_id}": {
"parameters": [
{
"name": "service_id",
"in": "path",
"type": "string",
"required": true,
"description": "The ID of an existing Service."
}
],
"get": {
"operationId": "getService",
"summary": "Get Service",
"description": "Retrieve a previously created service with the provided service ID.\nThis API operation needs the same API key of the service being retrieved\notherwise 403 forbidden will be returned to the caller.\n",
"responses": {
"200": {
"description": "Service found.",
"schema": {
"$ref": "#/definitions/ServiceWithSubscriptionKeys"
}
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden."
},
"404": {
"description": "No service found for the provided ID."
},
"429": {
"description": "Too many requests."
}
}
},
"put": {
"operationId": "updateService",
"summary": "Update Service",
"description": "Update a previously created service with the provided service ID\nThis API operation needs the same API key of the service being retrieved\notherwise 403 forbidden will be returned to the caller.",
"parameters": [
{
"in": "body",
"name": "body",
"description": "The updated service payload.",
"schema": {
"$ref": "#/definitions/ServicePayload"
}
}
],
"responses": {
"200": {
"description": "Service updated.",
"schema": {
"$ref": "#/definitions/ServiceWithSubscriptionKeys"
}
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden."
},
"404": {
"description": "No service found for the provided ID."
},
"429": {
"description": "Too many requests."
},
"500": {
"description": "The service cannot be updated.",
"schema": {
"$ref": "#/definitions/ProblemJson"
}
}
}
}
},
"/services/{service_id}/logo": {
"parameters": [
{
"name": "service_id",
"in": "path",
"type": "string",
"required": true,
"description": "The ID of an existing Service."
}
],
"put": {
"summary": "Upload service logo.",
"description": "Upsert a logo for an existing service.\nThis API operation needs the same API key of the service being retrieved\notherwise 403 forbidden will be returned to the caller.\n",
"operationId": "uploadServiceLogo",
"parameters": [
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/Logo"
},
"description": "A base64 string representation of the service logo PNG image. It can be the service own logo or the organization logo."
}
],
"responses": {
"200": {
"description": "Logo uploaded."
},
"400": {
"description": "Invalid payload.",
"schema": {
"$ref": "#/definitions/ProblemJson"
}
},
"401": {
"description": "Unauthorized."
},
"403": {
"description": "Forbidden."
},
"404": {
"description": "No service found for the provided ID."
},
"500": {
"description": "The service logo cannot be uploaded.",
"schema": {
"$ref": "#/definitions/ProblemJson"
}
}
}
}
},
"/services/{service_id}/keys": {
"put": {
"summary": "Regenerate Service Key",
"description": "Regenerate the specified key for the Service identified by the provided id.\nThis API operation needs the same API key of the service being retrieved\notherwise 403 forbidden will be returned to the caller.",
"operationId": "regenerateServiceKey",
"parameters": [
{
"name": "service_id",
"in": "path",
"type": "string",
"required": true,
"description": "The ID of an existing Service."
},
{
"name": "body",
"in": "body",
"required": true,
"schema": {
"$ref": "#/definitions/SubscriptionKeyTypePayload"
},
"description": "The type of the key to be regenerated (PRIMARY_KEY or SECONDARY_KEY)."
}
],
"responses": {
"200": {
"description": "The subscription keys for the service.",
"schema": {
"$ref": "#/definitions/SubscriptionKeys"
}
},
"400": {
"description": "Invalid payload.",
"schema": {
"$ref": "#/definitions/ProblemJson"
}
},
"403": {
"description": "Forbidden."
},
"404": {
"description": "Service not found."
},
"500": {
"description": "Cannot regenerate service key.",
"schema": {
"$ref": "#/definitions/ProblemJson"
}
}
}
}
},
"/organizations/{organization_fiscal_code}/logo": {
"parameters": [
{
Expand Down

0 comments on commit d6425fb

Please sign in to comment.