cd20c43f50
feat: update mgmt api docs ( #38902 )
...
Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com >
Co-authored-by: Raúl Barroso <code@raulb.dev >
2025-09-22 15:38:10 +00:00
e8c158bc48
docs: web3 and some other js reference improvements ( #38670 )
...
* docs: web3 and some other js reference improvements
* add MetaMask to spell rules
* apply suggestion from @cemalkilic
Co-authored-by: Cemal Kılıç <cemalkilic@users.noreply.github.com >
* fix tests
* test: update snapshot
---------
Co-authored-by: Cemal Kılıç <cemalkilic@users.noreply.github.com >
Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com >
2025-09-15 14:56:34 +02:00
Katerina Skroumpelou and Charis Lam
a5fc052704
docs: update js client libs docs ( #38595 )
...
* docs: update js client libs docs
* chore: update test snapshot for specs
* ci(docs): run tests on spec changes
---------
Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com >
2025-09-11 12:14:27 +01:00
github-actions[bot] and phamhieu
de80626671
feat: update mgmt api docs ( #37652 )
...
Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com >
2025-08-04 20:24:33 +00:00
Katerina Skroumpelou
f6585d18d3
chore: update storage js docs ( #37515 )
2025-07-31 12:43:34 +00:00
github-actions[bot] and kamilogorek
f1753e7dc2
feat: update mgmt api docs ( #37455 )
...
Co-authored-by: kamilogorek <1523305+kamilogorek@users.noreply.github.com >
2025-07-25 09:44:38 +02:00
27af144426
feat: update mgmt api docs ( #34554 )
...
Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com >
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com >
2025-03-31 15:29:20 +00:00
github-actions[bot] and phamhieu
0ad3412d7a
feat: update mgmt api docs ( #34365 )
...
Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com >
2025-03-27 18:53:51 +00:00
github-actions[bot] and phamhieu
99a3a3f557
feat: update mgmt api docs ( #33950 )
...
Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com >
2025-03-17 15:43:36 +00:00
Charis
c5c5bc231f
feat: support typedoc 0.27 ( #33905 )
...
Type docs pulled from JS client libraries were expected to be in version 0.22, which unfortunately is a bit old and incompatible with TypeScript 5. Therefore any JS lib that upgrades their toolchian to TS 5 will inadvertently break their type specs in docs.
This PR updates docs to also support 0.27 (the latest stable version, compatible with TS 5), in addition to the old version. Parallel support is required since many libs are still on the old version.
The main changes are:
- The comment shape has changed in typedoc.
- kindString has been deprecated in favor the kind numbers.
- indexSignatures are now plural (an array).
2025-03-03 17:17:38 +00:00
Andrew Valleteau and Charis Lam
ac54d858a1
chore(docs): setup docs for overrideTypes ( #33705 )
...
* chore(docs): setup docs for overrideTypes
* fix: add overrideTypes to docs section
* chore: regen specs
* chore: update snapshot
* chore: regenerate all specs
* revert realtime spec changes
---------
Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com >
2025-03-03 15:35:39 +01:00
github-actions[bot] and kamilogorek
bf04ff6681
feat: update mgmt api docs ( #33642 )
...
Co-authored-by: kamilogorek <1523305+kamilogorek@users.noreply.github.com >
2025-02-19 09:30:58 +00:00
github-actions[bot] and phamhieu
57d668c6ce
feat: update mgmt api docs ( #33467 )
...
Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com >
2025-02-10 19:18:25 +00:00
a67fcb1809
docs: Regenerate specs for all API docs references ( #33265 )
...
* docs: Regenerate specs for all API docs references
* Fix the reference docs parsing.
* Update snapshots of docs tests.
* fix(ui): hide details panel for file params
* fix(ui): fix array display when inner type is not given
---------
Co-authored-by: Ivan Vasilov <vasilov.ivan@gmail.com >
Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com >
2025-02-04 14:57:17 +01:00
github-actions[bot] and phamhieu
d35855cb58
feat: update mgmt api docs ( #33104 )
...
Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com >
2025-01-27 18:09:58 +00:00
347dbcc875
feat: update mgmt api docs ( #32918 )
...
Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com >
Co-authored-by: Bobbie Soedirgo <31685197+soedirgo@users.noreply.github.com >
2025-01-20 05:18:11 +00:00
github-actions[bot] and phamhieu
7a0871b9ce
feat: update mgmt api docs ( #32732 )
...
Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com >
2025-01-13 19:10:31 +00:00
8c854368da
feat: update mgmt api docs ( #31297 )
...
Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com >
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com >
2025-01-02 18:05:08 +00:00
github-actions[bot] and phamhieu
eb326ea75a
feat: update mgmt api docs ( #31092 )
...
Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com >
2024-12-12 15:40:26 +00:00
github-actions[bot] and phamhieu
aa623fec31
feat: update mgmt api docs ( #30768 )
...
Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com >
2024-12-09 18:03:26 +00:00
github-actions[bot] and phamhieu
baa19e01dc
feat: update mgmt api docs ( #30513 )
...
Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com >
2024-11-25 17:34:55 +00:00
github-actions[bot] and phamhieu
936fe4f5a1
feat: update mgmt api docs ( #30405 )
...
Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com >
2024-11-11 18:10:47 +00:00
github-actions[bot] and phamhieu
3d63cfe2b1
feat: update mgmt api docs ( #30252 )
...
Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com >
2024-11-04 19:04:48 +00:00
github-actions[bot] and phamhieu
e1fb0cc719
feat: update mgmt api docs ( #30000 )
...
Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com >
2024-10-28 22:58:13 +00:00
github-actions[bot] and phamhieu
b438f1001f
feat: update mgmt api docs ( #29869 )
...
Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com >
2024-10-16 15:56:26 +00:00
github-actions[bot] and phamhieu
55bdda2401
feat: update mgmt api docs ( #29708 )
...
Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com >
2024-10-08 20:58:24 +00:00
github-actions[bot] and phamhieu
0a2886fa61
feat: update mgmt api docs ( #29581 )
...
Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com >
2024-10-02 15:33:46 +00:00
Ivan Vasilov
b0cf2bf6fa
chore: Move parser package to packages folder ( #29522 )
...
* Move the spec/parser package into packages folder.
* Fix the spec generation with the new paths.
* Remove the spec folder from prettierignore.
* Run prettier on the spec folder (without regenerating, that's should be done by the product teams).
2024-09-25 23:45:14 +02:00
github-actions[bot] and phamhieu
99a62b2f37
feat: update mgmt api docs ( #29442 )
...
Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com >
2024-09-23 15:01:56 +00:00
github-actions[bot] and phamhieu
5de6a7080e
feat: update mgmt api docs ( #29165 )
...
Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com >
2024-09-09 16:04:23 +00:00
github-actions[bot] and phamhieu
a08c79eda1
feat: update mgmt api docs ( #28867 )
...
Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com >
2024-09-03 18:11:54 +00:00
github-actions[bot] and phamhieu
2519d3cc33
feat: update mgmt api docs ( #28541 )
...
Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com >
2024-08-12 18:17:18 +00:00
github-actions[bot] and phamhieu
14f22a48a0
feat: update mgmt api docs ( #28378 )
...
Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com >
2024-08-05 20:12:01 +00:00
github-actions[bot] and phamhieu
a12d6b08d2
feat: update mgmt api docs ( #28242 )
...
Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com >
2024-07-31 01:32:20 +00:00
github-actions[bot] and phamhieu
f9aac31adb
feat: update mgmt api docs ( #28116 )
...
Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com >
2024-07-22 16:55:59 +00:00
github-actions[bot] and phamhieu
90b71e3e42
feat: update mgmt api docs ( #27958 )
...
Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com >
2024-07-15 19:01:26 +00:00
github-actions[bot] and phamhieu
8aef4a08bf
feat: update mgmt api docs ( #27851 )
...
Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com >
2024-07-08 19:13:11 +00:00
github-actions[bot] and phamhieu
a54aecd089
feat: update mgmt api docs ( #27665 )
...
Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com >
2024-07-01 17:49:22 +00:00
github-actions[bot] and phamhieu
ae06e6b7c5
feat: update mgmt api docs ( #27308 )
...
Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com >
2024-06-24 17:38:30 +00:00
github-actions[bot] and phamhieu
8d9dda6d12
feat: update mgmt api docs ( #26987 )
...
Co-authored-by: phamhieu <689843+phamhieu@users.noreply.github.com >
2024-06-10 22:25:03 +00:00
Hieu
d855bfb3f8
feat: automate mgmt api spec update ( #26655 )
...
* fix: correct mgmt api naming
* feat: new command to generate mgmt api sections
* feat: sort section items
* chore: tidy up
* fix: add generate sections to the default command
* feat: add gha to auto update mgmt api docs
* chore: tidy up
* fix: operationId logic to support self-hosting references
* chore: update latest mgmt api specs
* chore: update latest mgmt api specs
2024-05-31 08:53:19 +07:00
Hieu and Charis
c5a88a9fc4
feat: render mgmt api body params ( #26319 )
...
* feat: render body parameters
* feat: api parameters render
* fix: update mgmt api spec to latest
* fix: body param format and support content type selection
* fix: prettier errors
* fix: use Options to render accepted enum values
* fix: prettier again
* fix: merge conflict
* fix: expose new api routes
* fix: prettier again
* refactor: ApiBodyParam
* fix: add missing apis
* chore: tidy up
* feat: improve api response with sample + schema tabs
* fix: support show/hide object param schema
* fix: show no content text
* refactor: use collapsible for hidden content
* Update apps/docs/components/reference/ApiOperationSection.tsx
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com >
* Update apps/docs/components/ApiSchemaOption.tsx
Co-authored-by: Charis <26616127+charislam@users.noreply.github.com >
* fix: resolve comments
---------
Co-authored-by: Charis Lam <26616127+charislam@users.noreply.github.com >
2024-05-21 13:30:34 +07:00
Kevin Grüneberg
245c127805
chore: use redocly swagger cli ( #20137 )
2024-01-03 19:14:10 +01:00
Kevin Grüneberg
129b3d927a
chore: move specs to docs folder ( #20136 )
2024-01-03 18:54:23 +01:00
