-
Notifications
You must be signed in to change notification settings - Fork 2
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
Proposal API description #11
Conversation
agordiichuk
commented
Mar 30, 2024
•
edited
Loading
edited
- DON'T MERGE - review in progress
- Proposal for documentation description based on https://github.com/PaloAltoNetworks/docusaurus-openapi-docs/tree/main
- Updated structure
- Created resolutions for docusaurus 3.1.1, due to open issue MDX - Ensure Docusaurus v3 (MDX v3) compatibility PaloAltoNetworks/docusaurus-openapi-docs#654 (comment)
sidebar_label: "Add Line Item to cart" | ||
hide_title: true | ||
hide_table_of_contents: true | ||
api: eJyNVE1v2zAM/SuGThvgfO3oW9fuEKDAiiw7ZTkoFhOrtSVVkrMahv/7SMlJ7KRblwCJJZF85HvPapmF1xqc/6pFw7I2LKUFwTJva0hZrpUH5emIG1PKnHup1ezZaUV7Li+g4vTkGwMsY3r3DLlnKTNWG7BegqPTI1gnY0of6LyV6oCB8MYrU9JW2+bc+kkf23WsSxnPCc8NErm1vME86aFyHyPHAv8G5kI8SgVLrEiYWEDUuV+Kj9rtAydSxGaP3Equ/iPxHBjzXmtcSN8M0iTSfgA7zFt09EkZRoYyd5euV1FEFgMsOIOcxfm/zOf0J8DlVprIBaO8hAhMcHQQiavzHJzb12XZMCoxDkekJKQQVuJ1QjoR09zyCjzqxbJNiz1jrOG+wCOFB7gKgkqBGzdO6YkJ/Y49NwZfF4j7kOh94vGJCk5Zt00ZAhdaEKJ2sRkEztiMItys7ZE7ggZ7PPVY2zIoUGBS182ChuSbyQs0JAYWJm+vLm/FtxP/AxffWnXg1M3FdCNnjYx17Z6Rea4cMjTIotsiY1LtdaCyt8K9riqwOay1Ll1y97SkeudmF9P5dB6MjUNXPLwMvT5/U3YkwVkyD29+ZkqOQmO1QGXb874JUjtMzU6aI5XEMp217Y47+GlLnGZL44DFWTbbfuodDYG0CenoGRnY89JdO6G9XEbs06r3zOfkPX+k73d8ukFUE/gua1rhI2o/8GpguAAu8PWjruLpfcSerKnGJfvmUhxZ8+n7jzUG7/rLtdKCciz/jZv0m7Ff+MWFNudrLuy3rOTqUPMDxce69PkDVq305w== |
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 like to store token here. we could move it to variables. also a question about could it be expired?
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.
see that it different for other files. is it token?
I appreciate your time. thanks for the ideas. but honestly, I think that the amount of effort to create such documentation does not equal the amount of benefits gained. I have the following thoughts:
In general, I think it is better to keep the simple MD format for current needs and to save time. since changing the format does not offer any programmatic advantages in my opinion. we had a point about keeping everything in one place, but I think that for details it is okay to send to CommerceTool API doc. I see this information as an endpoint, body format, and a link to commertool doc where you can read the details. if you have time let's have a short call to discuss it in more detailed and think together. |