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

Compatibility #2

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

Compatibility #2

wants to merge 1 commit into from

Conversation

rskaar
Copy link
Member

@rskaar rskaar commented Nov 10, 2017

Endringer i «Compatibility»-kapittelet

@rskaar
Copy link
Member Author

rskaar commented Nov 10, 2017

Foreslår å akseptere det som står her.
Har endret mening om header vs URI versjonering. Jeg har argumentert med at det er letter å teste/trykke på lenker med versjon i URL fremfor en skjult header, men stort sett trenger man en access_token for å snakke med APIene, og da må man til med f.eks Postman for å teste uansett.

https://github.com/Turistforeningen/restful-api-guidelines/blob/dd6c9414945049f3eed986f1d992e9e4e5a10926/chapters/compatibility.adoc

@rskaar rskaar changed the title chore(compatibility): update example header names Compatibility Nov 10, 2017
@rskaar rskaar requested a review from geekus November 10, 2017 06:10
@rskaar rskaar self-assigned this Nov 10, 2017
geekus
geekus approved these changes Nov 10, 2017
View reviewed changes
chapters/compatibility.adoc
@@ -230,7 +229,7 @@ release management.

Media type versioning: Here, version information and media type are
provided together via the HTTP Content-Type header — e.g.
application/x.zalando.cart+json;version=2. For incompatible changes, a
application/x.dnt.sherpa+json;version=4. For incompatible changes, a
Copy link

Choose a reason for hiding this comment

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

Skal tro om cart også er med på å påvirke output, og at de bruker ulike verdier der, avhengig av hvordan de vil JSON skal struktureres f.eks? Kanskje ikke relevant å tilby flere varianter i Sherpa, men f.eks. i Turbasen kunne man jo gi tilpasset output til UT for requests med header Accept: application/x.turbasen.ut+json.

Copy link
Member Author

Choose a reason for hiding this comment

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

hm, godt poeng. Jeg så for meg at "cart" her var en av appene i zalando-plattformen.

Copy link
Member Author

Choose a reason for hiding this comment

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

altså at denne output'en kom fra APIet til "cart", ikke at formatet var for klienten "cart"

Copy link
Member Author

Choose a reason for hiding this comment

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

Å støtte flere ulike outputstrukturer høres slitsomt ut ved fremtidige endringer.

Copy link

Choose a reason for hiding this comment

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

Ah, ja, at det er en app ja. Vil tro du har rett! 👍

@geekus
Copy link

geekus commented Nov 10, 2017

Støtter versjonering med headers. 👍

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@geekus geekus geekus approved these changes

Assignees

@rskaar rskaar

@geekus geekus

Labels
None yet
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
2 participants
@rskaar @geekus