docs: fix Actor capitalization throughout open api docs #1331
Conversation
| - Add the token to your request's `Authorization` header as `Bearer | ||
| <token>`. | ||
| - Add the token to your request's `Authorization` header as <code>Bearer | ||
| <token></code>. |
There was a problem hiding this comment.
Is this written by hand? Are you aware of the HTML entities and the HTML tags instead of Markdown backticks?
There was a problem hiding this comment.
yes, because for some reason regular backticks are not working in new API docs check the screenshot from current version
it looks fine on Redoc version
but this is how it looks currently on the new API docs
I tested this locally and it changed to backticks locally so I hope the same will happen on prod
There was a problem hiding this comment.
I'll have a look, next time ping me with such issues instead of going with some workaround, I hope we can find a way to make this work without any changes, since the workaround is ugly at best :]
There was a problem hiding this comment.
this seems to be a problem with redoc, it escapes HTML inside code blocks for some weird reason, and apparently, it's like that for the last 7 years (Redocly/redoc@fef9ec4)
the commit description says if lang is not specified, maybe we can just specify a language somehow, but I don't see a way to do that with inline code blocks
There was a problem hiding this comment.
hmm but on redoc API it is rederered correctly, the issue was in new API docs?
There was a problem hiding this comment.
No, its their quirk, it makes no sense to escape anything inside code blocks. I think they just solve things on wrong level.
| @@ -75,8 +75,8 @@ get: | |||
| x-py-doc-url: https://docs.apify.com/api/client/python/reference/class/BuildCollectionClientAsync#list | |||
| post: | |||
| tags: | |||
| - Actors/Build collection | |||
| summary: Build actor | |||
| - Builds | |||
There was a problem hiding this comment.
Are you concisely changing the tag here? It might result in a broken link.
There was a problem hiding this comment.
good catch, that is remnant of some testing, no intention to change any tags, will fix it
No description provided.