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

Jump to bottom

AAS 3.0.0 is implemented in IRS API Swagger docu #209

Closed
1 task
jzbmw opened this issue Oct 23, 2023 · 7 comments
Closed
1 task

AAS 3.0.0 is implemented in IRS API Swagger docu #209

jzbmw opened this issue Oct 23, 2023 · 7 comments
Assignees
@dsmf @jzbmw
Labels
hardening measurements to increase resiliency linked_to_feature Issue is linked to a feature

Comments

@jzbmw
Copy link
Contributor

jzbmw commented Oct 23, 2023 •
edited by mkanal
Loading

As PO
I want api updated to currrent aas version 3.0.0,
so that that the API reflects always the current state.

Hints / Details

Outcome / Acceptance Criteria

  • Swagger documentation examples were updated. In consultation with @ds-jhartmann we decided to compare with the data from DEV because the examples in the above-mentioned docs are incomplete. There are some attributes that we do not have on the IRS side but as we don't need them we decided not to add them (would have involved adding quite a few new classes under irs-models\src\main\java\org\eclipse\tractusx\irs\component\assetadministrationshell which is beyond the scope of the acceptance criteria, escpecially as we don't need these new attributes...).

Outcome

  • ...

Acceptance Criteria

  • IRS API Swagger docu is aligned with aas 3.0.0 (Responses and Samples)

Out of Scope

  • ...
@jzbmw jzbmw added this to IRS Oct 23, 2023
@jzbmw jzbmw converted this from a draft issue Oct 23, 2023
@jzbmw jzbmw added the hardening measurements to increase resiliency label Oct 23, 2023
@jzbmw jzbmw moved this from inbox to backlog in IRS Oct 23, 2023
@jzbmw jzbmw mentioned this issue Oct 26, 2023
Open
@jzbmw jzbmw moved this from backlog to next in IRS Oct 31, 2023
@ds-ext-kmassalski
Copy link
Contributor

@dsmf dsmf moved this from next to wip in IRS Nov 8, 2023
@dsmf dsmf self-assigned this Nov 8, 2023
@dsmf
Copy link
Contributor

dsmf commented Nov 9, 2023

https://github.com/eclipse-tractusx/sldt-digital-twin-registry/blob/87c51d73f04445ea67c38148305e5eb41f644576/docs/README.md

@ds-jhartmann ds-jhartmann moved this from wip to review in IRS Nov 15, 2023
@dsmf
Copy link
Contributor

dsmf commented Nov 15, 2023 •
edited by mkanal
Loading

Outcome: s.a.

