@tsed/openspec 6.107.0 → 6.107.3
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/lib/cjs/openspec2/OS2Header.js.map +1 -1
- package/lib/cjs/openspec2/OS2Operation.js.map +1 -1
- package/lib/cjs/openspec2/OS2Parameter.js.map +1 -1
- package/lib/cjs/openspec2/OS2Paths.js.map +1 -1
- package/lib/cjs/openspec2/OS2Response.js.map +1 -1
- package/lib/cjs/openspec2/OS2Schema.js.map +1 -1
- package/lib/cjs/openspec2/OS2Security.js.map +1 -1
- package/lib/esm/openspec2/OS2Header.js.map +1 -1
- package/lib/esm/openspec2/OS2Operation.js.map +1 -1
- package/lib/esm/openspec2/OS2Parameter.js.map +1 -1
- package/lib/esm/openspec2/OS2Paths.js.map +1 -1
- package/lib/esm/openspec2/OS2Response.js.map +1 -1
- package/lib/esm/openspec2/OS2Schema.js.map +1 -1
- package/lib/esm/openspec2/OS2Security.js.map +1 -1
- package/lib/types/openspec2/OS2Header.d.ts +0 -3
- package/lib/types/openspec2/OS2Operation.d.ts +0 -3
- package/lib/types/openspec2/OS2Parameter.d.ts +0 -42
- package/lib/types/openspec2/OS2Paths.d.ts +0 -3
- package/lib/types/openspec2/OS2Response.d.ts +0 -3
- package/lib/types/openspec2/OS2Schema.d.ts +0 -9
- package/lib/types/openspec2/OS2Security.d.ts +0 -27
- package/package.json +1 -1
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"OS2Header.js","sourceRoot":"","sources":["../../../src/openspec2/OS2Header.ts"],"names":[],"mappings":"","sourcesContent":["import {OS2BaseSchema} from \"./OS2Schema\";\n\
|
|
1
|
+
{"version":3,"file":"OS2Header.js","sourceRoot":"","sources":["../../../src/openspec2/OS2Header.ts"],"names":[],"mappings":"","sourcesContent":["import {OS2BaseSchema} from \"./OS2Schema\";\n\nexport interface OS2Header extends OS2BaseSchema {\n /**\n * The type of the object. The value MUST be one of `string`, `number`, `integer`, `boolean`, or `array`.\n */\n type: \"string\" | \"number\" | \"integer\" | \"boolean\" | \"array\";\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"OS2Operation.js","sourceRoot":"","sources":["../../../src/openspec2/OS2Operation.ts"],"names":[],"mappings":"","sourcesContent":["import {OpenSpecExternalDocs} from \"../common/OpenSpecExternalDocs\";\nimport {OpenSpecHash} from \"../common/OpenSpecHash\";\nimport {OpenSpecRef} from \"../common/OpenSpecRef\";\nimport {OpenSpecSecurity} from \"../common/OpenSpecSecurity\";\nimport {OS2Parameter} from \"./OS2Parameter\";\nimport {OS2Response} from \"./OS2Response\";\n\
|
|
1
|
+
{"version":3,"file":"OS2Operation.js","sourceRoot":"","sources":["../../../src/openspec2/OS2Operation.ts"],"names":[],"mappings":"","sourcesContent":["import {OpenSpecExternalDocs} from \"../common/OpenSpecExternalDocs\";\nimport {OpenSpecHash} from \"../common/OpenSpecHash\";\nimport {OpenSpecRef} from \"../common/OpenSpecRef\";\nimport {OpenSpecSecurity} from \"../common/OpenSpecSecurity\";\nimport {OS2Parameter} from \"./OS2Parameter\";\nimport {OS2Response} from \"./OS2Response\";\n\nexport interface OS2Operation {\n /**\n * A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.\n */\n tags?: string[];\n /**\n * A short summary of what the operation does. For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters.\n */\n summary?: string;\n /**\n * A verbose explanation of the operation behavior. GFM syntax can be used for rich text representation.\n */\n description?: string;\n /**\n * Additional external documentation for this operation.\n */\n externalDocs?: OpenSpecExternalDocs;\n /**\n * Unique string used to identify the operation. The id MUST be unique among all operations described in the API. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is recommended to follow common programming naming conventions.\n */\n operationId?: string;\n /**\n * A list of MIME types the operation can consume. This overrides the consumes definition at the Swagger Object. An empty value MAY be used to clear the global definition. Value MUST be as described under [Mime Types](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#mimeTypes).\n */\n consumes?: string[];\n /**\n * A list of MIME types the operation can produce. This overrides the produces definition at the Swagger Object. An empty value MAY be used to clear the global definition. Value MUST be as described under [Mime Types](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#mimeTypes).\n */\n produces?: string[];\n /**\n * A list of parameters that are applicable for this operation.\n * If a parameter is already defined at the [Path Item](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#pathItemParameters),\n * the new definition will override it, but can never remove it. The list MUST NOT include duplicated parameters.\n * A unique parameter is defined by a combination of a [name](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#parameterName) and (location)[https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#parameterIn].\n * The list can use the [Reference Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#referenceObject) to link to parameters that are defined at the [Swagger Object's parameters](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#swaggerParameters).\n * There can be one \"body\" parameter at most.\n */\n parameters?: (OS2Parameter | OpenSpecRef)[];\n /**\n * The list of possible responses as they are returned from executing this operation.\n */\n responses: OpenSpecHash<OS2Response | OpenSpecRef>;\n /**\n * The transfer protocol of the API. Values MUST be from the list: `http`, `https`, `ws`, `wss`. If the schemes is not included, the default scheme to be used is the one used to access the Swagger definition itself.\n */\n schemes?: string[];\n /**\n * Declares this operation to be deprecated. Usage of the declared operation should be refrained. Default value is false.\n */\n deprecated?: boolean;\n /**\n * A declaration of which security schemes are applied for this operation.\n * The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements).\n * This definition overrides any declared top-level [security](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#swaggerSecurity).\n * To remove a top-level security declaration, an empty array can be used.\n */\n security?: OpenSpecSecurity;\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"OS2Parameter.js","sourceRoot":"","sources":["../../../src/openspec2/OS2Parameter.ts"],"names":[],"mappings":"","sourcesContent":["import {OpenSpecTypes} from \"../common/OpenSpecTypes\";\nimport {OS2BaseSchema, OS2Schema} from \"./OS2Schema\";\n\
|
|
1
|
+
{"version":3,"file":"OS2Parameter.js","sourceRoot":"","sources":["../../../src/openspec2/OS2Parameter.ts"],"names":[],"mappings":"","sourcesContent":["import {OpenSpecTypes} from \"../common/OpenSpecTypes\";\nimport {OS2BaseSchema, OS2Schema} from \"./OS2Schema\";\n\nexport type OS2BaseParameter = {\n name: string;\n in: \"body\" | \"query\" | \"path\" | \"header\" | \"formData\";\n required?: boolean;\n description?: string;\n};\n\nexport type OS2BodyParameter = OS2BaseParameter & {\n in: \"body\";\n schema?: OS2Schema;\n};\n\nexport type OS2GenericFormat = {\n type?: OpenSpecTypes;\n format?: string;\n};\n\nexport type OS2IntegerFormat = {\n type: \"integer\";\n format?: \"int32\" | \"int64\";\n};\n\nexport type OS2NumberFormat = {\n type: \"number\";\n format?: \"float\" | \"double\";\n};\n\nexport type OS2StringFormat = {\n type: \"string\";\n format?: \"\" | \"byte\" | \"binary\" | \"date\" | \"date-time\" | \"password\";\n};\n\nexport type OS2SchemaFormatConstraints = OS2GenericFormat | OS2IntegerFormat | OS2NumberFormat | OS2StringFormat;\nexport type OS2BaseFormatContrainedParameter = OS2BaseParameter & OS2SchemaFormatConstraints;\nexport type ParameterCollectionFormat = \"csv\" | \"ssv\" | \"tsv\" | \"pipes\" | \"multi\";\nexport type OS2QueryParameter = OS2BaseFormatContrainedParameter &\n OS2BaseSchema & {\n in: \"query\";\n allowEmptyValue?: boolean;\n collectionFormat?: ParameterCollectionFormat;\n };\n\nexport type OS2PathParameter = OS2BaseFormatContrainedParameter &\n OS2BaseSchema & {\n in: \"path\";\n required: true;\n };\n\nexport type OS2HeaderParameter = OS2BaseFormatContrainedParameter &\n OS2BaseSchema & {\n in: \"header\";\n };\n\nexport type OS2FormDataParameter = OS2BaseFormatContrainedParameter &\n OS2BaseSchema & {\n in: \"formData\";\n type: OpenSpecTypes;\n allowEmptyValue?: boolean;\n collectionFormat?: ParameterCollectionFormat;\n };\n\nexport type OS2Parameter = OS2BodyParameter | OS2FormDataParameter | OS2QueryParameter | OS2PathParameter | OS2HeaderParameter;\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"OS2Paths.js","sourceRoot":"","sources":["../../../src/openspec2/OS2Paths.ts"],"names":[],"mappings":"","sourcesContent":["import {OpenSpecPath} from \"../common/OpenSpecPath\";\nimport {OpenSpecRef} from \"../common/OpenSpecRef\";\nimport {OS2Operation} from \"./OS2Operation\";\nimport {OS2Parameter} from \"./OS2Parameter\";\n\
|
|
1
|
+
{"version":3,"file":"OS2Paths.js","sourceRoot":"","sources":["../../../src/openspec2/OS2Paths.ts"],"names":[],"mappings":"","sourcesContent":["import {OpenSpecPath} from \"../common/OpenSpecPath\";\nimport {OpenSpecRef} from \"../common/OpenSpecRef\";\nimport {OS2Operation} from \"./OS2Operation\";\nimport {OS2Parameter} from \"./OS2Parameter\";\n\nexport interface OS2Paths extends OpenSpecPath<OS2Operation> {\n parameters?: (OS2Parameter | OpenSpecRef)[];\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"OS2Response.js","sourceRoot":"","sources":["../../../src/openspec2/OS2Response.ts"],"names":[],"mappings":"","sourcesContent":["import {OpenSpecHash} from \"../common/OpenSpecHash\";\nimport {OS2Header} from \"./OS2Header\";\nimport {OS2Schema} from \"./OS2Schema\";\n\
|
|
1
|
+
{"version":3,"file":"OS2Response.js","sourceRoot":"","sources":["../../../src/openspec2/OS2Response.ts"],"names":[],"mappings":"","sourcesContent":["import {OpenSpecHash} from \"../common/OpenSpecHash\";\nimport {OS2Header} from \"./OS2Header\";\nimport {OS2Schema} from \"./OS2Schema\";\n\nexport interface OS2Response {\n /**\n * A short description of the response. GFM syntax can be used for rich text representation.\n */\n description: string;\n /**\n * A definition of the response structure. It can be a primitive, an array or an object. If this field does not exist, it means no content is returned as part of the response. As an extension to the Schema Object, its root type value may also be \"file\". This SHOULD be accompanied by a relevant produces mime-type.\n */\n schema?: OS2Schema;\n /**\n * A list of headers that are sent with the response.\n */\n headers?: OpenSpecHash<OS2Header>;\n /**\n * An example of the response message.\n */\n examples?: OpenSpecHash<{}>;\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"OS2Schema.js","sourceRoot":"","sources":["../../../src/openspec2/OS2Schema.ts"],"names":[],"mappings":"","sourcesContent":["import {OpenSpecExternalDocs} from \"../common/OpenSpecExternalDocs\";\nimport {OpenSpecBaseJsonSchema, OpenSpecJsonSchema} from \"../common/OpenSpecJsonSchema\";\nimport {OpenSpecRef} from \"../common/OpenSpecRef\";\nimport {OpenSpecXML} from \"../common/OpenSpecXML\";\n
|
|
1
|
+
{"version":3,"file":"OS2Schema.js","sourceRoot":"","sources":["../../../src/openspec2/OS2Schema.ts"],"names":[],"mappings":"","sourcesContent":["import {OpenSpecExternalDocs} from \"../common/OpenSpecExternalDocs\";\nimport {OpenSpecBaseJsonSchema, OpenSpecJsonSchema} from \"../common/OpenSpecJsonSchema\";\nimport {OpenSpecRef} from \"../common/OpenSpecRef\";\nimport {OpenSpecXML} from \"../common/OpenSpecXML\";\n\nexport interface OS2XML {\n name?: string;\n namespace?: string;\n prefix?: string;\n attribute?: boolean;\n wrapped?: boolean;\n}\n\nexport interface OS2BaseSchema extends OpenSpecBaseJsonSchema {\n /**\n * Required if type is \"array\". Describes the type of items in the array.\n */\n items?: OS2Schema | OpenSpecRef;\n}\n\nexport interface OS2Schema extends OpenSpecJsonSchema<OS2Schema> {\n /**\n * Adds support for polymorphism.\n * The discriminator is the schema property name that is used to differentiate between other schema that inherit this schema. The property name used MUST be defined at this schema and it MUST be in the required property list. When used, the value MUST be the name of this schema or any schema that inherits it.\n */\n discriminator?: string;\n /**\n * Relevant only for Schema \"properties\" definitions. Declares the property as \"read only\". This means that it MAY be sent as part of a response but MUST NOT be sent as part of the request. Properties marked as readOnly being true SHOULD NOT be in the required list of the defined schema. Default value is false.\n */\n readOnly?: boolean;\n /**\n * This MAY be used only on properties schemas. It has no effect on root schemas. Adds Additional metadata to describe the XML representation format of this property.\n */\n xml?: OpenSpecXML;\n /**\n * Additional external documentation for this schema.\n */\n externalDocs?: OpenSpecExternalDocs;\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"OS2Security.js","sourceRoot":"","sources":["../../../src/openspec2/OS2Security.ts"],"names":[],"mappings":"","sourcesContent":["import {OpenSpecHash} from \"../common/OpenSpecHash\";\n\
|
|
1
|
+
{"version":3,"file":"OS2Security.js","sourceRoot":"","sources":["../../../src/openspec2/OS2Security.ts"],"names":[],"mappings":"","sourcesContent":["import {OpenSpecHash} from \"../common/OpenSpecHash\";\n\nexport interface OS2SecurityBase {\n /**\n * The type of the security scheme\n */\n type: \"basic\" | \"apiKey\" | \"oauth2\";\n /**\n *\n */\n description?: string;\n}\n\nexport interface OS2SecurityBasic extends OS2SecurityBase {\n type: \"basic\";\n}\n\nexport interface OS2SecurityApiKey extends OS2SecurityBase {\n type: \"apiKey\";\n name: string;\n in: \"query\" | \"header\";\n}\n\nexport interface OS2SecurityOAuth extends OS2SecurityBase {\n type: \"oauth2\";\n flow: \"accessCode\" | \"application\" | \"implicit\" | \"password\";\n /**\n * The available scopes for the OAuth2 security scheme.\n */\n scopes: OpenSpecHash<string>;\n}\n\nexport interface OS2FlowImplicit extends OS2SecurityOAuth {\n type: \"oauth2\";\n flow: \"implicit\";\n authorizationUrl: string;\n}\n\nexport interface OS2FlowPassword extends OS2SecurityOAuth {\n type: \"oauth2\";\n flow: \"password\";\n tokenUrl: string;\n}\n\nexport interface OS2FlowApplication extends OS2SecurityOAuth {\n type: \"oauth2\";\n flow: \"application\";\n tokenUrl: string;\n}\n\nexport interface OS2FlowAccessCode extends OS2SecurityOAuth {\n type: \"oauth2\";\n flow: \"accessCode\";\n tokenUrl: string;\n authorizationUrl: string;\n}\n\nexport type OS2Security = OS2SecurityBasic | OS2FlowAccessCode | OS2FlowApplication | OS2FlowImplicit | OS2FlowPassword | OS2SecurityApiKey;\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"OS2Header.js","sourceRoot":"","sources":["../../../src/openspec2/OS2Header.ts"],"names":[],"mappings":"","sourcesContent":["import {OS2BaseSchema} from \"./OS2Schema\";\n\
|
|
1
|
+
{"version":3,"file":"OS2Header.js","sourceRoot":"","sources":["../../../src/openspec2/OS2Header.ts"],"names":[],"mappings":"","sourcesContent":["import {OS2BaseSchema} from \"./OS2Schema\";\n\nexport interface OS2Header extends OS2BaseSchema {\n /**\n * The type of the object. The value MUST be one of `string`, `number`, `integer`, `boolean`, or `array`.\n */\n type: \"string\" | \"number\" | \"integer\" | \"boolean\" | \"array\";\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"OS2Operation.js","sourceRoot":"","sources":["../../../src/openspec2/OS2Operation.ts"],"names":[],"mappings":"","sourcesContent":["import {OpenSpecExternalDocs} from \"../common/OpenSpecExternalDocs\";\nimport {OpenSpecHash} from \"../common/OpenSpecHash\";\nimport {OpenSpecRef} from \"../common/OpenSpecRef\";\nimport {OpenSpecSecurity} from \"../common/OpenSpecSecurity\";\nimport {OS2Parameter} from \"./OS2Parameter\";\nimport {OS2Response} from \"./OS2Response\";\n\
|
|
1
|
+
{"version":3,"file":"OS2Operation.js","sourceRoot":"","sources":["../../../src/openspec2/OS2Operation.ts"],"names":[],"mappings":"","sourcesContent":["import {OpenSpecExternalDocs} from \"../common/OpenSpecExternalDocs\";\nimport {OpenSpecHash} from \"../common/OpenSpecHash\";\nimport {OpenSpecRef} from \"../common/OpenSpecRef\";\nimport {OpenSpecSecurity} from \"../common/OpenSpecSecurity\";\nimport {OS2Parameter} from \"./OS2Parameter\";\nimport {OS2Response} from \"./OS2Response\";\n\nexport interface OS2Operation {\n /**\n * A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.\n */\n tags?: string[];\n /**\n * A short summary of what the operation does. For maximum readability in the swagger-ui, this field SHOULD be less than 120 characters.\n */\n summary?: string;\n /**\n * A verbose explanation of the operation behavior. GFM syntax can be used for rich text representation.\n */\n description?: string;\n /**\n * Additional external documentation for this operation.\n */\n externalDocs?: OpenSpecExternalDocs;\n /**\n * Unique string used to identify the operation. The id MUST be unique among all operations described in the API. Tools and libraries MAY use the operationId to uniquely identify an operation, therefore, it is recommended to follow common programming naming conventions.\n */\n operationId?: string;\n /**\n * A list of MIME types the operation can consume. This overrides the consumes definition at the Swagger Object. An empty value MAY be used to clear the global definition. Value MUST be as described under [Mime Types](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#mimeTypes).\n */\n consumes?: string[];\n /**\n * A list of MIME types the operation can produce. This overrides the produces definition at the Swagger Object. An empty value MAY be used to clear the global definition. Value MUST be as described under [Mime Types](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#mimeTypes).\n */\n produces?: string[];\n /**\n * A list of parameters that are applicable for this operation.\n * If a parameter is already defined at the [Path Item](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#pathItemParameters),\n * the new definition will override it, but can never remove it. The list MUST NOT include duplicated parameters.\n * A unique parameter is defined by a combination of a [name](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#parameterName) and (location)[https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#parameterIn].\n * The list can use the [Reference Object](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#referenceObject) to link to parameters that are defined at the [Swagger Object's parameters](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#swaggerParameters).\n * There can be one \"body\" parameter at most.\n */\n parameters?: (OS2Parameter | OpenSpecRef)[];\n /**\n * The list of possible responses as they are returned from executing this operation.\n */\n responses: OpenSpecHash<OS2Response | OpenSpecRef>;\n /**\n * The transfer protocol of the API. Values MUST be from the list: `http`, `https`, `ws`, `wss`. If the schemes is not included, the default scheme to be used is the one used to access the Swagger definition itself.\n */\n schemes?: string[];\n /**\n * Declares this operation to be deprecated. Usage of the declared operation should be refrained. Default value is false.\n */\n deprecated?: boolean;\n /**\n * A declaration of which security schemes are applied for this operation.\n * The list of values describes alternative security schemes that can be used (that is, there is a logical OR between the security requirements).\n * This definition overrides any declared top-level [security](https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#swaggerSecurity).\n * To remove a top-level security declaration, an empty array can be used.\n */\n security?: OpenSpecSecurity;\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"OS2Parameter.js","sourceRoot":"","sources":["../../../src/openspec2/OS2Parameter.ts"],"names":[],"mappings":"","sourcesContent":["import {OpenSpecTypes} from \"../common/OpenSpecTypes\";\nimport {OS2BaseSchema, OS2Schema} from \"./OS2Schema\";\n\
|
|
1
|
+
{"version":3,"file":"OS2Parameter.js","sourceRoot":"","sources":["../../../src/openspec2/OS2Parameter.ts"],"names":[],"mappings":"","sourcesContent":["import {OpenSpecTypes} from \"../common/OpenSpecTypes\";\nimport {OS2BaseSchema, OS2Schema} from \"./OS2Schema\";\n\nexport type OS2BaseParameter = {\n name: string;\n in: \"body\" | \"query\" | \"path\" | \"header\" | \"formData\";\n required?: boolean;\n description?: string;\n};\n\nexport type OS2BodyParameter = OS2BaseParameter & {\n in: \"body\";\n schema?: OS2Schema;\n};\n\nexport type OS2GenericFormat = {\n type?: OpenSpecTypes;\n format?: string;\n};\n\nexport type OS2IntegerFormat = {\n type: \"integer\";\n format?: \"int32\" | \"int64\";\n};\n\nexport type OS2NumberFormat = {\n type: \"number\";\n format?: \"float\" | \"double\";\n};\n\nexport type OS2StringFormat = {\n type: \"string\";\n format?: \"\" | \"byte\" | \"binary\" | \"date\" | \"date-time\" | \"password\";\n};\n\nexport type OS2SchemaFormatConstraints = OS2GenericFormat | OS2IntegerFormat | OS2NumberFormat | OS2StringFormat;\nexport type OS2BaseFormatContrainedParameter = OS2BaseParameter & OS2SchemaFormatConstraints;\nexport type ParameterCollectionFormat = \"csv\" | \"ssv\" | \"tsv\" | \"pipes\" | \"multi\";\nexport type OS2QueryParameter = OS2BaseFormatContrainedParameter &\n OS2BaseSchema & {\n in: \"query\";\n allowEmptyValue?: boolean;\n collectionFormat?: ParameterCollectionFormat;\n };\n\nexport type OS2PathParameter = OS2BaseFormatContrainedParameter &\n OS2BaseSchema & {\n in: \"path\";\n required: true;\n };\n\nexport type OS2HeaderParameter = OS2BaseFormatContrainedParameter &\n OS2BaseSchema & {\n in: \"header\";\n };\n\nexport type OS2FormDataParameter = OS2BaseFormatContrainedParameter &\n OS2BaseSchema & {\n in: \"formData\";\n type: OpenSpecTypes;\n allowEmptyValue?: boolean;\n collectionFormat?: ParameterCollectionFormat;\n };\n\nexport type OS2Parameter = OS2BodyParameter | OS2FormDataParameter | OS2QueryParameter | OS2PathParameter | OS2HeaderParameter;\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"OS2Paths.js","sourceRoot":"","sources":["../../../src/openspec2/OS2Paths.ts"],"names":[],"mappings":"","sourcesContent":["import {OpenSpecPath} from \"../common/OpenSpecPath\";\nimport {OpenSpecRef} from \"../common/OpenSpecRef\";\nimport {OS2Operation} from \"./OS2Operation\";\nimport {OS2Parameter} from \"./OS2Parameter\";\n\
|
|
1
|
+
{"version":3,"file":"OS2Paths.js","sourceRoot":"","sources":["../../../src/openspec2/OS2Paths.ts"],"names":[],"mappings":"","sourcesContent":["import {OpenSpecPath} from \"../common/OpenSpecPath\";\nimport {OpenSpecRef} from \"../common/OpenSpecRef\";\nimport {OS2Operation} from \"./OS2Operation\";\nimport {OS2Parameter} from \"./OS2Parameter\";\n\nexport interface OS2Paths extends OpenSpecPath<OS2Operation> {\n parameters?: (OS2Parameter | OpenSpecRef)[];\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"OS2Response.js","sourceRoot":"","sources":["../../../src/openspec2/OS2Response.ts"],"names":[],"mappings":"","sourcesContent":["import {OpenSpecHash} from \"../common/OpenSpecHash\";\nimport {OS2Header} from \"./OS2Header\";\nimport {OS2Schema} from \"./OS2Schema\";\n\
|
|
1
|
+
{"version":3,"file":"OS2Response.js","sourceRoot":"","sources":["../../../src/openspec2/OS2Response.ts"],"names":[],"mappings":"","sourcesContent":["import {OpenSpecHash} from \"../common/OpenSpecHash\";\nimport {OS2Header} from \"./OS2Header\";\nimport {OS2Schema} from \"./OS2Schema\";\n\nexport interface OS2Response {\n /**\n * A short description of the response. GFM syntax can be used for rich text representation.\n */\n description: string;\n /**\n * A definition of the response structure. It can be a primitive, an array or an object. If this field does not exist, it means no content is returned as part of the response. As an extension to the Schema Object, its root type value may also be \"file\". This SHOULD be accompanied by a relevant produces mime-type.\n */\n schema?: OS2Schema;\n /**\n * A list of headers that are sent with the response.\n */\n headers?: OpenSpecHash<OS2Header>;\n /**\n * An example of the response message.\n */\n examples?: OpenSpecHash<{}>;\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"OS2Schema.js","sourceRoot":"","sources":["../../../src/openspec2/OS2Schema.ts"],"names":[],"mappings":"","sourcesContent":["import {OpenSpecExternalDocs} from \"../common/OpenSpecExternalDocs\";\nimport {OpenSpecBaseJsonSchema, OpenSpecJsonSchema} from \"../common/OpenSpecJsonSchema\";\nimport {OpenSpecRef} from \"../common/OpenSpecRef\";\nimport {OpenSpecXML} from \"../common/OpenSpecXML\";\n
|
|
1
|
+
{"version":3,"file":"OS2Schema.js","sourceRoot":"","sources":["../../../src/openspec2/OS2Schema.ts"],"names":[],"mappings":"","sourcesContent":["import {OpenSpecExternalDocs} from \"../common/OpenSpecExternalDocs\";\nimport {OpenSpecBaseJsonSchema, OpenSpecJsonSchema} from \"../common/OpenSpecJsonSchema\";\nimport {OpenSpecRef} from \"../common/OpenSpecRef\";\nimport {OpenSpecXML} from \"../common/OpenSpecXML\";\n\nexport interface OS2XML {\n name?: string;\n namespace?: string;\n prefix?: string;\n attribute?: boolean;\n wrapped?: boolean;\n}\n\nexport interface OS2BaseSchema extends OpenSpecBaseJsonSchema {\n /**\n * Required if type is \"array\". Describes the type of items in the array.\n */\n items?: OS2Schema | OpenSpecRef;\n}\n\nexport interface OS2Schema extends OpenSpecJsonSchema<OS2Schema> {\n /**\n * Adds support for polymorphism.\n * The discriminator is the schema property name that is used to differentiate between other schema that inherit this schema. The property name used MUST be defined at this schema and it MUST be in the required property list. When used, the value MUST be the name of this schema or any schema that inherits it.\n */\n discriminator?: string;\n /**\n * Relevant only for Schema \"properties\" definitions. Declares the property as \"read only\". This means that it MAY be sent as part of a response but MUST NOT be sent as part of the request. Properties marked as readOnly being true SHOULD NOT be in the required list of the defined schema. Default value is false.\n */\n readOnly?: boolean;\n /**\n * This MAY be used only on properties schemas. It has no effect on root schemas. Adds Additional metadata to describe the XML representation format of this property.\n */\n xml?: OpenSpecXML;\n /**\n * Additional external documentation for this schema.\n */\n externalDocs?: OpenSpecExternalDocs;\n}\n"]}
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"OS2Security.js","sourceRoot":"","sources":["../../../src/openspec2/OS2Security.ts"],"names":[],"mappings":"","sourcesContent":["import {OpenSpecHash} from \"../common/OpenSpecHash\";\n\
|
|
1
|
+
{"version":3,"file":"OS2Security.js","sourceRoot":"","sources":["../../../src/openspec2/OS2Security.ts"],"names":[],"mappings":"","sourcesContent":["import {OpenSpecHash} from \"../common/OpenSpecHash\";\n\nexport interface OS2SecurityBase {\n /**\n * The type of the security scheme\n */\n type: \"basic\" | \"apiKey\" | \"oauth2\";\n /**\n *\n */\n description?: string;\n}\n\nexport interface OS2SecurityBasic extends OS2SecurityBase {\n type: \"basic\";\n}\n\nexport interface OS2SecurityApiKey extends OS2SecurityBase {\n type: \"apiKey\";\n name: string;\n in: \"query\" | \"header\";\n}\n\nexport interface OS2SecurityOAuth extends OS2SecurityBase {\n type: \"oauth2\";\n flow: \"accessCode\" | \"application\" | \"implicit\" | \"password\";\n /**\n * The available scopes for the OAuth2 security scheme.\n */\n scopes: OpenSpecHash<string>;\n}\n\nexport interface OS2FlowImplicit extends OS2SecurityOAuth {\n type: \"oauth2\";\n flow: \"implicit\";\n authorizationUrl: string;\n}\n\nexport interface OS2FlowPassword extends OS2SecurityOAuth {\n type: \"oauth2\";\n flow: \"password\";\n tokenUrl: string;\n}\n\nexport interface OS2FlowApplication extends OS2SecurityOAuth {\n type: \"oauth2\";\n flow: \"application\";\n tokenUrl: string;\n}\n\nexport interface OS2FlowAccessCode extends OS2SecurityOAuth {\n type: \"oauth2\";\n flow: \"accessCode\";\n tokenUrl: string;\n authorizationUrl: string;\n}\n\nexport type OS2Security = OS2SecurityBasic | OS2FlowAccessCode | OS2FlowApplication | OS2FlowImplicit | OS2FlowPassword | OS2SecurityApiKey;\n"]}
|
|
@@ -4,9 +4,6 @@ import { OpenSpecRef } from "../common/OpenSpecRef";
|
|
|
4
4
|
import { OpenSpecSecurity } from "../common/OpenSpecSecurity";
|
|
5
5
|
import { OS2Parameter } from "./OS2Parameter";
|
|
6
6
|
import { OS2Response } from "./OS2Response";
|
|
7
|
-
/**
|
|
8
|
-
* @deprecated
|
|
9
|
-
*/
|
|
10
7
|
export interface OS2Operation {
|
|
11
8
|
/**
|
|
12
9
|
* A list of tags for API documentation control. Tags can be used for logical grouping of operations by resources or any other qualifier.
|
|
@@ -1,92 +1,50 @@
|
|
|
1
1
|
import { OpenSpecTypes } from "../common/OpenSpecTypes";
|
|
2
2
|
import { OS2BaseSchema, OS2Schema } from "./OS2Schema";
|
|
3
|
-
/**
|
|
4
|
-
* @deprecated
|
|
5
|
-
*/
|
|
6
3
|
export declare type OS2BaseParameter = {
|
|
7
4
|
name: string;
|
|
8
5
|
in: "body" | "query" | "path" | "header" | "formData";
|
|
9
6
|
required?: boolean;
|
|
10
7
|
description?: string;
|
|
11
8
|
};
|
|
12
|
-
/**
|
|
13
|
-
* @deprecated
|
|
14
|
-
*/
|
|
15
9
|
export declare type OS2BodyParameter = OS2BaseParameter & {
|
|
16
10
|
in: "body";
|
|
17
11
|
schema?: OS2Schema;
|
|
18
12
|
};
|
|
19
|
-
/**
|
|
20
|
-
* @deprecated
|
|
21
|
-
*/
|
|
22
13
|
export declare type OS2GenericFormat = {
|
|
23
14
|
type?: OpenSpecTypes;
|
|
24
15
|
format?: string;
|
|
25
16
|
};
|
|
26
|
-
/**
|
|
27
|
-
* @deprecated
|
|
28
|
-
*/
|
|
29
17
|
export declare type OS2IntegerFormat = {
|
|
30
18
|
type: "integer";
|
|
31
19
|
format?: "int32" | "int64";
|
|
32
20
|
};
|
|
33
|
-
/**
|
|
34
|
-
* @deprecated
|
|
35
|
-
*/
|
|
36
21
|
export declare type OS2NumberFormat = {
|
|
37
22
|
type: "number";
|
|
38
23
|
format?: "float" | "double";
|
|
39
24
|
};
|
|
40
|
-
/**
|
|
41
|
-
* @deprecated
|
|
42
|
-
*/
|
|
43
25
|
export declare type OS2StringFormat = {
|
|
44
26
|
type: "string";
|
|
45
27
|
format?: "" | "byte" | "binary" | "date" | "date-time" | "password";
|
|
46
28
|
};
|
|
47
|
-
/**
|
|
48
|
-
* @deprecated
|
|
49
|
-
*/
|
|
50
29
|
export declare type OS2SchemaFormatConstraints = OS2GenericFormat | OS2IntegerFormat | OS2NumberFormat | OS2StringFormat;
|
|
51
|
-
/**
|
|
52
|
-
* @deprecated
|
|
53
|
-
*/
|
|
54
30
|
export declare type OS2BaseFormatContrainedParameter = OS2BaseParameter & OS2SchemaFormatConstraints;
|
|
55
|
-
/**
|
|
56
|
-
* @deprecated
|
|
57
|
-
*/
|
|
58
31
|
export declare type ParameterCollectionFormat = "csv" | "ssv" | "tsv" | "pipes" | "multi";
|
|
59
|
-
/**
|
|
60
|
-
* @deprecated
|
|
61
|
-
*/
|
|
62
32
|
export declare type OS2QueryParameter = OS2BaseFormatContrainedParameter & OS2BaseSchema & {
|
|
63
33
|
in: "query";
|
|
64
34
|
allowEmptyValue?: boolean;
|
|
65
35
|
collectionFormat?: ParameterCollectionFormat;
|
|
66
36
|
};
|
|
67
|
-
/**
|
|
68
|
-
* @deprecated
|
|
69
|
-
*/
|
|
70
37
|
export declare type OS2PathParameter = OS2BaseFormatContrainedParameter & OS2BaseSchema & {
|
|
71
38
|
in: "path";
|
|
72
39
|
required: true;
|
|
73
40
|
};
|
|
74
|
-
/**
|
|
75
|
-
* @deprecated
|
|
76
|
-
*/
|
|
77
41
|
export declare type OS2HeaderParameter = OS2BaseFormatContrainedParameter & OS2BaseSchema & {
|
|
78
42
|
in: "header";
|
|
79
43
|
};
|
|
80
|
-
/**
|
|
81
|
-
* @deprecated
|
|
82
|
-
*/
|
|
83
44
|
export declare type OS2FormDataParameter = OS2BaseFormatContrainedParameter & OS2BaseSchema & {
|
|
84
45
|
in: "formData";
|
|
85
46
|
type: OpenSpecTypes;
|
|
86
47
|
allowEmptyValue?: boolean;
|
|
87
48
|
collectionFormat?: ParameterCollectionFormat;
|
|
88
49
|
};
|
|
89
|
-
/**
|
|
90
|
-
* @deprecated
|
|
91
|
-
*/
|
|
92
50
|
export declare type OS2Parameter = OS2BodyParameter | OS2FormDataParameter | OS2QueryParameter | OS2PathParameter | OS2HeaderParameter;
|
|
@@ -2,9 +2,6 @@ import { OpenSpecPath } from "../common/OpenSpecPath";
|
|
|
2
2
|
import { OpenSpecRef } from "../common/OpenSpecRef";
|
|
3
3
|
import { OS2Operation } from "./OS2Operation";
|
|
4
4
|
import { OS2Parameter } from "./OS2Parameter";
|
|
5
|
-
/**
|
|
6
|
-
* @deprecated
|
|
7
|
-
*/
|
|
8
5
|
export interface OS2Paths extends OpenSpecPath<OS2Operation> {
|
|
9
6
|
parameters?: (OS2Parameter | OpenSpecRef)[];
|
|
10
7
|
}
|
|
@@ -1,9 +1,6 @@
|
|
|
1
1
|
import { OpenSpecHash } from "../common/OpenSpecHash";
|
|
2
2
|
import { OS2Header } from "./OS2Header";
|
|
3
3
|
import { OS2Schema } from "./OS2Schema";
|
|
4
|
-
/**
|
|
5
|
-
* @deprecated
|
|
6
|
-
*/
|
|
7
4
|
export interface OS2Response {
|
|
8
5
|
/**
|
|
9
6
|
* A short description of the response. GFM syntax can be used for rich text representation.
|
|
@@ -2,9 +2,6 @@ import { OpenSpecExternalDocs } from "../common/OpenSpecExternalDocs";
|
|
|
2
2
|
import { OpenSpecBaseJsonSchema, OpenSpecJsonSchema } from "../common/OpenSpecJsonSchema";
|
|
3
3
|
import { OpenSpecRef } from "../common/OpenSpecRef";
|
|
4
4
|
import { OpenSpecXML } from "../common/OpenSpecXML";
|
|
5
|
-
/**
|
|
6
|
-
* @deprecated
|
|
7
|
-
*/
|
|
8
5
|
export interface OS2XML {
|
|
9
6
|
name?: string;
|
|
10
7
|
namespace?: string;
|
|
@@ -12,18 +9,12 @@ export interface OS2XML {
|
|
|
12
9
|
attribute?: boolean;
|
|
13
10
|
wrapped?: boolean;
|
|
14
11
|
}
|
|
15
|
-
/**
|
|
16
|
-
* @deprecated
|
|
17
|
-
*/
|
|
18
12
|
export interface OS2BaseSchema extends OpenSpecBaseJsonSchema {
|
|
19
13
|
/**
|
|
20
14
|
* Required if type is "array". Describes the type of items in the array.
|
|
21
15
|
*/
|
|
22
16
|
items?: OS2Schema | OpenSpecRef;
|
|
23
17
|
}
|
|
24
|
-
/**
|
|
25
|
-
* @deprecated
|
|
26
|
-
*/
|
|
27
18
|
export interface OS2Schema extends OpenSpecJsonSchema<OS2Schema> {
|
|
28
19
|
/**
|
|
29
20
|
* Adds support for polymorphism.
|
|
@@ -1,7 +1,4 @@
|
|
|
1
1
|
import { OpenSpecHash } from "../common/OpenSpecHash";
|
|
2
|
-
/**
|
|
3
|
-
* @deprecated
|
|
4
|
-
*/
|
|
5
2
|
export interface OS2SecurityBase {
|
|
6
3
|
/**
|
|
7
4
|
* The type of the security scheme
|
|
@@ -12,23 +9,14 @@ export interface OS2SecurityBase {
|
|
|
12
9
|
*/
|
|
13
10
|
description?: string;
|
|
14
11
|
}
|
|
15
|
-
/**
|
|
16
|
-
* @deprecated
|
|
17
|
-
*/
|
|
18
12
|
export interface OS2SecurityBasic extends OS2SecurityBase {
|
|
19
13
|
type: "basic";
|
|
20
14
|
}
|
|
21
|
-
/**
|
|
22
|
-
* @deprecated
|
|
23
|
-
*/
|
|
24
15
|
export interface OS2SecurityApiKey extends OS2SecurityBase {
|
|
25
16
|
type: "apiKey";
|
|
26
17
|
name: string;
|
|
27
18
|
in: "query" | "header";
|
|
28
19
|
}
|
|
29
|
-
/**
|
|
30
|
-
* @deprecated
|
|
31
|
-
*/
|
|
32
20
|
export interface OS2SecurityOAuth extends OS2SecurityBase {
|
|
33
21
|
type: "oauth2";
|
|
34
22
|
flow: "accessCode" | "application" | "implicit" | "password";
|
|
@@ -37,40 +25,25 @@ export interface OS2SecurityOAuth extends OS2SecurityBase {
|
|
|
37
25
|
*/
|
|
38
26
|
scopes: OpenSpecHash<string>;
|
|
39
27
|
}
|
|
40
|
-
/**
|
|
41
|
-
* @deprecated
|
|
42
|
-
*/
|
|
43
28
|
export interface OS2FlowImplicit extends OS2SecurityOAuth {
|
|
44
29
|
type: "oauth2";
|
|
45
30
|
flow: "implicit";
|
|
46
31
|
authorizationUrl: string;
|
|
47
32
|
}
|
|
48
|
-
/**
|
|
49
|
-
* @deprecated
|
|
50
|
-
*/
|
|
51
33
|
export interface OS2FlowPassword extends OS2SecurityOAuth {
|
|
52
34
|
type: "oauth2";
|
|
53
35
|
flow: "password";
|
|
54
36
|
tokenUrl: string;
|
|
55
37
|
}
|
|
56
|
-
/**
|
|
57
|
-
* @deprecated
|
|
58
|
-
*/
|
|
59
38
|
export interface OS2FlowApplication extends OS2SecurityOAuth {
|
|
60
39
|
type: "oauth2";
|
|
61
40
|
flow: "application";
|
|
62
41
|
tokenUrl: string;
|
|
63
42
|
}
|
|
64
|
-
/**
|
|
65
|
-
* @deprecated
|
|
66
|
-
*/
|
|
67
43
|
export interface OS2FlowAccessCode extends OS2SecurityOAuth {
|
|
68
44
|
type: "oauth2";
|
|
69
45
|
flow: "accessCode";
|
|
70
46
|
tokenUrl: string;
|
|
71
47
|
authorizationUrl: string;
|
|
72
48
|
}
|
|
73
|
-
/**
|
|
74
|
-
* @deprecated
|
|
75
|
-
*/
|
|
76
49
|
export declare type OS2Security = OS2SecurityBasic | OS2FlowAccessCode | OS2FlowApplication | OS2FlowImplicit | OS2FlowPassword | OS2SecurityApiKey;
|