generated from isaqb-org/advanced-template
-
Notifications
You must be signed in to change notification settings - Fork 0
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
initial version of chapter 5 #14
Open
sippsack
wants to merge
1
commit into
main
Choose a base branch
from
10-chapter-5-initial-version
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,21 +1,34 @@ | ||
=== {learning-goals} | ||
|
||
|
||
// tag::DE[] | ||
[[LZ-5-1]] | ||
==== LZ 5-1: Dies ist das erste Lernziel in Kapitel 5, lorem ipsum sit dolor | ||
|
||
Hier wird beschrieben, was Teilnehmer:innen in diesem Lernziel lernen sollen. Das kann in Prosa-Text | ||
in ganzen Sätzen oder in Aufzählungen mit Unterpunkten erfolgen. Dabei kann auch unterschieden werden, | ||
wie wichtig einzelne Aspekte des Lernziels sind. Es kann hier bereits auf Literatur verwiesen werden. | ||
==== LZ 5-1: Wichtigkeit von API Beschreibungen kennen | ||
|
||
* Erstes Teilziel | ||
* Zweites Unterthema | ||
* Dritter Aspekt | ||
Teilnehmer:innen verstehen den Nutzen von API-Beschreibungen und kennen die Zielgruppen. Das Problem des "API Drift" ist bekannt. Sie können das Zusammenspiel von Design, Implementierung, Versionierung, Beschreibung, Versionierung der Beschreibung einordnen und wie diese Dinge im Idealfall sowie in der Realität praktiziert werden. | ||
|
||
[[LZ-5-2]] | ||
==== LZ 5-2: Hier ist ein zweites Lernziel in diesem Kapitel | ||
tbd. | ||
==== LZ 5-2: OpenAPI als Beschreibungssprache für HTTP APIs einordnen | ||
|
||
Teilnehmer:innen verstehen OpenAPI als eine auf HTTP APIs spezialisierte Beschreibungssprache. | ||
Sie kennen die Geschichte von OpenAPI und wie sich die verschiedenen Versionen entwickelt haben. | ||
Teilnehmer:innen wissen, wie sich OpenAPI zur Codegenerierung auf der Anbieter- oder Konsumentenseite verwenden lässt. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Codegenerierung oder Code-Generierung? There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. Ich wäre für ohne Bindestrich. |
||
Die generellen Strukturen von JSON und YAML sind bekannt. | ||
|
||
[[LZ-5-3]] | ||
==== LZ 5-3: Der Aufbau von OpenAPI verstehen | ||
|
||
Teilnehmer:innen verstehen die Hauptelemente einer OpenAPI Beschreibung und wie diese für konkrete APIs verwendet werden. | ||
|
||
* Resourcen (Paths) | ||
* Interaktionen | ||
* Repräsentationen | ||
* Mechanismen wie Tags, Security, Components und Webhooks | ||
|
||
[[LZ-5-4]] | ||
==== LZ 5-4: Alternative Beschreibungssprachen kennen | ||
|
||
OpenAPI ist spezialisiert auf HTTP APIs. Für andere API-Stile können alternative Beschreibungssprachen mit ähnlichen generellen Zielen verwendet werden. Teilnehmer:innen kennen diese alternativen Beschreibungssprachen und können sie API-Stilen zuordnen. | ||
|
||
// end::DE[] | ||
|
||
// tag::EN[] | ||
|
@@ -27,8 +40,3 @@ tbd. | |
==== LG 5-2: TBD | ||
tbd. | ||
// end::EN[] | ||
|
||
[NOTE] | ||
==== | ||
Die einzelnen Lernziele müssen nicht als einfache Aufzählungen mit Unterpunkten aufgeführt werden, sondern können auch gerne in ganzen Sätzen formuliert werden, welche die einzelnen Punkte (sofern möglich) integrieren. | ||
==== |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
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.
API-Beschreibung besser ohne Bindestrich?
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.
Gleiches Thema wie bei "API Design" vs "API-Design". Ich glaube, in "API-Beschreibung" muss ein Bindestrich hin, weil "Beschreibung" ein deutsches Wort ist. Und bei "API Drift" muss keiner hin, weil "Drift" ein englisches Wort ist. Aber 100% sicher bin ich mir nicht.
In jedem Fall sollte die Schreibweise aber in Überschrift und Textblock einheitlich sein.
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.
Mein Gefühl für Deutsch ist etwas angeschlagen, wahrscheinlich von englischer Grammatik. Ich finde die deutschen Bindestrich-Exzesse wenig hilfreich, aber der Duden mag da anderes denken.