redocly-cli icon indicating copy to clipboard operation
redocly-cli copied to clipboard

Update per-API settings

Open lornajane opened this issue 1 year ago • 4 comments

The upcoming products support different per-API configuration than Workflows did, so we need to update this page: https://redocly.com/docs/cli/configuration/apis

lornajane avatar Aug 09 '24 15:08 lornajane

Note that the apis section is also missing documentation that extends can also be supported here (I had no idea! This is very useful!). We should include that in the per-apis documentation section and include some examples of using built-in and self-configured rulesets. There are also some useful templates in #1691 , if that has merged before this work is undertaken.

lornajane avatar Oct 29 '24 14:10 lornajane

@tatomyr did this make it into the pitch? is this done? can we close it?

adamaltman avatar May 12 '25 01:05 adamaltman

Are there really different per API settings? I guess that's the "openapi" config option? @tatomyr do you know about it?

adamaltman avatar May 20 '25 16:05 adamaltman

@adamaltman it was a part of the CLI 2.0 pitch, but we only partially covered it (we removed the labels option in v2). I expect the apis behaviour will change (at least I'm going to stop adding the @latest version to api names by default, so I'd keep it open until it's done.

Are there really different per API settings? I guess that's the "openapi" config option

I think the openapi section is the same as in the root config. However, the apis section can additionally contain root and output, and cannot contain plugins.

tatomyr avatar May 21 '25 07:05 tatomyr