seatschart 0.2.0 → 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

data/lib/seatschart/api/map_designer_api.rb

@@ -19,8 +19,8 @@ module SeatsChart
     def initialize(api_client = ApiClient.default)
       @api_client = api_client
     end
-    # Extract seat candidates with OpenCV
-    # Multipart file and optional calibration JSON (sample patches, rotations and grouping); returns source-image pixel coordinates for review. Does not persist seats. Requires CV_SERVICE_URL.
+    # Extract seat candidates from a floor-plan image
+    # Multipart image (PNG/JPEG/WebP, at most 8 MiB and 16 megapixels). Returns seat centres in source-image pixels for review in the map designer, plus the `mode` that produced them; nothing is persisted. Requires CV_SERVICE_URL.  Review (`auto` and `examples`): every seat carries a `confidence` (0-1) and the uncertain ones `doubtful: true`; `review` counts them and the designer shows them for a keep/remove decision instead of keeping them silently. `legibility` is `ok`, `low_resolution` or `no_individual_seats`; when it is not `ok` every seat is doubtful and the count is not reliable. `suggested` lists places where a seat was probably missed (not part of `seats`); the designer offers them in the review. Clicks never remove a seat on weak evidence: a seat they argue against stays, flagged `doubtful`. When the clicked seats (or, without clicks, an illegible plan) are tiny, the scanner reads the plan again upscaled. Vector plans: send the PDF or SVG as `vector` (and `vector_page`) next to its rendered image; the response says whether its geometry was `used`.  Modes: `auto` (default) finds the repeated seat glyphs on its own and infers size, rotation and threshold; `examples` uses 1-24 clicked seats (`examples`): a click on a missed seat adds that look, then only detections consistent with the clicked seats (their look, size and spacing, or the same drawn vector shape) stay, plus seats of another look that the scanner is confident about; every clicked seat is kept; `edges` is the legacy contour mode tuned by the `seat_diameter`/`closing_kernel` query parameters.  Refinements for `auto` and `examples`: `negatives` (points the user marked as not a seat after a scan) remove that detection and its look-alikes, or the whole style when most of it looks alike; `region` limits the scan to a rectangle.  `calibration` (sample patches) and `profile` (the mapa1-mapa6 regression benchmark) are kept for backward compatibility and cannot be combined with `mode`, `examples`, `negatives` or `region`. Errors: 422 for invalid parameters or work budgets, 413/415 for oversized or unsupported images (or a `vector` file that is neither PDF nor SVG), 503 when the scanner is busy or not configured, 504 on its 80-second deadline.
     # @param post_api_extract_seats_request [PostApiExtractSeatsRequest] 
     # @param [Hash] opts the optional parameters
     # @option opts [Float] :seat_diameter 
@@ -28,14 +28,14 @@ module SeatsChart
     # @option opts [Float] :canny_low 
     # @option opts [Float] :canny_high 
     # @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]
+    # @return [PostApiExtractSeats200Response]
     def post_api_extract_seats(post_api_extract_seats_request, opts = {})
-      post_api_extract_seats_with_http_info(post_api_extract_seats_request, opts)
-      nil
+      data, _status_code, _headers = post_api_extract_seats_with_http_info(post_api_extract_seats_request, opts)
+      data
     end
 
-    # Extract seat candidates with OpenCV
-    # Multipart file and optional calibration JSON (sample patches, rotations and grouping); returns source-image pixel coordinates for review. Does not persist seats. Requires CV_SERVICE_URL.
+    # Extract seat candidates from a floor-plan image
+    # Multipart image (PNG/JPEG/WebP, at most 8 MiB and 16 megapixels). Returns seat centres in source-image pixels for review in the map designer, plus the `mode` that produced them; nothing is persisted. Requires CV_SERVICE_URL.  Review (`auto` and `examples`): every seat carries a `confidence` (0-1) and the uncertain ones `doubtful: true`; `review` counts them and the designer shows them for a keep/remove decision instead of keeping them silently. `legibility` is `ok`, `low_resolution` or `no_individual_seats`; when it is not `ok` every seat is doubtful and the count is not reliable. `suggested` lists places where a seat was probably missed (not part of `seats`); the designer offers them in the review. Clicks never remove a seat on weak evidence: a seat they argue against stays, flagged `doubtful`. When the clicked seats (or, without clicks, an illegible plan) are tiny, the scanner reads the plan again upscaled. Vector plans: send the PDF or SVG as `vector` (and `vector_page`) next to its rendered image; the response says whether its geometry was `used`.  Modes: `auto` (default) finds the repeated seat glyphs on its own and infers size, rotation and threshold; `examples` uses 1-24 clicked seats (`examples`): a click on a missed seat adds that look, then only detections consistent with the clicked seats (their look, size and spacing, or the same drawn vector shape) stay, plus seats of another look that the scanner is confident about; every clicked seat is kept; `edges` is the legacy contour mode tuned by the `seat_diameter`/`closing_kernel` query parameters.  Refinements for `auto` and `examples`: `negatives` (points the user marked as not a seat after a scan) remove that detection and its look-alikes, or the whole style when most of it looks alike; `region` limits the scan to a rectangle.  `calibration` (sample patches) and `profile` (the mapa1-mapa6 regression benchmark) are kept for backward compatibility and cannot be combined with `mode`, `examples`, `negatives` or `region`. Errors: 422 for invalid parameters or work budgets, 413/415 for oversized or unsupported images (or a `vector` file that is neither PDF nor SVG), 503 when the scanner is busy or not configured, 504 on its 80-second deadline.
     # @param post_api_extract_seats_request [PostApiExtractSeatsRequest] 
     # @param [Hash] opts the optional parameters
     # @option opts [Float] :seat_diameter 
@@ -43,7 +43,7 @@ module SeatsChart
     # @option opts [Float] :canny_low 
     # @option opts [Float] :canny_high 
     # @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
+    # @return [Array<(PostApiExtractSeats200Response, Integer, Hash)>] PostApiExtractSeats200Response data, response status code and response headers
     def post_api_extract_seats_with_http_info(post_api_extract_seats_request, opts = {})
       if @api_client.config.debugging
         @api_client.config.logger.debug 'Calling API: MapDesignerApi.post_api_extract_seats ...'
@@ -96,6 +96,8 @@ module SeatsChart
 
       # 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']
       # HTTP header 'Content-Type'
       content_type = @api_client.select_header_content_type(['application/json', 'multipart/form-data', 'text/plain'])
       if !content_type.nil?
@@ -110,7 +112,7 @@ module SeatsChart
       post_body = opts[:debug_body] || @api_client.object_to_http_body(post_api_extract_seats_request)
 
       # return_type
-      return_type = opts[:debug_return_type]
+      return_type = opts[:debug_return_type] || 'PostApiExtractSeats200Response'
 
       # auth_names
       auth_names = opts[:debug_auth_names] || ['ApiKeyAuth', 'BearerAuth']