feat(specs): add cURL snippets #3841
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
✔️ Code generated!
📊 Benchmark resultsBenchmarks performed on the method using a mock server, the results might not reflect the real-world performance.
|
shortcuts
force-pushed
the
feat/specs-cURL-snippet
branch
from
5093e16
to
65be943
Compare
millotp
reviewed
Oct 8, 2024
| @@ -1,9 +1,11 @@ | |||
| import fsp from 'fs/promises'; | |||
|
|
|||
| import oas2har from '@har-sdk/oas'; | |||
There was a problem hiding this comment.
Suggested change
| import oas2har from '@har-sdk/oas'; | |
| import { oas2har } from '@har-sdk/oas'; |
since you only use 1 function
There was a problem hiding this comment.
I thought so too based on their doc but seems like it's incorrect
SyntaxError: The requested module '@har-sdk/oas' does not provide an export named 'oas2har'
scripts/specs/format.ts
Outdated
| specMethod['x-codeSamples'].push({ | ||
| lang: 'cURL', | ||
| label: 'curl', | ||
| source: new HTTPSnippet(harRequest as HarRequest).convert('shell', 'curl', { indent: '\t' }), |
There was a problem hiding this comment.
why isn't it outputed like source: > like the other snippets ? maybe you need to convert it to a string with .toString() and replace the new lines
There was a problem hiding this comment.
good point it's EXACTLY what i'm looking at right now
algolia-bot
added a commit
that referenced
this pull request
Oct 9, 2024
Co-authored-by: Clément Vannicatte <vannicattec@gmail.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
🧭 What and Why
🎟 JIRA Ticket: https://algolia.atlassian.net/browse/DI-3026
Changes included:
some customer requester cURL example in the API reference page https://www.algolia.com/doc/rest-api/search/, I assume it is to quickly try some stuff before setting up a real codebase
the openapi-generator is a bit overkill and doesn't properly handle oneOf cases, this simple solution seems to be enough