Discussions

Ask a Question

API Validation - should match against

I got the following error validating my API: ``` Validation failed. /components/schemas/WebhookPayload<WebhookQuoteCarriersQualified> has an invalid name. Component names should match against: /^[a-zA-Z0-9.-_]+$/ ``` The thing is, it does match. I tried this on regex101.com and it matches for every "flavor" that they offer: PCRE, PCRE2, ECMAScript, Python, Golang, Java 8, and .NET. My best guess is that it doesn't like the \<> characters, but again, the regex produces a match. What's going on here?

Projects in Custom global landing page

Hi, I am trying to build my own global landing page and hence I want to understand parentProject and childProject structure. Can you please share a link where the Keys of the above objects and its structure is documented?

Making a redirect take effect?

What more needs to be done to make a redirect take effect, beyond deploying the updated group redirect list? (I am using the Enterprise version, so we have a group.) I ask because the "source" page is still loaded if I use the original URL, even in an incognito/private window, which shouldn't have anything cached. Do I need to delete the original page?

Chrome left side navigation missing

Recently, when using Chrome, the left had side navigation is missing all the information that was there. the left side slide out but is blank. Any hints on to debug this or get the links back?

How to add NodeJS code examples

Trying to add NodeJS code examples, and there are no option. So had to select JS as type. But in that way, I'm not being able to write any instruction on how to install the package. Same for Python, Java and other languages. There should be way to explicitly say, how the dev is going to include/install the package into their system. Please let me know, if there is any way to do this, that I might have missed or any wayaround. Thanks in advance, even if there is no way to do so, please do let me know any ideas on how to solve this issue with existing system.

Auto generated code examples along with given examples code in suggestion

If any code example is added then the auto generated codes are grouped under the three dots (more option). So if I want to keep both auto generated and the my own custom code examples in the plain sight and not buried under the three dots then what should be done, if there is any way. Thanks in advance.

Deleting a version

Hi Community, The delete version documentation is a little thin, so I'd like to check with the community about deleting a trial version. I created a new readme version forked from our current master version as a test. I no longer need that forked test version, and it has never been marked as master/main, public, or the like. Is it safe to just use the delete version operation for my trial version if I no longer need it? Is there any impact to the version/base that this was forked from? Thanks and best regards, Barb

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 Would ReadMe be open to adopting the following? **GET /api-specifications** **POST /api-specification** **GET /api-specification/{id}** **DELETE/api-specification/{id}** **PUT /api-specification/{id}** Ref Google's api design guide <https://cloud.google.com/apis/design/>