1
0
mirror of synced 2025-12-21 19:11:14 -05:00
Commit Graph

23 Commits

Author SHA1 Message Date
Natalie Kwong
8c6e94cc94 docs: Rate limits, Applications, schema management and API docs (#43938)
Co-authored-by: Teal Larson <LARSON.TEAL@GMAIL.COM>
2024-08-13 10:30:38 -07:00
Natik Gadzhi
cb80e6922a [tools] prettier rules for .md + formatting cleanup 2024-05-07 08:19:33 -07:00
Tim Roes
faedd86ee0 📚 Add availability information to docs (#33650) 2023-12-20 18:47:58 +01:00
Riley Brook
c7a2db1a18 Update api-documentation.md (#29605) 2023-08-22 13:34:47 -07:00
Riley Brook
798fbf461d Update api-documentation.md (#25447) 2023-04-24 13:58:32 -07:00
Riley Brook
edb02d8f92 Update api-documentation.md (#24817) 2023-04-03 15:53:25 -07:00
Riley Brook
7b278c25ac Update API Docs (#23787) 2023-03-06 13:27:50 -08:00
Riley Brook
33d5a21831 Update API doc table (again) (#23710)
* Update API doc table (again)

* Update
2023-03-03 12:08:30 -08:00
Riley Brook
4ce28cf9b5 Update API doc table (#23697)
* Update API doc table

Update API doc table

* replace <br> with <br />

---------

Co-authored-by: terencecho <3916587+terencecho@users.noreply.github.com>
2023-03-02 15:05:26 -08:00
Riley Brook
6dab22aa7b Update API page (#23519) 2023-02-27 14:51:15 -08:00
Amruta Ranade
cae63965bd Deployment docs and sidebar cleanup (#20965) 2023-01-03 19:18:35 +05:30
Riley Brook
e34963c07e Update /api-documentation (#20742)
Updating for more explicit bifurcation between Open-Source API (aka config API) and the Cloud API.
2022-12-21 11:51:02 -08:00
Riley Brook
180da08df5 Update API document at docs.airbyte.com/api-documentation (#20449)
* Update API document on docs.airbyte.com

Updates to document located at https://docs.airbyte.com/api-documentation

* Update api-documentation.md

* Update api-documentation.md

* Update api-documentation.md
2022-12-14 14:03:21 -08:00
Topher Lubaway
9c6c092a22 Revert "Improving docusaurus sidebar generation (#1927) (#14369)" (#14596)
This reverts commit a2c194a11f.
2022-07-11 15:27:14 -05:00
Mykyta Serbynevskiy
a2c194a11f Improving docusaurus sidebar generation (#1927) (#14369)
* Improving docusaurus sidebar generation (#1927)

* Added "Career & open positions" folder to sidebar, adjusted "Project overview" folder

* Deleted "career-and-open-positions" folder from sidebar
2022-07-08 14:18:27 -05:00
Jared Rhizor
14dfc1d417 fix parentheses and info/warning/danger formatting in docs (#11981)
* fix parens

* fix formatting for hints

* remove hint from non-docusaurus or gitbook doc
2022-04-13 12:08:34 -07:00
Erica Struthers
6842ee0bba Update api-documentation.md 2022-03-02 11:09:10 -07:00
Erica Struthers
917a18d77b Update api-documentation.md 2022-03-02 10:59:00 -07:00
Marcos Marx
fd025dc9e0 api token warn (#6980) 2021-10-12 14:15:05 -03:00
John Lafleur
55256d293d GitBook: [master] 55 pages and 36 assets modified 2021-04-05 00:43:26 +00:00
Davin Chia
556d0a6239 Point API documentation link to nicer UI source. (#2455)
What:
Swagger UI has bad-UI and extensibility. It's not intuitive and often displays information badly (especially for more complicated structs), which leads to initial API confusion.

How:
Switch over to use Rapidoc. This is our new api docs!

Created the airbyte-public-api-docs bucket and uploaded our new html docs. Set up a CloudFront distribution to enable HTTPS.

A copy of our html docs is checked in in this PR. As you can see, this is a minimal file that relies on a React component published by Rapidoc. It is pointed to the api docs in our master branch and will automatically update itself; do not expect us to need to touch this api file unless we want to make display changes.

I consolidated all files involving api documentation into the docs/api folder for simplicity. I also moved the generated html file to the generated-api-html folder within the api folder to make it clear it was generated. Finally, added a README to document our set up.

Benefits:

UI is much cleaner.
We control the html source file, which means it'll be easier for us to make changes in the future.
2021-03-15 13:24:58 +08:00
John Lafleur
048ae65afe GitBook: [master] 2 pages modified 2021-02-16 05:44:13 +00:00
John Lafleur
8286c4c229 GitBook: [docs_api_documentation] 2 pages modified (#2079)
Co-authored-by: John Lafleur <john@dataline.io>
2021-02-16 09:38:27 +11:00