Commit Graph

41 Commits

Author SHA1 Message Date
Alex Varchuk
64f18779e5
feat: add support x-badges (#2605)
* feat: add support x-badges

Co-authored-by: Max Mueller <maxmueller@eaton.com>

* chore: try to fix e2e tests

* chore: try to fix e2e tests part 2

* Update docs/redoc-vendor-extensions.md

---------

Co-authored-by: Max Mueller <maxmueller@eaton.com>
Co-authored-by: Jacek Łękawa <164185257+JLekawa@users.noreply.github.com>
2024-10-16 11:48:21 +03:00
Alex Varchuk
a7607eafdd
docs: update broken link of Openapi Object (#2577) 2024-08-29 19:18:05 +02:00
Lorna Jane Mitchell
4fd22f6d74
docs: Add docs tooling to align with publishing to main site (#2484)
* docs: add markdownlint and some link checks alongside vale

* docs: add link checker config and fix/update some links reported broken

* docs: update markdownlint action

* docs: fix markdown table formatting

* docs: Unpin Vale version and pick up the latest
2024-01-29 16:39:44 +00:00
redocly-bot
7b2931dc91 sync: Synced local 'docs/' with remote 'docs/redoc/' 2023-11-09 15:56:30 +00:00
Adam Altman
9b73dae685
docs: fix and update links in redoc-vendor-extensions (#2368)
Co-authored-by: Lorna Jane Mitchell <github@lornajane.net>
2023-07-21 11:40:20 -05:00
Heather Cloward
c407726a66
docs: adds vale rules and workflow for running in CI (#2348)
* docs: adds vale rules and workflow for running in CI

* docs: updates product name from ReDoc to Redoc
2023-07-11 13:31:52 -04:00
redocly-bot
ab02f667a1 sync: Synced local 'docs/' with remote 'docs/redoc/' 2022-02-09 12:18:16 +00:00
Swapnil Ogale
0c782ec51f
docs: improvements to vendor extensions topic (#1386) 2020-10-13 14:55:45 +03:00
JoBrad
b6414f4e43
Updated x-servers link to point to valid location. (#1267) 2020-05-24 23:06:08 +03:00
Roman Hotsiy
becc2f5856
fix: depreacate x-code-samples, rename to x-codeSamples for consistency 2020-05-10 22:11:01 +03:00
Mohamed Zenadi
ea5b0aabf9
feat: add x-explicitMappingOnly extension (#1215) 2020-03-27 12:09:44 +02:00
David Beacham
0eb1e66a10 feat: add x-additionalPropertiesName (#622) (#944)
* Add x-additionalPropertiesName (#622)

Supply custom name to be displayed for property name of
`additionalProperties`.

* Include prettier output for Schema.ts
2019-06-18 11:41:48 +03:00
Roman Hotsiy
d78029a04e
chore: move repo to Redocly org 2019-06-04 15:47:22 +03:00
Sergio Regueira
3659a75020 chore: Group documentation of x-traitTag extension (#802) 2019-02-26 08:58:18 +01:00
lrobledo
a419303612 docs: fix typos in redoc-vendor-extensions.md (#782)
[ci skip]
2019-01-10 17:28:21 +02:00
Patrick Elam
a1aa49a322 docs: fix link to OpenAPI specification in vendor extensions doc (#750) 2018-12-17 23:07:33 +02:00
Patrick Elam
4f60ec85aa docs: fixed links to oas spec page (#728) 2018-11-30 10:09:40 +02:00
TATSUNO Yasuhiro
87fd7d7fdd feat: Add feature to specify href for logo explicitly (#645)
Closes https://github.com/Rebilly/ReDoc/issues/627
2018-11-27 11:27:10 +02:00
Sheila Kelly
568ce74077 feat: Add x-logo alt text support (#584)
Fixes #546
2018-08-02 15:27:38 +03:00
Tim Hordern
7d7b405116 chore: Fix minor spelling errors in vendor extensions docs (#589) 2018-08-02 11:20:24 +03:00
Roman Hotsiy
00bd966797
feat: support label for x-code-samples
fixes #586
2018-08-01 10:20:16 +03:00
Roman Hotsiy
63ae2e8e94
feat: support x-summary for response objects
fixes #500
2018-06-01 16:50:07 +03:00
Mike Ralphson
b586e5b620 Add note that x-logo SHOULD use absolute URLs
Have seen a number of definitions designed for use with ReDoc using a relative logo URL. This 'breaks' when someone else (e.g. APIs.guru hosts the API definition).
2017-11-28 10:31:55 +02:00
Roman Hotsiy
56d62e5ab2
feat: add ignoredHeaderParameters option 2017-09-21 11:36:18 +03:00
Brendan Abbott
3c569cde6e Support x-examples vendor extension for requests 2017-03-09 20:55:23 +10:00
Roman Hotsiy
7b19417497
docs: update docs for x-tagGroup, add warning #215 2017-02-28 22:04:24 +02:00
Roman Hotsiy
ffcedeeb8e
docs: docs for 2017-02-27 08:49:57 +02:00
Roman Hotsiy
a1aefa4123
docs: docs for x-servers 2017-02-26 01:00:08 +02:00
Roman Hotsiy
05be7561f0
Undeprecate x-traitTag 2017-02-02 23:24:00 +02:00
Roman Hotsiy
f902abd5f1
add x-tagGroups docs 2016-12-25 23:47:33 +02:00
Jean-Daniel
e18cd4bca8 Fix typo 2016-12-08 10:40:00 +01:00
Ben Firshman
82b52bf6ef Add display name for tags
In go-swagger, the name of the tag determines the directory that
generated files end up in. Also, we want the tag names to be
consistent with operationIds.

Unfortunately, these make bad names for menu items, so we want
to have a way of specifying human-friendly names for the menu.
2016-12-05 20:58:53 +02:00
Roman Hotsiy
9e7ba0ea8d
Deprecate x-traitTag 2016-10-31 12:32:03 +02:00
Roman Hotsiy
40c40cd327
Add x-nullable to the docs 2016-08-31 22:45:34 +03:00
Ivan Goncharov
d629644c94 Improve headings for vendor extensions 2016-07-17 21:48:56 +03:00
Ivan Goncharov
5cfc0b4479
Fix internal links inside docs. 2016-07-17 19:02:27 +03:00
Ivan Goncharov
900ecaa2cc fix backgroundColor in samples 2016-04-22 16:33:27 +03:00
Roman Hotsiy
61646df40c Update x-logo.backgroundColor vendor extention spec 2016-04-16 14:34:19 +03:00
Roman Hotsiy
9dd93e8895 doc styling fixes 2016-02-01 19:49:57 +02:00
Roman Hotsiy
a95e866041 Fix md tables in vendor extensions doc 2016-02-01 19:38:21 +02:00
Roman Hotsiy
ad7629a640 Add vendor extensions docs 2016-02-01 19:23:13 +02:00