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

fix docublocks parameter naming #10254

Merged
merged 1 commit into from Oct 17, 2019
Merged

fix docublocks parameter naming #10254

merged 1 commit into from Oct 17, 2019

Conversation

graetzer
Copy link
Contributor

Scope & Purpose

Parameters are named wrong

  • Bug-Fix for devel-branch (i.e. no need for backports?)
  • Bug-Fix for a released version (did you remember to port this to all relevant release branches?)

Testing & Verification

This change is a trivial rework / code cleanup without any test coverage.

http://jenkins01.arangodb.biz:8080/view/Documentation/job/arangodb-ANY-examples/402/

@graetzer graetzer added this to the devel milestone Oct 15, 2019
@Simran-B
Copy link
Contributor

How does this problem manifest? Do hyphens cause issues in Swagger UI? @graetzer

@graetzer
Copy link
Contributor Author

graetzer commented Oct 15, 2019

The parameter is named "collection" not "collection-name"

@graetzer
Copy link
Contributor Author

the docs are just wrong

Copy link
Contributor

@Simran-B Simran-B left a comment

Choose a reason for hiding this comment

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

I see, this is a query string parameter where the name actually matters.

@jsteemann jsteemann merged commit 62e4937 into devel Oct 17, 2019
@jsteemann jsteemann deleted the bug-fix/index-swagger branch October 17, 2019 09:01
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

3 participants