Discussions

Ask a Question

Deleting a version

Hi Community,

Api deprecation

I want to deprecate particular api end point and make it visible to customer that this endpoint is depreciated. How to do that?

Support for date-based API versions

I know that ReadMe is semver-ish with the supported versions, but this is posing a problem for us when we want to create a date-based version. We have a version 2022-09 that is not accepted by semver. Are there any suggestions for what we can do?

API Conventions for /api-specification

GET /api-specification returns a collection instead of single api and there is no GET /api-specification/{id} call. I would expect an /api-specifications endpoint to exist and return a collection

Try It feature in the API reference

The c# code generator outputs code that contains the line

Using the ReadMe Explorer for Private APIs

Hi,

Link validation

Is there a link validation tool availble in Readme?

Updating API specification doesn't work

I am doing a PUT request, tried both with a JSON and YAML, I'm getting a 503 error.
The tried specifications are valid.

Slow loading endpoints

Hello there.

Sharing content in a toc

Is it possible to share a topic in more than one node (ie have it as sub page in more than one location)?
OR
Is it possible to embed shared content in to a page so that we have one source of truth for identical content blocks?