action rudder_api_informations {
  label: "Get information about one API endpoint"
  description: "Get the description and the list of supported version for one API endpoint"
  provider: rudder
  method: GET
  path: "/info/details/{endpointName}"
  encoding: json
  input: {
    type: "object"
    properties: {
      endpointName: {
        type: "string"
      }
    }
    required: ["endpointName"]
    additionalProperties: false
  }
  output: {
    type: "object"
    required: ["action", "data", "result"]
    properties: {
      action: {
        type: "string"
        description: "The id of the action"
        enum: ["apiInformations"]
      }
      data: {
        type: "object"
        required: ["documentation", "endpointName", "endpoints"]
        properties: {
          documentation: {
            type: "string"
            description: "Link to Rudder API description"
          }
          endpointName: {
            type: "string"
            description: "The endpoint name as key and the endpoint description as value"
          }
          endpoints: {
            type: "array"
            items: {
              type: "object"
              description: "Supported path and version for that endpoint"
              properties: {
                httpVerb: {
                  format: "The HTTP verb for the endpoint for key and the supported version and API path for value"
                  type: "object"
                }
                version: {
                  type: "object"
                  properties: {
                    all: {
                      type: "array"
                      description: "List of API version and status"
                      items: {
                        type: "object"
                        required: ["version", "status"]
                        properties: {
                          status: {
                            format: "string"
                            description: "Status of the API, either maintained or deprecated"
                            required: ["maintained", "deprecated"]
                            type: "object"
                          }
                          version: {
                            type: "integer"
                            description: "API Version"
                          }
                        }
                      }
                    }
                    latest: {
                      type: "integer"
                      description: "Latest API version available"
                    }
                  }
                }
              }
            }
          }
        }
      }
      result: {
        type: "string"
        description: "Result of the request"
        enum: ["success", "error"]
      }
    }
  }
}