Skip to content

feat(guidelines): clarify representation of multiple values for query parameters#102

Open
plemech23 wants to merge 1 commit intootto-de:mainfrom
plemech23:main
Open

feat(guidelines): clarify representation of multiple values for query parameters#102
plemech23 wants to merge 1 commit intootto-de:mainfrom
plemech23:main

Conversation

@plemech23
Copy link
Copy Markdown
Contributor

Changelog:

Update

  • Add OpenAPI example in "MUST support lists for multiple values of the same query parameter" R000062.

@plemech23
Copy link
Copy Markdown
Contributor Author

image

@kollegolin
Copy link
Copy Markdown
Contributor

kollegolin commented Apr 8, 2026

@plemech23 Wie es aussieht, kann ich mich in diesem Repo nicht selbst als Reviewer auswählen (und auch sonst keine Reviewer auswählen). Kannst du mich bitte hinzufügen oder muss das jemand anderes tun?

This comment was marked as outdated.

@otto-de otto-de deleted a comment from Copilot AI Apr 8, 2026
@otto-de otto-de deleted a comment from Copilot AI Apr 8, 2026
@BirgitBader
Copy link
Copy Markdown
Contributor

@plemech23 Are you planning to have this be reviewed & approved by another tech colleague from the community? (4-eyes principle)

@kollegolin
Copy link
Copy Markdown
Contributor

@plemech23 I looked at this PR several times and to be honest, I'm confused. To me, it looks like you not only added an example but also changed the wording of the actual guideline. Can you please clarify: Is there an actual change as to what the provider needs to do?

@plemech23
Copy link
Copy Markdown
Contributor Author

@plemech23 Are you planning to have this be reviewed & approved by another tech colleague from the community? (4-eyes principle)

Sure, @maxedenharter0507 @jensfischer1515 @kiriakos could one of you please review it?

@plemech23
Copy link
Copy Markdown
Contributor Author

@plemech23 I looked at this PR several times and to be honest, I'm confused. To me, it looks like you not only added an example but also changed the wording of the actual guideline. Can you please clarify: Is there an actual change as to what the provider needs to do?

Yes, I’ve reworded it a bit to make it clearer and add the OAS example. Should I adjust the PR body or the rule itself?

@kollegolin
Copy link
Copy Markdown
Contributor

@plemech23 It depends :)
If API providers should actually do something differently, the PR body needs to be adjusted (and the rule as well for more clarity).
If you really only wanted to add an alternative of how to present lists in OpenAPI, the PR body is fine but we should take another look at the rule.
At the moment, it's confusing.
We can also have a chat about this in person next week.

@kiriakos
Copy link
Copy Markdown
Contributor

@kollegolin Has a point. The PR does is tighten up the language around the original intent of the rule as well as provide an illustrative example. The Changelog entry could reflect that first part to reduce the "surprise" factor I guess.

@plemech23 how about

- Tighten the language in "MUST support lists for multiple values of the same query parameter" [R000062](https://api.otto.de/portal/guidelines/r000062) and add an OpenAPI example  

@kollegolin
Copy link
Copy Markdown
Contributor

@kollegolin Has a point. The PR does is tighten up the language around the original intent of the rule as well as provide an illustrative example. The Changelog entry could reflect that first part to reduce the "surprise" factor I guess.

@plemech23 how about

- Tighten the language in "MUST support lists for multiple values of the same query parameter" [R000062](https://api.otto.de/portal/guidelines/r000062) and add an OpenAPI example  

@plemech23 , @kiriakos I'm not sure we even need that whole rewording part ("tighten the language") as that leads to confusion. If we only want to provide an example, let's stick to that in the guideline. Happy to have a pairing call on the topic.

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.

6 participants