seatschart 0.1.1 → 0.3.0

data/lib/seatschart/api/health_api.rb

@@ -73,5 +73,249 @@ module SeatsChart
       end
       return data, status_code, headers
     end
+
+    # Public platform status and 90-day uptime
+    # Current state, latest latency and 90 days of daily uptime per component, automatic incidents and operator notices (incidents and maintenance). A sampler in the reservation worker probes every component every 30 s (STATUS_SAMPLE_INTERVAL_SEC) and keeps compact per-minute and per-day rollups in Redis (`status:*` keys, 90 days, bounded). Minutes without a sample — for example while the sampler itself is down — are reported as no data (`uptime: null`, `coverage` below 1), never as up. No authentication; IP rate limited; `Cache-Control: public, max-age=30, stale-while-revalidate=60`; gzip or br by `Accept-Encoding` with a weak `ETag` (304 on `If-None-Match`). No hostnames, error texts or other internals are exposed. 503 `redis_unavailable` when Redis cannot be read.
+    # @param [Hash] opts the optional parameters
+    # @return [GetApiStatus200Response]
+    def get_api_status(opts = {})
+      data, _status_code, _headers = get_api_status_with_http_info(opts)
+      data
+    end
+
+    # Public platform status and 90-day uptime
+    # Current state, latest latency and 90 days of daily uptime per component, automatic incidents and operator notices (incidents and maintenance). A sampler in the reservation worker probes every component every 30 s (STATUS_SAMPLE_INTERVAL_SEC) and keeps compact per-minute and per-day rollups in Redis (`status:*` keys, 90 days, bounded). Minutes without a sample — for example while the sampler itself is down — are reported as no data (`uptime: null`, `coverage` below 1), never as up. No authentication; IP rate limited; `Cache-Control: public, max-age=30, stale-while-revalidate=60`; gzip or br by `Accept-Encoding` with a weak `ETag` (304 on `If-None-Match`). No hostnames, error texts or other internals are exposed. 503 `redis_unavailable` when Redis cannot be read.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(GetApiStatus200Response, Integer, Hash)>] GetApiStatus200Response data, response status code and response headers
+    def get_api_status_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: HealthApi.get_api_status ...'
+      end
+      # resource path
+      local_var_path = '/api/status'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Accept' (if needed)
+      header_params['Accept'] = @api_client.select_header_accept(['application/json', 'multipart/form-data', 'text/plain']) unless header_params['Accept']
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type] || 'GetApiStatus200Response'
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"HealthApi.get_api_status",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: HealthApi#get_api_status\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Liveness probe
+    # Answers 200 `{ status: \"ok\" }` while the process serves requests, with no Redis or PostgreSQL check (use `GET /api/health` for readiness). Still served while the API drains on shutdown.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def get_health_live(opts = {})
+      get_health_live_with_http_info(opts)
+      nil
+    end
+
+    # Liveness probe
+    # Answers 200 &#x60;{ status: \&quot;ok\&quot; }&#x60; while the process serves requests, with no Redis or PostgreSQL check (use &#x60;GET /api/health&#x60; for readiness). Still served while the API drains on shutdown.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def get_health_live_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: HealthApi.get_health_live ...'
+      end
+      # resource path
+      local_var_path = '/health/live'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"HealthApi.get_health_live",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: HealthApi#get_health_live\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Prometheus metrics
+    # Prometheus text exposition (`text/plain; version=0.0.4`) of the API process metrics. Requires `Authorization: Bearer <OBSERVABILITY_TOKEN>` (at least 32 characters); any other request, or an API without the token configured, gets 404 `not_found`.
+    # @param [Hash] opts the optional parameters
+    # @return [nil]
+    def get_internal_metrics(opts = {})
+      get_internal_metrics_with_http_info(opts)
+      nil
+    end
+
+    # Prometheus metrics
+    # Prometheus text exposition (&#x60;text/plain; version&#x3D;0.0.4&#x60;) of the API process metrics. Requires &#x60;Authorization: Bearer &lt;OBSERVABILITY_TOKEN&gt;&#x60; (at least 32 characters); any other request, or an API without the token configured, gets 404 &#x60;not_found&#x60;.
+    # @param [Hash] opts the optional parameters
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def get_internal_metrics_with_http_info(opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: HealthApi.get_internal_metrics ...'
+      end
+      # resource path
+      local_var_path = '/internal/metrics'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body]
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"HealthApi.get_internal_metrics",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:GET, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: HealthApi#get_internal_metrics\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
+
+    # Replace status page notices (operators)
+    # Replaces the manual incident and maintenance notices shown on the public status page (at most 20, English text). An incident with `endsAt` in the past is resolved; a maintenance window is scheduled, in progress or completed from its times. Requires `Authorization: Bearer <OBSERVABILITY_TOKEN>`; any other request gets 404 `not_found`. Send `{ \"notices\": [] }` to clear.
+    # @param put_internal_status_notices_request [PutInternalStatusNoticesRequest] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Required on transactional routes. Reuse the same key for every retry of one logical operation; the API replays the stored outcome.
+    # @return [nil]
+    def put_internal_status_notices(put_internal_status_notices_request, opts = {})
+      put_internal_status_notices_with_http_info(put_internal_status_notices_request, opts)
+      nil
+    end
+
+    # Replace status page notices (operators)
+    # Replaces the manual incident and maintenance notices shown on the public status page (at most 20, English text). An incident with &#x60;endsAt&#x60; in the past is resolved; a maintenance window is scheduled, in progress or completed from its times. Requires &#x60;Authorization: Bearer &lt;OBSERVABILITY_TOKEN&gt;&#x60;; any other request gets 404 &#x60;not_found&#x60;. Send &#x60;{ \&quot;notices\&quot;: [] }&#x60; to clear.
+    # @param put_internal_status_notices_request [PutInternalStatusNoticesRequest] 
+    # @param [Hash] opts the optional parameters
+    # @option opts [String] :idempotency_key Required on transactional routes. Reuse the same key for every retry of one logical operation; the API replays the stored outcome.
+    # @return [Array<(nil, Integer, Hash)>] nil, response status code and response headers
+    def put_internal_status_notices_with_http_info(put_internal_status_notices_request, opts = {})
+      if @api_client.config.debugging
+        @api_client.config.logger.debug 'Calling API: HealthApi.put_internal_status_notices ...'
+      end
+      # verify the required parameter 'put_internal_status_notices_request' is set
+      if @api_client.config.client_side_validation && put_internal_status_notices_request.nil?
+        fail ArgumentError, "Missing the required parameter 'put_internal_status_notices_request' when calling HealthApi.put_internal_status_notices"
+      end
+      if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length > 255
+        fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling HealthApi.put_internal_status_notices, the character length must be smaller than or equal to 255.'
+      end
+
+      if @api_client.config.client_side_validation && !opts[:'idempotency_key'].nil? && opts[:'idempotency_key'].to_s.length < 1
+        fail ArgumentError, 'invalid value for "opts[:"idempotency_key"]" when calling HealthApi.put_internal_status_notices, the character length must be great than or equal to 1.'
+      end
+
+      # resource path
+      local_var_path = '/internal/status/notices'
+
+      # query parameters
+      query_params = opts[:query_params] || {}
+
+      # header parameters
+      header_params = opts[:header_params] || {}
+      # HTTP header 'Content-Type'
+      content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data', 'text/plain'])
+      if !content_type.nil?
+          header_params['Content-Type'] = content_type
+      end
+      header_params[:'Idempotency-Key'] = opts[:'idempotency_key'] if !opts[:'idempotency_key'].nil?
+
+      # form parameters
+      form_params = opts[:form_params] || {}
+
+      # http body (model)
+      post_body = opts[:debug_body] || @api_client.object_to_http_body(put_internal_status_notices_request)
+
+      # return_type
+      return_type = opts[:debug_return_type]
+
+      # auth_names
+      auth_names = opts[:debug_auth_names] || []
+
+      new_options = opts.merge(
+        :operation => :"HealthApi.put_internal_status_notices",
+        :header_params => header_params,
+        :query_params => query_params,
+        :form_params => form_params,
+        :body => post_body,
+        :auth_names => auth_names,
+        :return_type => return_type
+      )
+
+      data, status_code, headers = @api_client.call_api(:PUT, local_var_path, new_options)
+      if @api_client.config.debugging
+        @api_client.config.logger.debug "API called: HealthApi#put_internal_status_notices\nData: #{data.inspect}\nStatus code: #{status_code}\nHeaders: #{headers}"
+      end
+      return data, status_code, headers
+    end
   end
 end