Discussions

Ask a Question
ANSWERED

Ability to pass in Avatar URL for users?

I would love to be able to pass in the avatar URL for our users inside the custom login JWT. It would help keep things looking constant across the dashboard and developer hub. Any thoughts on adding something like that?

Site Navigation with versions

We have 2 versions of our product, with correlating documentation. One of them has API Reference and the other does not. I want show API Reference in the Top Navigation bar on Version 1, but not on Version 2. How do I do that? When I remove the API Reference link on dash.readme.com/project/\<project_name>/v1.0/usability, it is also removed from dash.readme.com/project/\<project_name>/v2.0/usability. I would expect separate behavior, since the version number is in the URL.
ANSWERED

Please add option to set light/dark theme to Same as System on iPhones when using Safari browser

Currently it is not possible to set theme to Same as System on iPhones when using Safari browser. On Android phones you can press and hold theme icon button and there will be "Same as System" option. Unfortunately the option does not show up when using iPhone Safari browser. Please fix it! :)
ANSWERED

Error coming for few specs for version mismatch

What is this error - The version you specified (1.0.7) doesn't match any of the existing versions (1.0) in ReadMe. ?
ANSWERED

OpenAPI spec updating failing with "Authorization token in request should be Base64 encoded"

we recently encountered this failure in our automation that calls the \[PUT update OpenAPI](<https://docs.readme.com/main/reference/updateapispecification> spec endpoint > HttpResponseProxy{HTTP/1.1 400 Bad Request [Date: Tue, 06 Jun 2023 17:09:11 GMT, Content-Type: application/json; charset=utf-8, Content-Length: 855, Connection: keep-alive, X-Xss-Protection: 1; mode=block, X-Dns-Prefetch-Control: off, X-Frame-Options: Deny, Strict-Transport-Security: max-age=15552000; includeSubDomains, X-Download-Options: noopen, X-Content-Type-Options: nosniff, X-Powered-By: Express, Warning: 199 - "Authorization token in request should be Base64 encoded", X-Documentation-Url: https://docs.readme.com/main/logs/a33ddb46-ad7a-4428-ae84-d95c842128bf, Etag: W/"357-5mB4EKrmnApLjk3SlNuYpGGDO5c", Vary: Accept-Encoding, Via: 1.1 vegur, CF-Cache-Status: DYNAMIC, Server: cloudflare, CF-RAY: 7d3242f5ce5c30ab-SEA] ResponseEntityProxy{[Content-Type: application/json; charset=utf-8,Content-Length: 855,Chunked: false]} we have been passing `Authorization: Basic $readmeApiKey` as the authorization for some time now and this has been working. I see the cool new <https://docs.readme.com/main/reference/intro/authentication> section of the docs, but this doesn't mention base64 encoding the api key. What stands out to me is the `Warning: 199 - "Authorization token in request should be Base64 encoded"` , which could be fine and unrelated to the failed API call if it's just a warning (unless it is the issue, in which case shouldn't that make this a http status 401?
ANSWERED

Customized layout of API reference pages

Hi, Is there anyway I can customize the layout of API reference pages? Specifically, I want to move the History Calls section to the bottom, below the response example section. Thank you!
ANSWERED

Error Submitting form

When I update a Guide page, I get a message that says error submitting form. This happens after entering text and clicking the Save to Staging button. The page that I am working on is quite large with many tables. Do you have any ideas why I am getting this error and what I can do?
ANSWERED

Automating openapi sync with circleci

Is there any method like <https://docs.readme.com/main/docs/github-actions-openapi-example> but for <https://circleci.com/>?
ANSWERED

Changelogs via Slack?

The doc says there is slack integration for Suggested Edits and Discussions. Is there any support for changelogs? <https://docs.readme.com/main/docs/slack>
ANSWERED

Support for SDK Documentation

Are you planning to add support for other types of API? like SDK documentation?