Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Extend openapi definition ms iv #37

Closed
wants to merge 2 commits into from
Closed

Extend openapi definition ms iv #37

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
a9d62a7
Extended openapi: extractor, schema, health
Nov 21, 2024
967eef6
add get for dataset
Nov 21, 2024
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
179 changes: 178 additions & 1 deletion api/openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,6 +12,10 @@ tags:
description: Operations related to datasets
- name: transfer
description: Operations related to data transfers
- name: extractor
description: Operations related to metadata extraction
- name: schema
description: Operations related to schemas
- name: other
description: Further operations for general information

Expand All @@ -22,6 +26,25 @@ tags:

paths:
/dataset:
get:
tags:
- dataset
summary: Get the available datasets.
description: Retrieve the folder structure of the available datasets.
operationId: DatasetController_getDataset
responses:
"200":
description: Dataset successfully retrieved.
content:
application/json:
schema:
$ref: "#/components/schemas/IngestorUiGetDatasetResponse"
"400":
description: Invalid request
content:
text/plain:
schema:
type: string
post:
tags:
- dataset
Expand Down Expand Up @@ -111,6 +134,26 @@ paths:
schema:
type: string

/health:
get:
tags:
- other
summary: Get the health status.
description: Retrieve information about the status of openEm components.
operationId: OtherController_getHealth
responses:
"200":
description: Health status retrieved successfully
content:
application/json:
schema:
$ref: "#/components/schemas/IngestorUiOtherHealthResponse"
"400":
description: Invalid request
content:
text/plain:
schema:
type: string
/version:
get:
tags:
Expand All @@ -125,7 +168,83 @@ paths:
application/json:
schema:
$ref: "#/components/schemas/IngestorUiOtherVersionResponse"

"400":
description: Invalid request
content:
text/plain:
schema:
type: string
/extractor:
get:
tags:
- extractor
summary: Get available extractors
description: 'Retrieve the available extractors configured in the ingestor.'
operationId: ExtractorController_getExtractors
responses:
'200':
description: Avilable extractors retrieved sucessfully
content:
application/json:
schema:
$ref: "#/components/schemas/IngestorUiOtherVersionResponse"
"400":
description: Invalid request
content:
text/plain:
schema:
type: string
post:
tags:
- extractor
summary: Start a new metadata extraction
description: Start a new metadata extraction on the specified data set with the selected method.
operationId: ExtractorController_startExtraction
requestBody:
required: true
content:
application/json:
schema:
$ref: "#/components/schemas/IngestorUiPostExtractionRequest"
responses:
"200":
description: Dataset ingestion successful
content:
application/json:
schema:
$ref: "#/components/schemas/IngestorUiPostDatasetResponse"
"400":
description: Invalid request
content:
text/plain:
schema:
type: string
/schema:
get:
tags:
- schema
summary: Get schema for selected method
description: 'Retrieve the right schema for the selected extractor.'
operationId: SchemaController_getSchema
parameters:
- name: methodName
in: query
required: true
schema:
type: string
responses:
'200':
description: Schema retrieved sucessfully
Copy link
Collaborator

@phwissmann phwissmann Jan 8, 2025 •
edited
Loading

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

typo ^^

content:
application/json:
schema:
$ref: "#/components/schemas/IngestorUiGetSchemaRequest"
"400":
description: Invalid request
content:
text/plain:
schema:
type: string
components:
schemas:
IngestorUiPostDatasetRequest:
Expand Down Expand Up @@ -181,3 +300,61 @@ components:
version:
type: string
description: Version of the ingestor.
IngestorUiOtherHealthResponse:
type: object
properties:
ingestorStatus:
type: string
description: Status of the ingestor.
scicatStatus:
type: string
description: Status of SciCat.
globusStatus:
type: string
description: Status of Globus.
IngestorUiGetExtractorItem:
type: object
properties:
methodName:
type: string
description: Available method names of the extractor configurered in the ingestor.
IngestorUiGetExtractorResponse:
type: object
properties:
extractors:
type: array
items:
$ref: "#/components/schemas/IngestorUiGetExtractorItem"
total:
type: integer
description: Total number of extractors.
IngestorUiPostExtractionRequest:
type: object
properties:
filePath:
type: string
description: The file path of the selected data record.
methodName:
type: string
description: The selected methodName for data extraction.
IngestorUiGetSchemaRequest:
type: object
properties:
schema:
type: string
description: Schema which belongs to an extractor method.
IngestorUiGetDatasetItem:
type: object
properties:
dataset:
type: string
IngestorUiGetDatasetResponse:
type: object
properties:
datasets:
type: array
items:
$ref: "#/components/schemas/IngestorUiGetDatasetItem"
total:
type: integer
description: Total number of datasets.
Loading