diff --git a/packages/ir-sdk/fern/apis/ir-types-latest/definition/ir.yml b/packages/ir-sdk/fern/apis/ir-types-latest/definition/ir.yml index 6a7784158cc..fe9bbf0130e 100644 --- a/packages/ir-sdk/fern/apis/ir-types-latest/definition/ir.yml +++ b/packages/ir-sdk/fern/apis/ir-types-latest/definition/ir.yml @@ -15,6 +15,7 @@ types: IntermediateRepresentation: docs: "Complete representation of the API schema" properties: + apiVersion: optional apiName: type: commons.Name docs: This is the human readable unique id for the API. @@ -82,6 +83,22 @@ types: language: string sdkName: string sdkVersion: string + ApiVersionScheme: + docs: | + The available set of versions for the API. This is used to generate a special + enum that can be used to specify the version of the API to use. + union: + header: HeaderApiVersionScheme + HeaderApiVersionScheme: + docs: | + The version information is sent as an HTTP header (e.g. X-API-Version) on every request. + + If the enum does _not_ define a default value, the version should be treated like + a required global header parameter. The version header should also support any + environment variable scanning specified by the header. + properties: + header: http.HttpHeader + value: types.EnumTypeDeclaration ErrorDiscriminationStrategy: union: statusCode: {} diff --git a/packages/ir-sdk/fern/apis/ir-types-latest/definition/types.yml b/packages/ir-sdk/fern/apis/ir-types-latest/definition/types.yml index c6e47fc8842..9a3df57a8ff 100644 --- a/packages/ir-sdk/fern/apis/ir-types-latest/definition/types.yml +++ b/packages/ir-sdk/fern/apis/ir-types-latest/definition/types.yml @@ -62,6 +62,7 @@ types: EnumTypeDeclaration: properties: + default: optional values: list EnumValue: extends: commons.Declaration