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.

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

doc(tutorials): publish the e2e adopter journey tutorial #472

Merged
merged 66 commits into from
Nov 28, 2023

Conversation

stephanbcbauer
Copy link
Member

@stephanbcbauer stephanbcbauer commented Nov 7, 2023

Description

This PR is the final step to merge the feature branch to main and publish the e2e adopter journey tutorial.

note: Please be aware, the links reference to a private fork which currently displays the changes of this PR.

Pre-review checks

Please ensure to do as many of the following checks as possible, before asking for committer review:

stephanbcbauer and others added 24 commits October 25, 2023 19:26
feat(tutorials): Initial commit to provide the tutorials structure on feature branch
Run Markdown linter and solve issues
delete unused folder/files
feat(tutorials): Provide initial content and structure
chore(update): Keep feature branch up to date related to main
add CHANGELOG.md
delete unused section
restructure content
Adapt initial structure and content
Added generic tutorial description
(doc): Completed onboarding information material for e2e tutorial
Delete unused files/folders
add NOTICE section
add Admonitions
doc(tutorials): Keep feature branch up to date
@stephanbcbauer stephanbcbauer added documentation Improvements or additions to documentation enhancement New feature or request labels Nov 7, 2023
@stephanbcbauer stephanbcbauer self-assigned this Nov 7, 2023
add new diagram in draw.io
extend the different section of the architecture view
fix some linter issues
doc(tutorials): adapt architecture view
@arnoweiss
Copy link
Contributor

arnoweiss commented Nov 27, 2023

What's the tractusx-edc version used here? Some payloads look weird like

{
    "querySpec": {
        "offset": 0,
        "limit": 100,
        "filter": "",
        "range": {
            "from": 0,
            "to": 100
        },
        "criterion": ""
    }
}

that looks way different than the openAPI definition.

@stephanbcbauer
Copy link
Member Author

What's the tractusx-edc version used here? Some payloads look weird like

{
    "querySpec": {
        "offset": 0,
        "limit": 100,
        "filter": "",
        "range": {
            "from": 0,
            "to": 100
        },
        "criterion": ""
    }
}

that looks way different than the openAPI definition.

Its 0.5.1 the one which is also mentioned in the related standards

@arnoweiss
Copy link
Contributor

What is filter supposed to mean?
What is criterion supposed to mean?
What is range supposed to mean?

None of these properties for a QuerySpec are mentioned in the openAPI spec for tractusx-edc 0.5.1.

@stephanbcbauer
Copy link
Member Author

What is filter supposed to mean? What is criterion supposed to mean? What is range supposed to mean?

None of these properties for a QuerySpec are mentioned in the openAPI spec for tractusx-edc 0.5.1.

@jkbquabeck , @MoritzDieckmann

@jkbquabeck
Copy link
Contributor

I am not sure who worked on this. Maybe @alexandrudanciu @hemantxpatel or @paullatzelsperger know the answer here.

@hemantxpatel
Copy link

Hi, the correct spec will be:

{
    "querySpec": {
        "offset": 0,
        "limit": 100
    }
}

I have referred the existing querySpec from some postman collections. Strangely it doesn't fail or warn, that's why it got skipped.
There are couple of usages in mxd as well. Will raise an issue and fix it.

@arnoweiss
Copy link
Contributor

Hi, the correct spec will be:

{
    "querySpec": {
        "offset": 0,
        "limit": 100
    }
}

I have referred the existing querySpec from some postman collections. Strangely it doesn't fail or warn, that's why it got skipped. There are couple of usages in mxd as well. Will raise an issue and fix it.

@hemantxpatel - Link the ticket here when it's created, please. I've observed the querySpec mechanism behaving strange in a couple of similar situations.

@stephanbcbauer - can you update the relevant parts in the tutorial? Ctl-F "querySpec" should show you all relevant occurences of the error above and I don't have push rights for this repo.

@hemantxpatel
Copy link

I raised issue here. eclipse-tractusx/tutorial-resources#166

I've observed the querySpec mechanism behaving strange in a couple of similar situations.

@arnoweiss Since these fields are unknown, they might get silently ignored during Json Serialization and should not affect any functionalities.

@arnoweiss
Copy link
Contributor

Misunderstanding - sorry. I thought you'd open an issue about the EDC's behavior. I'll collect some more examples and then do it myself. Thanks for taking care of this and letting Stephan off my hook.

@stephanbcbauer
Copy link
Member Author

Misunderstanding - sorry. I thought you'd open an issue about the EDC's behavior. I'll collect some more examples and then do it myself. Thanks for taking care of this and letting Stephan off my hook.

To not confuse others, I will adapt the sections before we release the tutorial.

@stephanbcbauer stephanbcbauer marked this pull request as ready for review November 28, 2023 13:27
@stephanbcbauer stephanbcbauer merged commit 0d16a0e into main Nov 28, 2023
2 checks passed
@stephanbcbauer stephanbcbauer deleted the feat/tutorials branch November 28, 2023 16:42
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

8 participants