@dsmf dsmf added the PO Review label Nov 15, 2023
ds-jhartmann pushed a commit that referenced this issue Nov 15, 2023
@dsmf
feat(irs):[#209] Update IRS API Swagger documentation to match AAS 3.0.0
b9da83f
ds-jhartmann pushed a commit that referenced this issue Nov 15, 2023
@dsmf
feat(irs):[#209] Update IRS API Swagger documentation to match AAS 3.…
ca7407a 
…0.0 - formatting
ds-jhartmann pushed a commit that referenced this issue Nov 15, 2023
@dsmf
feat(irs):[#209] Update IRS API Swagger documentation to match AAS 3.…
e0219f6 
…0.0 - fix test
ds-jhartmann pushed a commit that referenced this issue Nov 15, 2023
@dsmf
Merge branch 'main' into feature/#209-aas-3.0.0-is-implemented-in-irs…
8ae71ba 
…-api-swagger-docu

# Conflicts:
#	CHANGELOG.md
ds-jhartmann pushed a commit that referenced this issue Nov 15, 2023
@dsmf
Merge pull request #639 from catenax-ng/feature/#209-aas-3.0.0-is-imp…
28b1dac 
…lemented-in-irs-api-swagger-docu

feat(irs):[#209] Update IRS API Swagger documentation to match AAS 3.0.0
@mkanal
Copy link
Contributor

mkanal commented Nov 16, 2023 •
edited
Loading

Hello @dsmf and @ds-jhartmann
I have checked https://irs.int.demo.catena-x.net/api/swagger-ui/index.html?configUrl=/api/api-docs/swagger-config#/Item%20Relationship%20Service/getJobForJobId and it differs from the one here https://raw.githubusercontent.com/eclipse-tractusx/sldt-digital-twin-registry/87c51d73f04445ea67c38148305e5eb41f644576/docs/README.md
I need some instructions how to get evidence on this. Where is the change deployed, what was changed exactly ? What not.
I will remove the Label PO Review - please add it again when evidence is given. Thank you very much.

@mkanal mkanal removed the PO Review label Nov 16, 2023
@ds-jhartmann
Copy link
Contributor

Hi @mkanal,
as described in the outcome, we do not use all of the values the registry provides inside the IRS. This is why certain parts from the specification are missing. Given the task of this story being the update of the swagger examples and the size XS, adding these unused fields to the IRS is out of scope.
Every field which is present in the IRS should be the same as the registry specifies. If you noticed something missing, please point that out.

@mkanal
Copy link
Contributor

mkanal commented Nov 21, 2023

@dsmf please create a new pbis story. Link this story to this one. Add label PO Review and assign story to @jzbmw.

  1. JobResponse provides complete aas (as we receive from dDTR) in shell array

@dsmf dsmf mentioned this issue Nov 22, 2023
Open
@dsmf
Copy link
Contributor

dsmf commented Nov 22, 2023

new story created #304

@dsmf dsmf added the PO Review label Nov 22, 2023
@dsmf dsmf assigned jzbmw and unassigned dsmf Nov 22, 2023
@jzbmw jzbmw moved this from review to done in IRS Nov 23, 2023
@jzbmw jzbmw closed this as completed Nov 23, 2023
ds-jhartmann added a commit that referenced this issue Dec 8, 2023
@ds-jhartmann
docs(ess):[#209] Improve ESS admin manual documentation
75361b6
ds-jhartmann added a commit that referenced this issue Dec 8, 2023
@ds-jhartmann
docs(installation):[#209] Fix broken links
8ee60f7
ds-jhartmann added a commit that referenced this issue Dec 8, 2023
@ds-jhartmann
docs(arc42):[#209] Fix formatting for documentation license
87b0e4d
ds-jhartmann added a commit that referenced this issue Dec 8, 2023
@ds-jhartmann
docs(arc42):[#209] Fix formatting for documentation license
94f8b41
ds-jhartmann added a commit that referenced this issue Dec 8, 2023
@ds-jhartmann
docs(arc42):[#209] Add additional documentation for ESS
286fc3f
ds-jhartmann added a commit that referenced this issue Dec 8, 2023
@ds-jhartmann
docs(arc42):[#209] Add missing ESS parts to building block and runtim…
199f8ba 
…e view
ds-jhartmann added a commit that referenced this issue Dec 8, 2023
@ds-jhartmann
docs(arc42):[#209] Minor grammar fix
2b0d2d1
ds-jhartmann added a commit that referenced this issue Dec 8, 2023
@ds-jhartmann
docs(arc42):[#209] Fix puml includes
316cf80
ds-jhartmann added a commit that referenced this issue Dec 8, 2023
@ds-jhartmann
docs(arc42):[#209] Update ESS description
3085fb9
ds-jhartmann added a commit that referenced this issue Dec 8, 2023
@ds-jhartmann @mkanal
docs(arc42):[#209] Update deployment view level 0
07902d3 
Co-authored-by: ds-mkanal <[email protected]>
@mkanal mkanal added the linked_to_feature Issue is linked to a feature label Jan 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Assignees

@dsmf dsmf

@jzbmw jzbmw

Labels
hardening measurements to increase resiliency linked_to_feature Issue is linked to a feature
Projects
IRS
Status: done
Milestone
No milestone
Development

No branches or pull requests
5 participants
@dsmf @jzbmw @ds-jhartmann @mkanal @ds-ext-kmassalski