diff --git a/.github/workflows/codeql.yml b/.github/workflows/codeql.yml index 9041ade6..57cfed82 100644 --- a/.github/workflows/codeql.yml +++ b/.github/workflows/codeql.yml @@ -2,9 +2,9 @@ name: "CodeQL" on: push: - branches: [ "master" ] + branches: [ "main" ] pull_request: - branches: [ "master" ] + branches: [ "main" ] schedule: - cron: "44 20 * * 3" diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index dbc874d7..6458ae72 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -20,7 +20,7 @@ https://help.github.com/articles/using-pull-requests ## Submitting a Pull Request -1. Make your changes in a new git branch: `git checkout -b my-fix-branch master` +1. Make your changes in a new git branch: `git checkout -b my-fix-branch main` 2. Create your patch or feature 3. Ensure the builds work by running: `npm run build` 4. Ensure the tests will pass by running: `npm run test` diff --git a/README.md b/README.md index dae080cb..f31f8915 100644 --- a/README.md +++ b/README.md @@ -79,5 +79,5 @@ If you're from an enterprise looking for a fully managed SDK generation, please [coverage-image]: https://img.shields.io/codecov/c/github/ferdikoomen/openapi-typescript-codegen.svg [downloads-url]: http://npm-stat.com/charts.html?package=openapi-typescript-codegen [downloads-image]: http://img.shields.io/npm/dm/openapi-typescript-codegen.svg -[build-url]: https://circleci.com/gh/ferdikoomen/openapi-typescript-codegen/tree/master -[build-image]: https://circleci.com/gh/ferdikoomen/openapi-typescript-codegen/tree/master.svg?style=svg +[build-url]: https://circleci.com/gh/ferdikoomen/openapi-typescript-codegen/tree/main +[build-image]: https://circleci.com/gh/ferdikoomen/openapi-typescript-codegen/tree/main.svg?style=svg diff --git a/samples/spec/v3.json b/samples/spec/v3.json index 7c39dde2..12023969 100644 --- a/samples/spec/v3.json +++ b/samples/spec/v3.json @@ -2,7 +2,7 @@ "openapi": "3.0.2", "info": { "title": "Swagger Petstore - OpenAPI 3.0", - "description": "This is a sample Pet Store Server based on the OpenAPI 3.0 specification. You can find out more about\nSwagger at [http://swagger.io](http://swagger.io). In the third iteration of the pet store, we've switched to the design first approach!\nYou can now help us improve the API whether it's by making changes to the definition itself or to the code.\nThat way, with time, we can improve the API in general, and expose some of the new features in OAS3.\n\nSome useful links:\n- [The Pet Store repository](https://github.com/swagger-api/swagger-petstore)\n- [The source API definition for the Pet Store](https://github.com/swagger-api/swagger-petstore/blob/master/src/main/resources/openapi.yaml) ", + "description": "This is a sample Pet Store Server based on the OpenAPI 3.0 specification. You can find out more about\nSwagger at [http://swagger.io](http://swagger.io). In the third iteration of the pet store, we've switched to the design first approach!\nYou can now help us improve the API whether it's by making changes to the definition itself or to the code.\nThat way, with time, we can improve the API in general, and expose some of the new features in OAS3.\n\nSome useful links:\n- [The Pet Store repository](https://github.com/swagger-api/swagger-petstore)\n- [The source API definition for the Pet Store](https://github.com/swagger-api/swagger-petstore/blob/main/src/main/resources/openapi.yaml) ", "termsOfService": "http://swagger.io/terms/", "contact": { "email": "apiteam@swagger.io" diff --git a/src/index.spec.ts b/src/index.spec.ts index 1e42c68e..ff7bd155 100644 --- a/src/index.spec.ts +++ b/src/index.spec.ts @@ -19,7 +19,7 @@ describe('index', () => { it('downloads and parses v2 without issues', async () => { await OpenAPI.generate({ - input: 'https://raw.githubusercontent.com/ferdikoomen/openapi-typescript-codegen/master/test/spec/v2.json', + input: 'https://raw.githubusercontent.com/ferdikoomen/openapi-typescript-codegen/main/test/spec/v2.json', output: './generated/v2-downloaded/', write: false, }); @@ -27,7 +27,7 @@ describe('index', () => { it('downloads and parses v3 without issues', async () => { await OpenAPI.generate({ - input: 'https://raw.githubusercontent.com/ferdikoomen/openapi-typescript-codegen/master/test/spec/v3.json', + input: 'https://raw.githubusercontent.com/ferdikoomen/openapi-typescript-codegen/main/test/spec/v3.json', output: './generated/v3-downloaded/', write: false, }); diff --git a/src/openApi/v2/interfaces/OpenApi.d.ts b/src/openApi/v2/interfaces/OpenApi.d.ts index 1479c31a..7ed8cf36 100644 --- a/src/openApi/v2/interfaces/OpenApi.d.ts +++ b/src/openApi/v2/interfaces/OpenApi.d.ts @@ -10,7 +10,7 @@ import type { OpenApiSecurityScheme } from './OpenApiSecurityScheme'; import type { OpenApiTag } from './OpenApiTag'; /** - * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md */ export interface OpenApi { swagger: string; diff --git a/src/openApi/v2/interfaces/OpenApiContact.d.ts b/src/openApi/v2/interfaces/OpenApiContact.d.ts index 485e97a5..7399d905 100644 --- a/src/openApi/v2/interfaces/OpenApiContact.d.ts +++ b/src/openApi/v2/interfaces/OpenApiContact.d.ts @@ -1,5 +1,5 @@ /** - * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#contactObject + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#contactObject */ export interface OpenApiContact { name?: string; diff --git a/src/openApi/v2/interfaces/OpenApiExample.d.ts b/src/openApi/v2/interfaces/OpenApiExample.d.ts index 692752f5..7a5be38c 100644 --- a/src/openApi/v2/interfaces/OpenApiExample.d.ts +++ b/src/openApi/v2/interfaces/OpenApiExample.d.ts @@ -1,5 +1,5 @@ /** - * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#exampleObject + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#exampleObject */ export interface OpenApiExample { [mimetype: string]: any; diff --git a/src/openApi/v2/interfaces/OpenApiExternalDocs.d.ts b/src/openApi/v2/interfaces/OpenApiExternalDocs.d.ts index dfcc9bb5..e844fef7 100644 --- a/src/openApi/v2/interfaces/OpenApiExternalDocs.d.ts +++ b/src/openApi/v2/interfaces/OpenApiExternalDocs.d.ts @@ -1,5 +1,5 @@ /** - * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#externalDocumentationObject + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#externalDocumentationObject */ export interface OpenApiExternalDocs { description?: string; diff --git a/src/openApi/v2/interfaces/OpenApiHeader.d.ts b/src/openApi/v2/interfaces/OpenApiHeader.d.ts index 81d2a74c..fcb191df 100644 --- a/src/openApi/v2/interfaces/OpenApiHeader.d.ts +++ b/src/openApi/v2/interfaces/OpenApiHeader.d.ts @@ -2,7 +2,7 @@ import type { Dictionary } from '../../../utils/types'; import type { OpenApiItems } from './OpenApiItems'; /** - * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#headerObject + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#headerObject */ export interface OpenApiHeader { description?: string; diff --git a/src/openApi/v2/interfaces/OpenApiInfo.d.ts b/src/openApi/v2/interfaces/OpenApiInfo.d.ts index 208dec9f..7d98fd17 100644 --- a/src/openApi/v2/interfaces/OpenApiInfo.d.ts +++ b/src/openApi/v2/interfaces/OpenApiInfo.d.ts @@ -2,7 +2,7 @@ import type { OpenApiContact } from './OpenApiContact'; import type { OpenApiLicense } from './OpenApiLicense'; /** - * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#infoObject + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#infoObject */ export interface OpenApiInfo { title: string; diff --git a/src/openApi/v2/interfaces/OpenApiItems.d.ts b/src/openApi/v2/interfaces/OpenApiItems.d.ts index fa1d0b94..70a67d59 100644 --- a/src/openApi/v2/interfaces/OpenApiItems.d.ts +++ b/src/openApi/v2/interfaces/OpenApiItems.d.ts @@ -1,7 +1,7 @@ import type { WithEnumExtension } from './Extensions/WithEnumExtension'; /** - * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#itemsObject + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#itemsObject */ export interface OpenApiItems extends WithEnumExtension { type?: string; diff --git a/src/openApi/v2/interfaces/OpenApiLicense.d.ts b/src/openApi/v2/interfaces/OpenApiLicense.d.ts index 44fc2f4a..190c8377 100644 --- a/src/openApi/v2/interfaces/OpenApiLicense.d.ts +++ b/src/openApi/v2/interfaces/OpenApiLicense.d.ts @@ -1,5 +1,5 @@ /** - * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#licenseObject + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#licenseObject */ export interface OpenApiLicense { name: string; diff --git a/src/openApi/v2/interfaces/OpenApiOperation.d.ts b/src/openApi/v2/interfaces/OpenApiOperation.d.ts index aa811bd3..69240057 100644 --- a/src/openApi/v2/interfaces/OpenApiOperation.d.ts +++ b/src/openApi/v2/interfaces/OpenApiOperation.d.ts @@ -4,7 +4,7 @@ import type { OpenApiResponses } from './OpenApiResponses'; import type { OpenApiSecurityRequirement } from './OpenApiSecurityRequirement'; /** - * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#operationObject + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#operationObject */ export interface OpenApiOperation { tags?: string[]; diff --git a/src/openApi/v2/interfaces/OpenApiParameter.d.ts b/src/openApi/v2/interfaces/OpenApiParameter.d.ts index bdff0bb6..6517ea7b 100644 --- a/src/openApi/v2/interfaces/OpenApiParameter.d.ts +++ b/src/openApi/v2/interfaces/OpenApiParameter.d.ts @@ -5,7 +5,7 @@ import type { OpenApiReference } from './OpenApiReference'; import type { OpenApiSchema } from './OpenApiSchema'; /** - * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#parameterObject + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#parameterObject */ export interface OpenApiParameter extends OpenApiReference, WithEnumExtension, WithNullableExtension { name: string; diff --git a/src/openApi/v2/interfaces/OpenApiPath.d.ts b/src/openApi/v2/interfaces/OpenApiPath.d.ts index 62d8e755..14a0fbc6 100644 --- a/src/openApi/v2/interfaces/OpenApiPath.d.ts +++ b/src/openApi/v2/interfaces/OpenApiPath.d.ts @@ -3,7 +3,7 @@ import type { OpenApiParameter } from './OpenApiParameter'; import type { OpenApiReference } from './OpenApiReference'; /** - * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#pathItemObject + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#pathItemObject */ export interface OpenApiPath extends OpenApiReference { get?: OpenApiOperation; diff --git a/src/openApi/v2/interfaces/OpenApiReference.d.ts b/src/openApi/v2/interfaces/OpenApiReference.d.ts index cbf3253d..aea0db42 100644 --- a/src/openApi/v2/interfaces/OpenApiReference.d.ts +++ b/src/openApi/v2/interfaces/OpenApiReference.d.ts @@ -1,5 +1,5 @@ /** - * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#referenceObject + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#referenceObject */ export interface OpenApiReference { $ref?: string; diff --git a/src/openApi/v2/interfaces/OpenApiResponse.d.ts b/src/openApi/v2/interfaces/OpenApiResponse.d.ts index 64a0bc85..b463a4b6 100644 --- a/src/openApi/v2/interfaces/OpenApiResponse.d.ts +++ b/src/openApi/v2/interfaces/OpenApiResponse.d.ts @@ -5,7 +5,7 @@ import type { OpenApiReference } from './OpenApiReference'; import type { OpenApiSchema } from './OpenApiSchema'; /** - * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#responseObject + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#responseObject */ export interface OpenApiResponse extends OpenApiReference { description: string; diff --git a/src/openApi/v2/interfaces/OpenApiResponses.d.ts b/src/openApi/v2/interfaces/OpenApiResponses.d.ts index 35b20454..a57731cb 100644 --- a/src/openApi/v2/interfaces/OpenApiResponses.d.ts +++ b/src/openApi/v2/interfaces/OpenApiResponses.d.ts @@ -1,7 +1,7 @@ import type { OpenApiResponse } from './OpenApiResponse'; /** - * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#responsesObject + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#responsesObject */ export interface OpenApiResponses { default?: OpenApiResponse; diff --git a/src/openApi/v2/interfaces/OpenApiSchema.d.ts b/src/openApi/v2/interfaces/OpenApiSchema.d.ts index 09970dbb..aa7662d9 100644 --- a/src/openApi/v2/interfaces/OpenApiSchema.d.ts +++ b/src/openApi/v2/interfaces/OpenApiSchema.d.ts @@ -6,7 +6,7 @@ import type { OpenApiReference } from './OpenApiReference'; import type { OpenApiXml } from './OpenApiXml'; /** - * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#schemaObject + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#schemaObject */ export interface OpenApiSchema extends OpenApiReference, WithEnumExtension, WithNullableExtension { title?: string; diff --git a/src/openApi/v2/interfaces/OpenApiSecurityRequirement.d.ts b/src/openApi/v2/interfaces/OpenApiSecurityRequirement.d.ts index 3c1ce9af..782a4eeb 100644 --- a/src/openApi/v2/interfaces/OpenApiSecurityRequirement.d.ts +++ b/src/openApi/v2/interfaces/OpenApiSecurityRequirement.d.ts @@ -1,5 +1,5 @@ /** - * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#securityRequirementObject + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#securityRequirementObject */ export interface OpenApiSecurityRequirement { [key: string]: string; diff --git a/src/openApi/v2/interfaces/OpenApiSecurityScheme.d.ts b/src/openApi/v2/interfaces/OpenApiSecurityScheme.d.ts index 121c737a..d0d78e7a 100644 --- a/src/openApi/v2/interfaces/OpenApiSecurityScheme.d.ts +++ b/src/openApi/v2/interfaces/OpenApiSecurityScheme.d.ts @@ -1,7 +1,7 @@ import type { Dictionary } from '../../../utils/types'; /** - * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#securitySchemeObject + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#securitySchemeObject */ export interface OpenApiSecurityScheme { type: 'basic' | 'apiKey' | 'oauth2'; diff --git a/src/openApi/v2/interfaces/OpenApiTag.d.ts b/src/openApi/v2/interfaces/OpenApiTag.d.ts index 85063452..8e41c02c 100644 --- a/src/openApi/v2/interfaces/OpenApiTag.d.ts +++ b/src/openApi/v2/interfaces/OpenApiTag.d.ts @@ -1,7 +1,7 @@ import type { OpenApiExternalDocs } from './OpenApiExternalDocs'; /** - * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#tagObject + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#tagObject */ export interface OpenApiTag { name: string; diff --git a/src/openApi/v2/interfaces/OpenApiXml.d.ts b/src/openApi/v2/interfaces/OpenApiXml.d.ts index 6bd8a1bc..a8b87af0 100644 --- a/src/openApi/v2/interfaces/OpenApiXml.d.ts +++ b/src/openApi/v2/interfaces/OpenApiXml.d.ts @@ -1,5 +1,5 @@ /** - * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#xmlObject + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#xmlObject */ export interface OpenApiXml { name?: string; diff --git a/src/openApi/v3/interfaces/OpenApi.d.ts b/src/openApi/v3/interfaces/OpenApi.d.ts index b33d382a..caace87e 100644 --- a/src/openApi/v3/interfaces/OpenApi.d.ts +++ b/src/openApi/v3/interfaces/OpenApi.d.ts @@ -7,7 +7,7 @@ import type { OpenApiServer } from './OpenApiServer'; import type { OpenApiTag } from './OpenApiTag'; /** - * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md */ export interface OpenApi { openapi: string; diff --git a/src/openApi/v3/interfaces/OpenApiCallback.d.ts b/src/openApi/v3/interfaces/OpenApiCallback.d.ts index deec433c..716adf47 100644 --- a/src/openApi/v3/interfaces/OpenApiCallback.d.ts +++ b/src/openApi/v3/interfaces/OpenApiCallback.d.ts @@ -2,7 +2,7 @@ import type { OpenApiPath } from './OpenApiPath'; import type { OpenApiReference } from './OpenApiReference'; /** - * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#callbackObject + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#callbackObject */ export interface OpenApiCallback extends OpenApiReference { [key: string]: OpenApiPath; diff --git a/src/openApi/v3/interfaces/OpenApiComponents.d.ts b/src/openApi/v3/interfaces/OpenApiComponents.d.ts index 54cfaa68..27a57c8c 100644 --- a/src/openApi/v3/interfaces/OpenApiComponents.d.ts +++ b/src/openApi/v3/interfaces/OpenApiComponents.d.ts @@ -10,7 +10,7 @@ import type { OpenApiSchema } from './OpenApiSchema'; import type { OpenApiSecurityScheme } from './OpenApiSecurityScheme'; /** - * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#componentsObject + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#componentsObject */ export interface OpenApiComponents { schemas?: Dictionary; diff --git a/src/openApi/v3/interfaces/OpenApiContact.d.ts b/src/openApi/v3/interfaces/OpenApiContact.d.ts index a291268f..42f6546e 100644 --- a/src/openApi/v3/interfaces/OpenApiContact.d.ts +++ b/src/openApi/v3/interfaces/OpenApiContact.d.ts @@ -1,5 +1,5 @@ /** - * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#contactObject + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#contactObject */ export interface OpenApiContact { name?: string; diff --git a/src/openApi/v3/interfaces/OpenApiDiscriminator.d.ts b/src/openApi/v3/interfaces/OpenApiDiscriminator.d.ts index aa683057..31d78f76 100644 --- a/src/openApi/v3/interfaces/OpenApiDiscriminator.d.ts +++ b/src/openApi/v3/interfaces/OpenApiDiscriminator.d.ts @@ -1,7 +1,7 @@ import type { Dictionary } from '../../../utils/types'; /** - * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#discriminatorObject + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#discriminatorObject */ export interface OpenApiDiscriminator { propertyName: string; diff --git a/src/openApi/v3/interfaces/OpenApiEncoding.d.ts b/src/openApi/v3/interfaces/OpenApiEncoding.d.ts index 670a5f15..e1842955 100644 --- a/src/openApi/v3/interfaces/OpenApiEncoding.d.ts +++ b/src/openApi/v3/interfaces/OpenApiEncoding.d.ts @@ -2,7 +2,7 @@ import type { Dictionary } from '../../../utils/types'; import type { OpenApiHeader } from './OpenApiHeader'; /** - * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#encodingObject + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#encodingObject */ export interface OpenApiEncoding { contentType?: string; diff --git a/src/openApi/v3/interfaces/OpenApiExample.d.ts b/src/openApi/v3/interfaces/OpenApiExample.d.ts index 22879579..5e35419c 100644 --- a/src/openApi/v3/interfaces/OpenApiExample.d.ts +++ b/src/openApi/v3/interfaces/OpenApiExample.d.ts @@ -1,7 +1,7 @@ import type { OpenApiReference } from './OpenApiReference'; /** - * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#exampleObject + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#exampleObject */ export interface OpenApiExample extends OpenApiReference { summary?: string; diff --git a/src/openApi/v3/interfaces/OpenApiExternalDocs.d.ts b/src/openApi/v3/interfaces/OpenApiExternalDocs.d.ts index 3aaf1877..4687f664 100644 --- a/src/openApi/v3/interfaces/OpenApiExternalDocs.d.ts +++ b/src/openApi/v3/interfaces/OpenApiExternalDocs.d.ts @@ -1,5 +1,5 @@ /** - * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#externalDocumentationObject + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#externalDocumentationObject */ export interface OpenApiExternalDocs { description?: string; diff --git a/src/openApi/v3/interfaces/OpenApiHeader.d.ts b/src/openApi/v3/interfaces/OpenApiHeader.d.ts index 694c859f..4da5d2ea 100644 --- a/src/openApi/v3/interfaces/OpenApiHeader.d.ts +++ b/src/openApi/v3/interfaces/OpenApiHeader.d.ts @@ -4,7 +4,7 @@ import type { OpenApiReference } from './OpenApiReference'; import type { OpenApiSchema } from './OpenApiSchema'; /** - * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#headerObject + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#headerObject */ export interface OpenApiHeader extends OpenApiReference { description?: string; diff --git a/src/openApi/v3/interfaces/OpenApiInfo.d.ts b/src/openApi/v3/interfaces/OpenApiInfo.d.ts index 96fabd0c..933d1a67 100644 --- a/src/openApi/v3/interfaces/OpenApiInfo.d.ts +++ b/src/openApi/v3/interfaces/OpenApiInfo.d.ts @@ -2,7 +2,7 @@ import type { OpenApiContact } from './OpenApiContact'; import type { OpenApiLicense } from './OpenApiLicense'; /** - * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#infoObject + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#infoObject */ export interface OpenApiInfo { title: string; diff --git a/src/openApi/v3/interfaces/OpenApiLicense.d.ts b/src/openApi/v3/interfaces/OpenApiLicense.d.ts index 9982f95c..96f2e73f 100644 --- a/src/openApi/v3/interfaces/OpenApiLicense.d.ts +++ b/src/openApi/v3/interfaces/OpenApiLicense.d.ts @@ -1,5 +1,5 @@ /** - * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#licenseObject + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#licenseObject */ export interface OpenApiLicense { name: string; diff --git a/src/openApi/v3/interfaces/OpenApiLink.d.ts b/src/openApi/v3/interfaces/OpenApiLink.d.ts index 31b9707e..736bcc67 100644 --- a/src/openApi/v3/interfaces/OpenApiLink.d.ts +++ b/src/openApi/v3/interfaces/OpenApiLink.d.ts @@ -3,7 +3,7 @@ import type { OpenApiReference } from './OpenApiReference'; import type { OpenApiServer } from './OpenApiServer'; /** - * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#linkObject + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#linkObject */ export interface OpenApiLink extends OpenApiReference { operationRef?: string; diff --git a/src/openApi/v3/interfaces/OpenApiMediaType.d.ts b/src/openApi/v3/interfaces/OpenApiMediaType.d.ts index 89f78c8a..3ce9e570 100644 --- a/src/openApi/v3/interfaces/OpenApiMediaType.d.ts +++ b/src/openApi/v3/interfaces/OpenApiMediaType.d.ts @@ -5,7 +5,7 @@ import type { OpenApiReference } from './OpenApiReference'; import type { OpenApiSchema } from './OpenApiSchema'; /** - * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#mediaTypeObject + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#mediaTypeObject */ export interface OpenApiMediaType extends OpenApiReference { schema?: OpenApiSchema; diff --git a/src/openApi/v3/interfaces/OpenApiOAuthFlow.d.ts b/src/openApi/v3/interfaces/OpenApiOAuthFlow.d.ts index 85654a9a..c8bab9f8 100644 --- a/src/openApi/v3/interfaces/OpenApiOAuthFlow.d.ts +++ b/src/openApi/v3/interfaces/OpenApiOAuthFlow.d.ts @@ -1,7 +1,7 @@ import type { Dictionary } from '../../../utils/types'; /** - * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#oauthFlowObject + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#oauthFlowObject */ export interface OpenApiOAuthFlow { authorizationUrl: string; diff --git a/src/openApi/v3/interfaces/OpenApiOAuthFlows.d.ts b/src/openApi/v3/interfaces/OpenApiOAuthFlows.d.ts index 87accfdb..4fd639d7 100644 --- a/src/openApi/v3/interfaces/OpenApiOAuthFlows.d.ts +++ b/src/openApi/v3/interfaces/OpenApiOAuthFlows.d.ts @@ -1,7 +1,7 @@ import type { OpenApiOAuthFlow } from './OpenApiOAuthFlow'; /** - * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#oauthFlowsObject + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#oauthFlowsObject */ export interface OpenApiOAuthFlows { implicit?: OpenApiOAuthFlow; diff --git a/src/openApi/v3/interfaces/OpenApiOperation.d.ts b/src/openApi/v3/interfaces/OpenApiOperation.d.ts index 954d9653..3e97c4fa 100644 --- a/src/openApi/v3/interfaces/OpenApiOperation.d.ts +++ b/src/openApi/v3/interfaces/OpenApiOperation.d.ts @@ -8,7 +8,7 @@ import type { OpenApiSecurityRequirement } from './OpenApiSecurityRequirement'; import type { OpenApiServer } from './OpenApiServer'; /** - * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#operationObject + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#operationObject */ export interface OpenApiOperation { tags?: string[]; diff --git a/src/openApi/v3/interfaces/OpenApiParameter.d.ts b/src/openApi/v3/interfaces/OpenApiParameter.d.ts index 7172feb7..5229cb9d 100644 --- a/src/openApi/v3/interfaces/OpenApiParameter.d.ts +++ b/src/openApi/v3/interfaces/OpenApiParameter.d.ts @@ -4,7 +4,7 @@ import type { OpenApiReference } from './OpenApiReference'; import type { OpenApiSchema } from './OpenApiSchema'; /** - * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#parameterObject + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#parameterObject */ export interface OpenApiParameter extends OpenApiReference { name: string; diff --git a/src/openApi/v3/interfaces/OpenApiPath.d.ts b/src/openApi/v3/interfaces/OpenApiPath.d.ts index a0d29805..a374ed83 100644 --- a/src/openApi/v3/interfaces/OpenApiPath.d.ts +++ b/src/openApi/v3/interfaces/OpenApiPath.d.ts @@ -3,7 +3,7 @@ import type { OpenApiParameter } from './OpenApiParameter'; import type { OpenApiServer } from './OpenApiServer'; /** - * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#pathItemObject + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#pathItemObject */ export interface OpenApiPath { summary?: string; diff --git a/src/openApi/v3/interfaces/OpenApiPaths.d.ts b/src/openApi/v3/interfaces/OpenApiPaths.d.ts index 334e1bed..2b4e4bbe 100644 --- a/src/openApi/v3/interfaces/OpenApiPaths.d.ts +++ b/src/openApi/v3/interfaces/OpenApiPaths.d.ts @@ -1,7 +1,7 @@ import type { OpenApiPath } from './OpenApiPath'; /** - * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#pathsObject + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#pathsObject */ export interface OpenApiPaths { [path: string]: OpenApiPath; diff --git a/src/openApi/v3/interfaces/OpenApiReference.d.ts b/src/openApi/v3/interfaces/OpenApiReference.d.ts index e3a1c07b..af68be0d 100644 --- a/src/openApi/v3/interfaces/OpenApiReference.d.ts +++ b/src/openApi/v3/interfaces/OpenApiReference.d.ts @@ -1,5 +1,5 @@ /** - * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#referenceObject + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#referenceObject */ export interface OpenApiReference { $ref?: string; diff --git a/src/openApi/v3/interfaces/OpenApiRequestBody.d.ts b/src/openApi/v3/interfaces/OpenApiRequestBody.d.ts index 1a687b8b..903a5c17 100644 --- a/src/openApi/v3/interfaces/OpenApiRequestBody.d.ts +++ b/src/openApi/v3/interfaces/OpenApiRequestBody.d.ts @@ -3,7 +3,7 @@ import type { OpenApiMediaType } from './OpenApiMediaType'; import type { OpenApiReference } from './OpenApiReference'; /** - * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#requestBodyObject + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#requestBodyObject */ export interface OpenApiRequestBody extends OpenApiReference { description?: string; diff --git a/src/openApi/v3/interfaces/OpenApiResponse.d.ts b/src/openApi/v3/interfaces/OpenApiResponse.d.ts index d6509bd7..b6315fe8 100644 --- a/src/openApi/v3/interfaces/OpenApiResponse.d.ts +++ b/src/openApi/v3/interfaces/OpenApiResponse.d.ts @@ -5,7 +5,7 @@ import type { OpenApiMediaType } from './OpenApiMediaType'; import type { OpenApiReference } from './OpenApiReference'; /** - * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#responseObject + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#responseObject */ export interface OpenApiResponse extends OpenApiReference { description: string; diff --git a/src/openApi/v3/interfaces/OpenApiResponses.d.ts b/src/openApi/v3/interfaces/OpenApiResponses.d.ts index fd909d29..bb66e169 100644 --- a/src/openApi/v3/interfaces/OpenApiResponses.d.ts +++ b/src/openApi/v3/interfaces/OpenApiResponses.d.ts @@ -2,7 +2,7 @@ import type { OpenApiReference } from './OpenApiReference'; import type { OpenApiResponse } from './OpenApiResponse'; /** - * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#responsesObject + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#responsesObject */ export interface OpenApiResponses extends OpenApiReference { default: OpenApiResponse; diff --git a/src/openApi/v3/interfaces/OpenApiSchema.d.ts b/src/openApi/v3/interfaces/OpenApiSchema.d.ts index a51456f3..9d9b4375 100644 --- a/src/openApi/v3/interfaces/OpenApiSchema.d.ts +++ b/src/openApi/v3/interfaces/OpenApiSchema.d.ts @@ -6,7 +6,7 @@ import type { OpenApiReference } from './OpenApiReference'; import type { OpenApiXml } from './OpenApiXml'; /** - * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#schemaObject + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#schemaObject */ export interface OpenApiSchema extends OpenApiReference, WithEnumExtension { title?: string; diff --git a/src/openApi/v3/interfaces/OpenApiSecurityRequirement.d.ts b/src/openApi/v3/interfaces/OpenApiSecurityRequirement.d.ts index 147407a8..03b8546b 100644 --- a/src/openApi/v3/interfaces/OpenApiSecurityRequirement.d.ts +++ b/src/openApi/v3/interfaces/OpenApiSecurityRequirement.d.ts @@ -1,5 +1,5 @@ /** - * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#securityRequirementObject + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#securityRequirementObject */ export interface OpenApiSecurityRequirement { [name: string]: string; diff --git a/src/openApi/v3/interfaces/OpenApiSecurityScheme.d.ts b/src/openApi/v3/interfaces/OpenApiSecurityScheme.d.ts index 21cfd1c2..3819dabe 100644 --- a/src/openApi/v3/interfaces/OpenApiSecurityScheme.d.ts +++ b/src/openApi/v3/interfaces/OpenApiSecurityScheme.d.ts @@ -2,7 +2,7 @@ import type { OpenApiOAuthFlows } from './OpenApiOAuthFlows'; import type { OpenApiReference } from './OpenApiReference'; /** - * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#securitySchemeObject + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#securitySchemeObject */ export interface OpenApiSecurityScheme extends OpenApiReference { type: 'apiKey' | 'http' | 'oauth2' | 'openIdConnect'; diff --git a/src/openApi/v3/interfaces/OpenApiServer.d.ts b/src/openApi/v3/interfaces/OpenApiServer.d.ts index 81178661..fb39c71a 100644 --- a/src/openApi/v3/interfaces/OpenApiServer.d.ts +++ b/src/openApi/v3/interfaces/OpenApiServer.d.ts @@ -2,7 +2,7 @@ import type { Dictionary } from '../../../utils/types'; import type { OpenApiServerVariable } from './OpenApiServerVariable'; /** - * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#serverObject + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#serverObject */ export interface OpenApiServer { url: string; diff --git a/src/openApi/v3/interfaces/OpenApiServerVariable.d.ts b/src/openApi/v3/interfaces/OpenApiServerVariable.d.ts index 7e556ccd..5df6d1f0 100644 --- a/src/openApi/v3/interfaces/OpenApiServerVariable.d.ts +++ b/src/openApi/v3/interfaces/OpenApiServerVariable.d.ts @@ -1,7 +1,7 @@ import type { WithEnumExtension } from './Extensions/WithEnumExtension'; /** - * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#serverVariableObject + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#serverVariableObject */ export interface OpenApiServerVariable extends WithEnumExtension { enum?: (string | number)[]; diff --git a/src/openApi/v3/interfaces/OpenApiTag.d.ts b/src/openApi/v3/interfaces/OpenApiTag.d.ts index 4bded337..a1918b77 100644 --- a/src/openApi/v3/interfaces/OpenApiTag.d.ts +++ b/src/openApi/v3/interfaces/OpenApiTag.d.ts @@ -1,7 +1,7 @@ import type { OpenApiExternalDocs } from './OpenApiExternalDocs'; /** - * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#tagObject + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#tagObject */ export interface OpenApiTag { name: string; diff --git a/src/openApi/v3/interfaces/OpenApiXml.d.ts b/src/openApi/v3/interfaces/OpenApiXml.d.ts index 2528bbd4..df13455a 100644 --- a/src/openApi/v3/interfaces/OpenApiXml.d.ts +++ b/src/openApi/v3/interfaces/OpenApiXml.d.ts @@ -1,5 +1,5 @@ /** - * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#xmlObject + * https://github.com/OAI/OpenAPI-Specification/blob/main/versions/3.0.2.md#xmlObject */ export interface OpenApiXml { name?: string;