openapi.json

{
    "openapi": "3.0.0",
    "servers": [
        {
            "url": ""
        }
    ],
    "info": {
        "description": "A service to be used to store Insights operator configuration and to offer the configuration to selected operator",
        "version": "1.0.0",
        "title": "Insights operator controller service",
        "termsOfService": "https://github.com/RedHatInsights/insights-operator-controller/blob/master/CONTRIBUTING.md",
        "contact": {
            "email": "ptisnovs@redhat.com",
            "name": "Pavel Tisnovsky",
            "url": "https://github.com/RedHatInsights/insights-operator-controller/"
        },
        "license": {
            "name": "Apache 2.0",
            "url": "http://www.apache.org/licenses/LICENSE-2.0.html"
        }
    },
    "tags": [],
    "paths": {
        "/": {
            "get": {
                "summary": "Returns valid HTTP 200 ok status when the service is ready",
                "description": "Returns valid HTTP 200 ok status when the service is ready to response to requests that come from clients",
                "parameters": [],
                "operationId": "main",
                "responses": {
                    "default": {
                        "description": "Default response"
                    }
                }
            }
        },
        "/client/cluster": {
            "x-temp": {
                "summary": "Read list of all clusters from database and return it to a client",
                "description": "Read list of all clusters from database and return it to a client",
                "parameters": [],
                "operationId": "getClusters",
                "responses": {
                    "default": {
                        "description": "Default response"
                    }
                }
            },
            "get": {
                "summary": "Read list of all clusters from database and return it to a client",
                "description": "Read list of all clusters from database and return it to a client.",
                "parameters": [],
                "operationId": "getClusters",
                "responses": {
                    "default": {
                        "description": "Default response"
                    }
                }
            }
        },
        "/client/cluster/{name}": {
            "get": {
                "summary": "Read cluster specified by its ID and return it to a client",
                "description": "Read cluster specified by its unique ID and return it to a client.",
                "parameters": [],
                "operationId": "getClusterById",
                "responses": {
                    "default": {
                        "description": "Default response"
                    }
                }
            },
            "post": {
                "summary": "Create a record with new cluster in a database. The updated list of all clusters is returned to client",
                "description": "Create a record with new cluster in a database. The updated list of all clusters is returned to client to recheck.",
                "parameters": [],
                "operationId": "newCluster",
                "responses": {
                    "default": {
                        "description": "Default response"
                    }
                }
            },
            "delete": {
                "summary": "Delete a cluster specified by its ID",
                "description": "Delete a cluster specified by its unique ID.",
                "parameters": [],
                "operationId": "deleteCluster",
                "responses": {
                    "default": {
                        "description": "Default response"
                    }
                }
            }
        },
        "/client/cluster/search": {
            "get": {
                "summary": "Search for a cluster specified by its ID or name",
                "description": "Search for a cluster specified by its ID or by its name. Both parameters are optional.",
                "parameters": [
                    {
                        "name": "id",
                        "in": "query",
                        "required": false,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Cluster ID",
                        "allowEmptyValue": true
                    },
                    {
                        "name": "name",
                        "in": "query",
                        "required": false,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Cluster name",
                        "allowEmptyValue": true
                    }
                ],
                "operationId": "searchCluster",
                "responses": {
                    "default": {
                        "description": "Default response"
                    }
                }
            }
        },
        "/client/profile": {
            "get": {
                "summary": "Read list of configuration profiles",
                "description": "Read list of all configuration profiles without any filtering.",
                "parameters": [],
                "operationId": "listConfigurationProfiles",
                "responses": {
                    "default": {
                        "description": "Default response"
                    }
                }
            },
            "post": {
                "summary": "Creates new configuration profile",
                "description": "Create new configuration profile from data that needs to be sent in payload.",
                "parameters": [],
                "operationId": "newConfigurationProfile",
                "responses": {
                    "default": {
                        "description": "Default response"
                    }
                }
            }
        },
        "/client/profile/{id}": {
            "get": {
                "summary": "Read profile specified by its ID",
                "description": "Read configuration profile specified by its unique ID.",
                "parameters": [
                    {
                        "name": "id",
                        "in": "query",
                        "required": false,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Profile ID"
                    }
                ],
                "operationId": "getConfigurationProfile",
                "responses": {
                    "default": {
                        "description": "Default response"
                    }
                }
            },
            "delete": {
                "summary": "Delete configuration profile",
                "description": "Delete configuration profile specified by its unique ID.",
                "parameters": [
                    {
                        "name": "id",
                        "in": "query",
                        "required": false,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Profile ID"
                    }
                ],
                "operationId": "deleteConfigurationProfile",
                "responses": {
                    "default": {
                        "description": "Default response"
                    }
                }
            },
            "put": {
                "summary": "Change configuration profile",
                "description": "Change configuration profile identified by its unique ID. Profile data need to be sent in payload.",
                "parameters": [
                    {
                        "name": "id",
                        "in": "query",
                        "required": false,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Profile ID"
                    }
                ],
                "operationId": "changeConfigurationProfile",
                "responses": {
                    "default": {
                        "description": "Default response"
                    }
                }
            }
        },
        "/client/configuration": {
            "get": {
                "summary": "Return list of all configurations",
                "description": "Return list of all cluster configurations.",
                "parameters": [],
                "operationId": "getAllConfigurations",
                "responses": {
                    "default": {
                        "description": "Default response"
                    }
                }
            }
        },
        "/client/configuration/{id}": {
            "get": {
                "summary": "Return single configuration identified by its ID",
                "description": "Return single configuration identified by its unique ID.",
                "parameters": [
                    {
                        "name": "id",
                        "in": "query",
                        "required": false,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Configuration ID"
                    }
                ],
                "operationId": "getConfiguration",
                "responses": {
                    "default": {
                        "description": "Default response"
                    }
                }
            },
            "delete": {
                "summary": "Remove single configuration identified by its ID",
                "description": "Remove single configuration identified by its unique ID.",
                "parameters": [
                    {
                        "name": "id",
                        "in": "query",
                        "required": false,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Configuration ID"
                    }
                ],
                "operationId": "deleteConfiguration",
                "responses": {
                    "default": {
                        "description": "Default response"
                    }
                }
            }
        },
        "/client/configuration/{id}/enable": {
            "put": {
                "summary": "Enable configuration identified by its ID",
                "description": "Enable cluster configuration identified by its ID.",
                "parameters": [
                    {
                        "name": "id",
                        "in": "query",
                        "required": false,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Configuration ID"
                    }
                ],
                "operationId": "enableConfiguration",
                "responses": {
                    "default": {
                        "description": "Default response"
                    }
                }
            }
        },
        "/client/configuration/{id}/disable": {
            "put": {
                "summary": "Disable configuration identified by its ID",
                "description": "Disable cluster configuration identified by its ID.",
                "parameters": [
                    {
                        "name": "od",
                        "in": "query",
                        "required": false,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Configuration ID"
                    }
                ],
                "operationId": "disableConfiguration",
                "responses": {
                    "default": {
                        "description": "Default response"
                    }
                }
            }
        },
        "/client/trigger": {
            "get": {
                "summary": "Return list of all triggers",
                "description": "Return list of all triggers that are stored in database.",
                "parameters": [],
                "operationId": "getAllTriggers",
                "responses": {
                    "default": {
                        "description": "Default response"
                    }
                }
            }
        },
        "/client/trigger/{id}": {
            "get": {
                "summary": "Return single trigger specified by its ID",
                "description": "Retrieve information about trigger specified by its unique ID.",
                "parameters": [
                    {
                        "name": "id",
                        "in": "query",
                        "required": false,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Trigger ID"
                    }
                ],
                "operationId": "getTrigger",
                "responses": {
                    "default": {
                        "description": "Default response"
                    }
                }
            },
            "delete": {
                "summary": "Delete single trigger",
                "description": "Delete trigger specified by its unique ID from service database.",
                "parameters": [
                    {
                        "name": "id",
                        "in": "query",
                        "required": false,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Trigger ID"
                    }
                ],
                "operationId": "deleteTrigger",
                "responses": {
                    "default": {
                        "description": "Default response"
                    }
                }
            }
        },
        "/client/cluster/{cluster}/trigger": {
            "get": {
                "summary": "Return list of triggers for single cluster",
                "description": "Retrieve list of triggers for specified cluster. Cluster needs to be specified by its unique ID.",
                "parameters": [
                    {
                        "name": "cluster",
                        "in": "query",
                        "required": false,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Cluster ID"
                    }
                ],
                "operationId": "getClusterTriggers",
                "responses": {
                    "default": {
                        "description": "Default response"
                    }
                }
            }
        },
        "/client/cluster/{cluster}/trigger/{trigger}": {
            "post": {
                "summary": "Register new trigger for cluster",
                "description": "Register new trigger (and all its information) for a cluster specified by its unique ID.",
                "parameters": [
                    {
                        "name": "cluster",
                        "in": "query",
                        "required": false,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Cluster ID"
                    },
                    {
                        "name": "trigger",
                        "in": "query",
                        "required": false,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Trigger ID"
                    }
                ],
                "operationId": "registerClusterTrigger",
                "responses": {
                    "default": {
                        "description": "Default response"
                    }
                }
            }
        },
        "/client/trigger/{id}/activate": {
            "post": {
                "summary": "Activate filter",
                "description": "Activate trigger identified by its unique ID.",
                "parameters": [
                    {
                        "name": "id",
                        "in": "query",
                        "required": false,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Trigger ID"
                    }
                ],
                "operationId": "activateTriggerByPost",
                "responses": {
                    "default": {
                        "description": "Default response"
                    }
                }
            },
            "put": {
                "summary": "Activate filter",
                "description": "Activate trigger identified by its unique ID.",
                "parameters": [
                    {
                        "name": "id",
                        "in": "query",
                        "required": false,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Trigger ID"
                    }
                ],
                "operationId": "activateTriggerByPut",
                "responses": {
                    "default": {
                        "description": "Default response"
                    }
                }
            }
        },
        "/client/trigger/{id}/deactivate": {
            "post": {
                "summary": "Deactivate trigger",
                "description": "Deactivate trigger identified by its unique ID.",
                "parameters": [
                    {
                        "name": "id",
                        "in": "query",
                        "required": false,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Trigger ID"
                    }
                ],
                "operationId": "deactivateTriggerByPost",
                "responses": {
                    "default": {
                        "description": "Default response"
                    }
                }
            },
            "put": {
                "summary": "Deactivate trigger",
                "description": "Deactivate trigger identified by its unique ID.",
                "parameters": [
                    {
                        "name": "id",
                        "in": "query",
                        "required": false,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Trigger ID"
                    }
                ],
                "operationId": "deactivateTriggerByPut",
                "responses": {
                    "default": {
                        "description": "Default response"
                    }
                }
            }
        },
        "/metrics": {
            "get": {
                "summary": "Read all metrics exposed by this service",
                "description": "Set of metrics providing total number of requests counter, API endpoints response times, and counter of HTTP status code responses. Additionally it is possible to consume all metrics provided by Go runtime. These metrics start with go_ and process_ prefixes.",
                "parameters": [],
                "operationId": "getMetrics",
                "responses": {
                    "default": {
                        "description": "Default response containing all metrics in semi-structured text format"
                    }
                }
            }
        },
        "/operator/register/{cluster}": {
            "get": {
                "summary": "Register new cluster",
                "description": "Register new cluster in this service. Cluster needs to be specified by its unique ID.",
                "parameters": [],
                "operationId": "registerCluster",
                "responses": {
                    "default": {
                        "description": "Default response"
                    }
                }
            }
        },
        "/operator/configuration/{cluster}": {
            "get": {
                "summary": "Read configuration for operator for given cluster",
                "description": "Retrieve configuration for operator running in given cluster. Cluster is specified by its unique ID.",
                "parameters": [
                    {
                        "name": "cluster",
                        "in": "query",
                        "required": false,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Cluster ID"
                    }
                ],
                "operationId": "readConfigurationForOperator",
                "responses": {
                    "default": {
                        "description": "Default response"
                    }
                }
            }
        },
        "/operator/triggers/{cluster}": {
            "get": {
                "summary": "Get all active triggers for a given cluster",
                "description": "Retrieve list of all triggers that are set active for a given cluster. Cluster needs to be specified by its unique ID.",
                "parameters": [
                    {
                        "name": "cluster",
                        "in": "query",
                        "required": false,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Cluster ID"
                    }
                ],
                "operationId": "getActiveTriggersForCluster",
                "responses": {
                    "default": {
                        "description": "Default response"
                    }
                }
            }
        },
        "/operator/trigger/{cluster}/ack/{trigger}": {
            "get": {
                "summary": "Ack single cluster's trigger",
                "description": "Ack trigger for selected cluster. Cluster and trigger have to be identified by theirs unique ID.",
                "parameters": [
                    {
                        "name": "cluster",
                        "in": "query",
                        "required": false,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Cluster ID"
                    },
                    {
                        "name": "trigger",
                        "in": "query",
                        "required": false,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Trigger ID"
                    }
                ],
                "operationId": "ackTriggerForClusterByGet",
                "responses": {
                    "default": {
                        "description": "Default response"
                    }
                }
            },
            "put": {
                "summary": "Ack single cluster's trigger",
                "description": "Ack trigger for selected cluster. Cluster and trigger have to be identified by theirs unique ID.",
                "parameters": [
                    {
                        "name": "cluster",
                        "in": "query",
                        "required": false,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Cluster ID"
                    },
                    {
                        "name": "trigger",
                        "in": "query",
                        "required": false,
                        "schema": {
                            "type": "string"
                        },
                        "description": "Trigger ID"
                    }
                ],
                "operationId": "ackTriggerForClusterByPut",
                "responses": {
                    "default": {
                        "description": "Default response"
                    }
                }
            }
        }
    },
    "externalDocs": {
        "description": "Please see https://github.com/RedHatInsights/insights-operator-controller/blob/master/README.md",
        "url": "https://godoc.org/github.com/RedHatInsights/insights-operator-controller"
    },
    "security": []
}