Discussions
How do we review edits
I'm running an editorial pass through the entirety of a company's API documentation. Is there a way for me to allow them to review my changes before (or even after) they are published? Page History appears to be working for the object definitions, but not for the individual calls.
Is there a way to set API Resopnse output to be fully expanded by default?
Our docs have a collapsed by default JSON response, which is helpful for complex or large JSON objects. But sometimes a user may wish to copy and paste from our docs to geojson.io for example.
Arbitrary JSON data in API reference
Hi, we have an API endpoint that can take arbitrary JSON in a part of its request body. We tried to express that by using a field with type: object
and additionalProperties: true
, and this renders in the API reference as a field where you can add extra fields and give them names and values, but the values are always encoded as strings. So if we type { "foo": 2 }
as the value of one of those fields it ends up as "fieldName": "{ \"foo\": 2}"
in the payload of the request examples.
Anyone using the Search API?
Hi, We're using api/v1/docs/search to return docs on a custom page outside of readme (wordpress). We're using 3 readme.io projects, making 3 API calls to return results.
Add link to image
Hi there, is it possible to add a link to an image? I had a look at editing in raw mode, but haven't been able to figure it out.
Error selecting a Plan
I joined readme.io and ported our documentation, now that I want to publish it I can't select a plan. When I try to pay, it says "Error submitting form", even when I choose downgrade to Free it gives the same error
Is it possible to place two images side by side?
I'm writing some documentation for a mobile application, for this i use a lot of mobile screenshot, which don't really work in the standard layout as they will take up the entire screen. Is there any way to place two images side by side?
What happened to all the old questions?
Hi
Discussion API
Is there a way to post questions to the community discussions forum via the readme api?
How do user navigate to custom page?
After I create several custom pages, how can I create effective navigation so that readers can read through all the custom pages?