-
Notifications
You must be signed in to change notification settings - Fork 9
#445: Relaxed api to not throw 404 when element was not found on PUT #454
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.
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
#445: Relaxed api to not throw 404 when element was not found on PUT #454
Conversation
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
as discussed today in TF please also update explanations/descriptions of the interface operations themselves. Thank you!
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
see my comments
…tifiable services
@@ -44,7 +44,7 @@ paths: | |||
put: | |||
tags: | |||
- Asset Administration Shell API | |||
summary: Creates or updates an existing Asset Administration Shell | |||
summary: Updates an existing Asset Administration Shell |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here 201 return code missing?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Yes, that is intentionally - for all "Service" interfaces (the one targetting a single identifiable, I removed the update again. These services offer no POST - so I thought it makes no sense to introduce a create via the backdoor.
I understand the services interfaces as interfaces for single objects - they do not offer the option to create new objects (an IOT device offers data via aas interface - but doesn't allow "huckepack" objects). If so, it would offer a repository interface...
Entire-API-Collection/V3.1.yaml
Outdated
@@ -1632,6 +1645,8 @@ paths: | |||
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.1.0#/components/schemas/Submodel' | |||
required: true | |||
responses: | |||
'201': | |||
description: Submodel created successfully |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Here without ?
description: Concept Description created successfully
headers:
Location:
description: URL of the newly created resource
schema:
type: string
content:
application/json:
schema:
$ref: 'https://api.swaggerhub.com/domains/Plattform_i40/Part1-MetaModel-Schemas/V3.1.0#/components/schemas/ConceptDescription'
Entire-API-Collection/V3.1.yaml
Outdated
@@ -3312,7 +3349,7 @@ paths: | |||
put: | |||
tags: | |||
- Asset Administration Shell Repository API | |||
summary: Creates or updates the Submodel | |||
summary: Updates the Submodel |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
why only update and not create or update?
documentation/IDTA-01002-3/modules/ROOT/pages/specification/interfaces.adoc
Outdated
Show resolved
Hide resolved
@@ -71,7 +71,7 @@ e|payload a|Requested Asset Administration Shell |yes | link:https://admin-shell | |||
[width=100%,cols="25%,35%,10%,20%,10%"] | |||
|=== | |||
h|*Operation Name* 4+e|[[PutAssetAdministrationShell]]PutAssetAdministrationShell | |||
hh|Explanation 4+a|Replaces the Asset Administration Shell | |||
h|Explanation 4+a|Replaces the Asset Administration Shell or create it if it does not exist |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
h|Explanation 4+a|Replaces the Asset Administration Shell or create it if it does not exist | |
h|Explanation 4+a|Replaces the Asset Administration Shell or creates it if it does not exist |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
see my comments
b99a121
into
admin-shell-io:IDTA-01002-3-1_preparation
No description provided.