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

feat:Added summary for the open api paths #175

Merged
merged 3 commits into from
Oct 20, 2023
Merged

feat:Added summary for the open api paths #175

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
c0454f7
added summary in the open api
shijinrajbosch Oct 2, 2023
2658032
updated CHANGELOG.md
shijinrajbosch Oct 11, 2023
3de81c1
Merge branch 'main' of https://github.com/eclipse-tractusx/sldt-seman…
shijinrajbosch Oct 20, 2023
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
1 change: 1 addition & 0 deletions CHANGELOG.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0

## 0.2.12
### Added
- Added summary for the open api paths

### Fixed
- Fixed CVE-2022-44729| CWE-918 Third-Party Components vulnerability.
Expand Down
12 changes: 12 additions & 0 deletions backend/src/main/resources/static/semantic-hub-openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -36,6 +36,7 @@ paths:
get:
tags:
- SemanticHub
summary: Returns all the Semantic Models based on the Namespace and SemanticModelStatus
operationId: getModelList
parameters:
- in: query
Expand Down Expand Up @@ -78,6 +79,7 @@ paths:
post:
tags:
- SemanticHub
summary: Creates a new Semantic Model with the respective SemanticModelStatus for the respective SemanticModelType
operationId: createModelWithUrn
parameters:
- in: query
Expand Down Expand Up @@ -110,6 +112,7 @@ paths:
put:
tags:
- SemanticHub
summary: Updates an existing Semantic Model with the respective SemanticModelStatus for the respective SemanticModelType
operationId: modifyModel
parameters:
- in: query
Expand Down Expand Up @@ -144,6 +147,7 @@ paths:
post:
tags:
- SemanticHub
summary: Returns all the Semantic Models based on the URN list
operationId: getModelListByUrns
description: This endpoint allows to filter for a specific set of URNs. The endpoint returns the metadata, such as the model status. For URNs that are not in the database there is no entry in the result set. Therefore, a search array with 10 URNs can result in a response containing 9 or less result entries.
parameters:
Expand Down Expand Up @@ -189,6 +193,7 @@ paths:
get:
tags:
- SemanticHub
summary: Returns a Semantic Model based on the URN
operationId: getModelByUrn
parameters:
- in: path
Expand Down Expand Up @@ -232,6 +237,7 @@ paths:
get:
tags:
- SemanticHub
summary: Returns a Semantic Model file based on the URN
operationId: getModelFile
parameters:
- in: path
Expand All @@ -254,6 +260,7 @@ paths:
get:
tags:
- SemanticHub
summary: Returns a Semantic Model diagram based on the URN
operationId: getModelDiagram
parameters:
- in: path
Expand All @@ -276,6 +283,7 @@ paths:
get:
tags:
- SemanticHub
summary: Returns a Semantic Model HTML documentation based on the URN
operationId: getModelDocu
parameters:
- in: path
Expand All @@ -298,6 +306,7 @@ paths:
get:
tags:
- SemanticHub
summary: Returns a Semantic Model JSON schema based on the URN
operationId: getModelJsonSchema
parameters:
- in: path
Expand All @@ -320,6 +329,7 @@ paths:
get:
tags:
- SemanticHub
summary: Returns a Semantic Model Open API definition JSON based on the URN
operationId: getModelOpenApi
parameters:
- in: path
Expand Down Expand Up @@ -347,6 +357,7 @@ paths:
get:
tags:
- SemanticHub
summary: Returns a Semantic Model example payload JSON based on the URN
operationId: getModelExamplePayloadJson
parameters:
- in: path
Expand All @@ -369,6 +380,7 @@ paths:
get:
tags:
- SemanticHub
summary: Returns a Semantic Model AAS sub-model template based on the URN and AasFormat
operationId: getAasSubmodelTemplate
parameters:
- in: path
Expand Down
Loading