OpenAPI: for plot y and z are potentially nullable

This commit is contained in:
2025-12-08 10:11:42 +01:00
parent 7e93569a74
commit 916e8349ab
8 changed files with 19 additions and 17 deletions

View File

@@ -522,7 +522,7 @@ private:
/// </remarks>
/// <param name="type">Type of requested plot</param>
/// <param name="azintUnit">Unit used for azim int. (optional, default to &quot;Q_recipA&quot;)</param>
/// <param name="binning">Binning of frames for the plot (0 &#x3D; default binning) (optional, default to 0)</param>
/// <param name="binning">Binning of frames for the plot (0 &#x3D; default binning) (optional, default to 1)</param>
virtual void preview_plot_bin_get(const std::optional<std::string> &type, const std::optional<std::string> &azintUnit, const std::optional<int32_t> &binning, Pistache::Http::ResponseWriter &response) = 0;
/// <summary>
/// Generate 1D plot from Jungfraujoch
@@ -531,7 +531,7 @@ private:
///
/// </remarks>
/// <param name="type">Type of requested plot</param>
/// <param name="binning">Binning of frames for the plot (0 &#x3D; default binning) (optional, default to 0)</param>
/// <param name="binning">Binning of frames for the plot (0 &#x3D; default binning) (optional, default to 1)</param>
/// <param name="compression">Enable DEFLATE compression of output data. (optional, default to false)</param>
/// <param name="fill">Fill value for elements that were missed during data collection (optional, default to 0.0f)</param>
/// <param name="experimentalCoord">If measurement has goniometer axis defined, plot X-axis will represent rotation angle If measurement has grid scan defined, plot X-axis and Y-axis will represent grid position, Z will be used as the final value For still measurement the number is ignored (optional, default to false)</param>

View File

@@ -1331,11 +1331,13 @@ components:
items:
type: number
format: float
nullable: true
z:
type: array
items:
type: number
format: float
nullable: true
plot_unit_x:
type: string
enum:

File diff suppressed because one or more lines are too long

View File

