docs: add recent changes to our contribution guides #544
Conversation
✅ Deploy Preview for api-clients-automation ready!
To edit notification comments on pull requests, go to your Netlify site settings. |
✗ The generated branch has been deleted.If the PR has been merged, you can check the generated code on the |
shortcuts
force-pushed
the
docs/recent-contributions
branch
from
78a0460 to
5835dfd
Compare
| @@ -38,7 +38,7 @@ Path definition of the paths defined in the [spec file](#specyml-file). | |||
|
|
|||
| ### Send extra options to the template | |||
|
|
|||
| You might want to send extra information to the generators that have no link with your REST API. To do so, you can add parameters starting matching `x-my-parameter-name` that will be available in the template under `vendorExtensions`. | |||
| You might want to send extra information to the generators that have no link with your REST API. To do so, you can add parameters starting with `x-` at the root level of your spec, which will be available in the mustache template under the `vendorExtensions` object. | |||
There was a problem hiding this comment.
It can work at any level, why precise root level ?
There was a problem hiding this comment.
It's a bit tricky IIRC because in a nested inline parameter, it won't be passed
We can remove the mention but I preferred to make it clear here
There was a problem hiding this comment.
Most object in openapi have a vendorExtensions property, it would be complicated to be exhaustive here but I think it can work in a lot of places
There was a problem hiding this comment.
This part was only to mention the implementation from the spec level directly, lmk if you want me to make it broader
There was a problem hiding this comment.
It's an obscure feature it's okay to not document it fully
🧭 What and Why
🎟 JIRA Ticket: https://algolia.atlassian.net/browse/APIC-484
Changes included:
This PR adds documentation for the changes that have happened internally in the past weeks, it could be more exhaustive/detailed but it's a starting point so we don't forget what have been done.
headersin the CTSrequestOptionsin the CTSrequestOptionsin the clientsuseReadTransporter🧪 Test
Netlify preview