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

initial version of chapter 5 #14

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

sippsack
Copy link
Contributor

No description provided.

@sippsack sippsack requested review from dret and thfro November 20, 2024 23:26
@sippsack sippsack self-assigned this Nov 20, 2024
@sippsack sippsack linked an issue Nov 20, 2024 that may be closed by this pull request
Copy link
Contributor

Build Successful! You can find a link to the downloadable artifacts below.

Name Link
Commit 4fecc02
Logs https://github.com/isaqb-org/curriculum-api/actions/runs/11943527967
Download https://github.com/isaqb-org/curriculum-api/suites/31142662709/artifacts/2216034351

@sippsack sippsack changed the title #10 initial version of chapter 5 initial version of chapter 5 Nov 21, 2024
* 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.
Copy link
Contributor

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?

Copy link

@thfro thfro Nov 22, 2024

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.

Copy link
Contributor

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.

Copy link
Contributor

@dret dret left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Some minor comments.


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.
Copy link

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Codegenerierung oder Code-Generierung?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Ich wäre für ohne Bindestrich.

Copy link

@thfro thfro left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Bitte Kommentare berücksichtigen, ansonsten approved.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

chapter 5 initial version
3 participants