@@ -3165,7 +3165,7 @@ with jfjoch_client.ApiClient(configuration) as api_client:
api_instance = jfjoch_client.DefaultApi(api_client)
type = 'type_example' # str | Type of requested plot
azint_unit = Q_recipA # str | Unit used for azim int. (optional) (default to Q_recipA)
binning = 56 # int | Binning of frames for the plot (0 = default binning) (optional)
binning = 1 # int | Binning of frames for the plot (0 = default binning) (optional) (default to 1)
try:
# Generate 1D plot from Jungfraujoch and send in raw binary format. Data are provided as (32-bit) float binary array. This format doesn't transmit information about X-axis, only values, so it is of limited use for azimuthal integration.
@@ -3185,7 +3185,7 @@ Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**type** | **str**| Type of requested plot |
**azint_unit** | **str**| Unit used for azim int. | [optional] [default to Q_recipA]
**binning** | **int**| Binning of frames for the plot (0 &#x3D; default binning) | [optional]
**binning** | **int**| Binning of frames for the plot (0 &#x3D; default binning) | [optional] [default to 1]
### Return type
@@ -3235,7 +3235,7 @@ with jfjoch_client.ApiClient(configuration) as api_client:
# Create an instance of the API class
api_instance = jfjoch_client.DefaultApi(api_client)
type = 'type_example' # str | Type of requested plot
binning = 56 # int | Binning of frames for the plot (0 = default binning) (optional)
binning = 1 # int | Binning of frames for the plot (0 = default binning) (optional) (default to 1)
compression = False # bool | Enable DEFLATE compression of output data. (optional) (default to False)
fill = 3.4 # float | Fill value for elements that were missed during data collection (optional)
experimental_coord = False # bool | If measurement has goniometer axis defined, plot X-axis will represent rotation angle If measurement has grid scan defined, plot X-axis and Y-axis will represent grid position, Z will be used as the final value For still measurement the number is ignored (optional) (default to False)
@@ -3258,7 +3258,7 @@ with jfjoch_client.ApiClient(configuration) as api_client:
Name | Type | Description | Notes
------------- | ------------- | ------------- | -------------
**type** | **str**| Type of requested plot |
**binning** | **int**| Binning of frames for the plot (0 &#x3D; default binning) | [optional]
**binning** | **int**| Binning of frames for the plot (0 &#x3D; default binning) | [optional] [default to 1]
**compression** | **bool**| Enable DEFLATE compression of output data. | [optional] [default to False]
**fill** | **float**| Fill value for elements that were missed during data collection | [optional]
**experimental_coord** | **bool**| If measurement has goniometer axis defined, plot X-axis will represent rotation angle If measurement has grid scan defined, plot X-axis and Y-axis will represent grid position, Z will be used as the final value For still measurement the number is ignored | [optional] [default to False]

View File

@@ -8,8 +8,8 @@ Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**title** | **str** | | [default to '']
**x** | **List[float]** | |
**y** | **List[float]** | |
**z** | **List[float]** | | [optional]
**y** | **List[Optional[float]]** | |
**z** | **List[Optional[float]]** | | [optional]
## Example

View File

@@ -17,8 +17,8 @@ type MyState = {
type PlotlyPlot = {
x: number[],
y: number[],
z?: number[],
y: (number | null)[],
z?: (number | null)[],
type: string,
mode?: string,
name?: string,

View File

@@ -9,7 +9,7 @@
export type plot = {
title: string;
'x': Array<number>;
'y': Array<number>;
'z'?: Array<number>;
'y': Array<number | null>;
'z'?: Array<number | null>;
};

View File

@@ -992,7 +992,7 @@ export class DefaultService {
*/
public static getPreviewPlot(
type: 'bkg_estimate' | 'azint' | 'azint_1d' | 'spot_count' | 'spot_count_low_res' | 'spot_count_indexed' | 'spot_count_ice' | 'indexing_rate' | 'indexing_time' | 'indexing_unit_cell_length' | 'indexing_unit_cell_angle' | 'profile_radius' | 'b_factor' | 'error_pixels' | 'saturated_pixels' | 'image_collection_efficiency' | 'receiver_delay' | 'receiver_free_send_buf' | 'strong_pixels' | 'roi_sum' | 'roi_mean' | 'roi_max_count' | 'roi_pixels' | 'roi_weighted_x' | 'roi_weighted_y' | 'packets_received' | 'max_pixel_value' | 'resolution_estimate' | 'pixel_sum' | 'processing_time' | 'beam_center_x' | 'beam_center_y',
binning?: number,
binning: number = 1,
compression: boolean = false,
fill?: number,
experimentalCoord: boolean = false,
@@ -1030,7 +1030,7 @@ export class DefaultService {
public static getPreviewPlotBin(
type: 'bkg_estimate' | 'azint' | 'azint_1d' | 'spot_count' | 'spot_count_low_res' | 'spot_count_indexed' | 'spot_count_ice' | 'indexing_rate' | 'indexing_time' | 'indexing_unit_cell_length' | 'indexing_unit_cell_angle' | 'profile_radius' | 'b_factor' | 'error_pixels' | 'saturated_pixels' | 'image_collection_efficiency' | 'receiver_delay' | 'receiver_free_send_buf' | 'strong_pixels' | 'roi_sum' | 'roi_mean' | 'roi_max_count' | 'roi_pixels' | 'roi_weighted_x' | 'roi_weighted_y' | 'packets_received' | 'max_pixel_value' | 'resolution_estimate' | 'pixel_sum' | 'processing_time' | 'beam_center_x' | 'beam_center_y',
azintUnit: 'Q_recipA' | 'd_A' | 'two_theta_deg' = 'Q_recipA',
binning?: number,
binning: number = 1,
): CancelablePromise<Blob> {
return __request(OpenAPI, {
method: 'GET',