-
Notifications
You must be signed in to change notification settings - Fork 21
fix(specs): New Crawler API parameter - ignorePaginationAttributes #4614
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
Conversation
✔️ Code generated!
📊 Benchmark resultsBenchmarks performed on the method using a mock server, the results might not reflect the real-world performance.
|
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.
looks good! just one question
|
||
It doesn't replace: | ||
|
||
|
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.
are all of those spaces expected?
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.
Double spacing makes sure paragraphs render properly and spacing between list elements stops them running into each other
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.
I don't think it's necessary for specs in this repo as you can see with the other API specs. The sources don't have this formatting, but in the generated, complete specs, you'll find the double spacing. Maybe something to do with YAML parsing/writing.
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.
In the source, you'll notice that long description
fields are declared as literal block scalars with the |
symbol, which means keep newlines as indicated.
During the bundling of the spec, and I don't know why, most of these are converted into folded block scalars with the >
symbol, which means newlines are replaced by a space, two newlines are replaced by one newline.
I find the |
style more readable as it leads to more compact blocks
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.
I'll keep an eye on this when the bundle is built. I did notice some discrepancies in spacing that I manually corrected for the Mintlify prototype.
Popping this on hold for now. I've just spotted some duplication in my updates... |
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.
flawless
…4614) (generated) [skip ci] Co-authored-by: gazconroy <[email protected]> Co-authored-by: Gary Conroy <[email protected]> Co-authored-by: Kai Welke <[email protected]> Co-authored-by: Clément Vannicatte <[email protected]>
🧭 What and Why
New configuration parameter added to the Crawler API.
Changes included:
ignorePaginationAttributes
parameternumber
types tointeger
types