mx/Jungfraujoch
2
1
Fork 0
Code Issues Pull Requests Actions 4 Packages Projects Releases 67 Wiki Activity

docs: drop generated pages for schemas the API no longer has

Browse Source 
Eight pages under docs/python_client/docs describe schemas that appear nowhere
in jfjoch_api.yaml and are linked from no index - left behind because the
regeneration step never cleared python-client/, which these are copied from.
That is fixed in update_version.sh; this removes what accumulated.

Co-Authored-By: Claude Opus 5 (1M context) <noreply@anthropic.com>
This commit is contained in:
leonarski_f
2026-07-30 11:30:25 +02:00
co-authored by Claude Opus 5
parent a95aca382c
commit ae2b11088d
8 changed files with 0 additions and 280 deletions
Download Patch File Download Diff File Expand all files Collapse all files
docs/python_client/docs/DatasetSettingsUnitCell.md
-35
View File
@@ -1,35 +0,0 @@
# DatasetSettingsUnitCell
Unit cell parameters. Necessary to run indexing. Units of angstrom and degree
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**a** | **float** | |
**b** | **float** | |
**c** | **float** | |
**alpha** | **float** | |
**beta** | **float** | |
**gamma** | **float** | |
## Example
```python
from jfjoch_client.models.dataset_settings_unit_cell import DatasetSettingsUnitCell
# TODO update the JSON string below
json = "{}"
# create an instance of DatasetSettingsUnitCell from a JSON string
dataset_settings_unit_cell_instance = DatasetSettingsUnitCell.from_json(json)
# print the JSON string representation of the object
print(DatasetSettingsUnitCell.to_json())
# convert the object into a dict
dataset_settings_unit_cell_dict = dataset_settings_unit_cell_instance.to_dict()
# create an instance of DatasetSettingsUnitCell from a dict
dataset_settings_unit_cell_from_dict = DatasetSettingsUnitCell.from_dict(dataset_settings_unit_cell_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/python_client/docs/DetectorListDetectorsInner.md
-36
View File
@@ -1,36 +0,0 @@
# DetectorListDetectorsInner
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**id** | **int** | |
**description** | **str** | |
**serial_number** | **str** | |
**base_ipv4_addr** | **str** | |
**udp_interface_count** | **int** | Number of UDP interfaces per detector module |
**nmodules** | **int** | |
**width** | **int** | |
**height** | **int** | |
## Example
```python
from jfjoch_client.models.detector_list_detectors_inner import DetectorListDetectorsInner
# TODO update the JSON string below
json = "{}"
# create an instance of DetectorListDetectorsInner from a JSON string
detector_list_detectors_inner_instance = DetectorListDetectorsInner.from_json(json)
# print the JSON string representation of the object
print(DetectorListDetectorsInner.to_json())
# convert the object into a dict
detector_list_detectors_inner_dict = detector_list_detectors_inner_instance.to_dict()
# create an instance of DetectorListDetectorsInner from a dict
detector_list_detectors_inner_from_dict = DetectorListDetectorsInner.from_dict(detector_list_detectors_inner_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/python_client/docs/GridPlot.md
-30
View File
@@ -1,30 +0,0 @@
# GridPlot
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**data** | **List[float]** | |
**width** | **int** | |
## Example
```python
from jfjoch_client.models.grid_plot import GridPlot
# TODO update the JSON string below
json = "{}"
# create an instance of GridPlot from a JSON string
grid_plot_instance = GridPlot.from_json(json)
# print the JSON string representation of the object
print(GridPlot.to_json())
# convert the object into a dict
grid_plot_dict = grid_plot_instance.to_dict()
# create an instance of GridPlot from a dict
grid_plot_from_dict = GridPlot.from_dict(grid_plot_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/python_client/docs/GridPlots.md
-30
View File
@@ -1,30 +0,0 @@
# GridPlots
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**plots** | [**List[GridPlot]**](GridPlot.md) | |
**width** | **int** | |
## Example
```python
from jfjoch_client.models.grid_plots import GridPlots
# TODO update the JSON string below
json = "{}"
# create an instance of GridPlots from a JSON string
grid_plots_instance = GridPlots.from_json(json)
# print the JSON string representation of the object
print(GridPlots.to_json())
# convert the object into a dict
grid_plots_dict = grid_plots_instance.to_dict()
# create an instance of GridPlots from a dict
grid_plots_from_dict = GridPlots.from_dict(grid_plots_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/python_client/docs/GridScanResult.md
-35
View File
@@ -1,35 +0,0 @@
# GridScanResult
Results of a grid scan
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**det_img** | **List[int]** | Detector image number for a given cell |
**bkg_estimate** | **List[float]** | |
**spot_count** | **List[int]** | |
**indexed_lattices** | **List[int]** | |
**mosaicity** | **List[float]** | |
**b_factor** | **List[float]** | |
## Example
```python
from jfjoch_client.models.grid_scan_result import GridScanResult
# TODO update the JSON string below
json = "{}"
# create an instance of GridScanResult from a JSON string
grid_scan_result_instance = GridScanResult.from_json(json)
# print the JSON string representation of the object
print(GridScanResult.to_json())
# convert the object into a dict
grid_scan_result_dict = grid_scan_result_instance.to_dict()
# create an instance of GridScanResult from a dict
grid_scan_result_from_dict = GridScanResult.from_dict(grid_scan_result_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/python_client/docs/JfjochSettingsSsl.md
-30
View File
@@ -1,30 +0,0 @@
# JfjochSettingsSsl
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**certificate** | **str** | |
**key** | **str** | |
## Example
```python
from jfjoch_client.models.jfjoch_settings_ssl import JfjochSettingsSsl
# TODO update the JSON string below
json = "{}"
# create an instance of JfjochSettingsSsl from a JSON string
jfjoch_settings_ssl_instance = JfjochSettingsSsl.from_json(json)
# print the JSON string representation of the object
print(JfjochSettingsSsl.to_json())
# convert the object into a dict
jfjoch_settings_ssl_dict = jfjoch_settings_ssl_instance.to_dict()
# create an instance of JfjochSettingsSsl from a dict
jfjoch_settings_ssl_from_dict = JfjochSettingsSsl.from_dict(jfjoch_settings_ssl_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/python_client/docs/PlotTypeEnum.md
-48
View File
@@ -1,48 +0,0 @@
# PlotTypeEnum
## Enum
* `BKG_ESTIMATE` (value: `'bkg_estimate'`)
* `AZINT` (value: `'azint'`)
* `SPOT_COUNT` (value: `'spot_count'`)
* `INDEXING_RATE` (value: `'indexing_rate'`)
* `INDEXING_UNIT_CELL_LENGTH` (value: `'indexing_unit_cell_length'`)
* `INDEXING_UNIT_CELL_ANGLE` (value: `'indexing_unit_cell_angle'`)
* `ERROR_PIXELS` (value: `'error_pixels'`)
* `IMAGE_COLLECTION_EFFICIENCY` (value: `'image_collection_efficiency'`)
* `RECEIVER_DELAY` (value: `'receiver_delay'`)
* `RECEIVER_FREE_SEND_BUF` (value: `'receiver_free_send_buf'`)
* `STRONG_PIXELS` (value: `'strong_pixels'`)
* `ROI_SUM` (value: `'roi_sum'`)
* `ROI_MEAN` (value: `'roi_mean'`)
* `ROI_MAX_COUNT` (value: `'roi_max_count'`)
* `ROI_PIXELS` (value: `'roi_pixels'`)
* `ROI_WEIGHTED_X` (value: `'roi_weighted_x'`)
* `ROI_WEIGHTED_Y` (value: `'roi_weighted_y'`)
* `PACKETS_RECEIVED` (value: `'packets_received'`)
* `MAX_PIXEL_VALUE` (value: `'max_pixel_value'`)
* `RESOLUTION_ESTIMATE` (value: `'resolution_estimate'`)
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)
docs/python_client/docs/PreviewSettings.md
-36
View File
@@ -1,36 +0,0 @@
# PreviewSettings
Settings for JPEG rendering of preview images
## Properties
Name | Type | Description | Notes
------------ | ------------- | ------------- | -------------
**saturation** | **int** | Saturation value to set contrast in the preview image |
**show_spots** | **bool** | Show spot finding results on the image | [optional] [default to True]
**show_roi** | **bool** | Show ROI areas on the image | [optional] [default to False]
**jpeg_quality** | **int** | Quality of JPEG image (100 - highest; 0 - lowest) | [optional] [default to 100]
**show_indexed** | **bool** | Preview indexed images only | [optional] [default to False]
**show_user_mask** | **bool** | Show user mask | [optional] [default to False]
**resolution_ring** | **float** | | [optional] [default to 0.1]
## Example
```python
from jfjoch_client.models.preview_settings import PreviewSettings
# TODO update the JSON string below
json = "{}"
# create an instance of PreviewSettings from a JSON string
preview_settings_instance = PreviewSettings.from_json(json)
# print the JSON string representation of the object
print(PreviewSettings.to_json())
# convert the object into a dict
preview_settings_dict = preview_settings_instance.to_dict()
# create an instance of PreviewSettings from a dict
preview_settings_from_dict = PreviewSettings.from_dict(preview_settings_dict)
```
[[Back to Model list]](../README.md#documentation-for-models) [[Back to API list]](../README.md#documentation-for-api-endpoints) [[Back to README]](../README.md)