Merge pull request #149 from hey-api/chore/update-openapi-links

chore(docs): update links to openapi spec

src/openApi/v2/interfaces/OpenApi.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
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md
  */
 export interface OpenApi {
     basePath?: string;

src/openApi/v2/interfaces/OpenApiContact.ts

@@ -1,5 +1,5 @@
 /**
- * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#contactObject
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#contact-object
  */
 export interface OpenApiContact {
     name?: string;

src/openApi/v2/interfaces/OpenApiExample.ts

@@ -1,5 +1,5 @@
 /**
- * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#exampleObject
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/main/versions/2.0.md#example-object
  */
 export interface OpenApiExample {
     [mimetype: string]: unknown;

src/openApi/v2/interfaces/OpenApiExternalDocs.ts

@@ -1,5 +1,5 @@
 /**
- * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#externalDocumentationObject
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#external-documentation-object
  */
 export interface OpenApiExternalDocs {
     description?: string;

src/openApi/v2/interfaces/OpenApiHeader.ts

@@ -2,7 +2,7 @@ import type { Dictionary } from '../../../types/generic';
 import type { OpenApiItems } from './OpenApiItems';
 
 /**
- * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#headerObject
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#header-object
  */
 export interface OpenApiHeader {
     description?: string;

src/openApi/v2/interfaces/OpenApiInfo.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
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#info-object
  */
 export interface OpenApiInfo {
     title: string;

src/openApi/v2/interfaces/OpenApiItems.ts

@@ -1,7 +1,7 @@
 import type { WithEnumExtension } from '../../../types/client';
 
 /**
- * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#itemsObject
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#items-object)
  */
 export interface OpenApiItems extends WithEnumExtension {
     type?: string;

src/openApi/v2/interfaces/OpenApiLicense.ts

@@ -1,5 +1,5 @@
 /**
- * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#licenseObject
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#license-object
  */
 export interface OpenApiLicense {
     name: string;

src/openApi/v2/interfaces/OpenApiOperation.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
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#operation-object
  */
 export interface OpenApiOperation {
     tags?: string[];

src/openApi/v2/interfaces/OpenApiParameter.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
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#parameter-object
  */
 export interface OpenApiParameter extends OpenApiReference, WithEnumExtension, WithNullableExtension {
     name: string;

src/openApi/v2/interfaces/OpenApiPath.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
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#path-item-object
  */
 export interface OpenApiPath extends OpenApiReference {
     get?: OpenApiOperation;

src/openApi/v2/interfaces/OpenApiReference.ts

@@ -1,5 +1,5 @@
 /**
- * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#referenceObject
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#reference-object
  */
 export interface OpenApiReference {
     $ref?: string;

src/openApi/v2/interfaces/OpenApiResponse.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
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#response-object
  */
 export interface OpenApiResponse extends OpenApiReference {
     description: string;

src/openApi/v2/interfaces/OpenApiResponses.ts

@@ -1,7 +1,7 @@
 import type { OpenApiResponse } from './OpenApiResponse';
 
 /**
- * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#responsesObject
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#responses-object
  */
 interface Response {
     [httpcode: string]: OpenApiResponse;

src/openApi/v2/interfaces/OpenApiSchema.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
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#schema-object
  */
 export interface OpenApiSchema extends OpenApiReference, WithEnumExtension, WithNullableExtension {
     title?: string;

src/openApi/v2/interfaces/OpenApiSecurityRequirement.ts

@@ -1,5 +1,5 @@
 /**
- * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#securityRequirementObject
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#security-requirement-object
  */
 export interface OpenApiSecurityRequirement {
     [key: string]: string;

src/openApi/v2/interfaces/OpenApiSecurityScheme.ts

@@ -1,7 +1,7 @@
 import type { Dictionary } from '../../../types/generic';
 
 /**
- * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#securitySchemeObject
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#security-scheme-object
  */
 export interface OpenApiSecurityScheme {
     type: 'basic' | 'apiKey' | 'oauth2';

src/openApi/v2/interfaces/OpenApiTag.ts

@@ -1,7 +1,7 @@
 import type { OpenApiExternalDocs } from './OpenApiExternalDocs';
 
 /**
- * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#tagObject
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#tag-object
  */
 export interface OpenApiTag {
     name: string;

src/openApi/v2/interfaces/OpenApiXml.ts

@@ -1,5 +1,5 @@
 /**
- * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#xmlObject
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/master/versions/2.0.md#xml-object
  */
 export interface OpenApiXml {
     name?: string;

src/openApi/v3/interfaces/OpenApi.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
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.0.md
  */
 export interface OpenApi {
     components?: OpenApiComponents;

src/openApi/v3/interfaces/OpenApiCallback.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
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.0.md#callback-object
  */
 interface Callback {
     [key: string]: OpenApiPath;

src/openApi/v3/interfaces/OpenApiComponents.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
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.0.md#components-object
  */
 export interface OpenApiComponents {
     schemas?: Dictionary<OpenApiSchema>;

src/openApi/v3/interfaces/OpenApiContact.ts

@@ -1,5 +1,5 @@
 /**
- * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#contactObject
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.0.md#contact-object
  */
 export interface OpenApiContact {
     name?: string;

src/openApi/v3/interfaces/OpenApiDiscriminator.ts

@@ -1,7 +1,7 @@
 import type { Dictionary } from '../../../types/generic';
 
 /**
- * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#discriminatorObject
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.0.md#discriminator-object
  */
 export interface OpenApiDiscriminator {
     propertyName: string;

src/openApi/v3/interfaces/OpenApiEncoding.ts

@@ -2,7 +2,7 @@ import type { Dictionary } from '../../../types/generic';
 import type { OpenApiHeader } from './OpenApiHeader';
 
 /**
- * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#encodingObject
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.0.md#encoding-object
  */
 export interface OpenApiEncoding {
     contentType?: string;

src/openApi/v3/interfaces/OpenApiExample.ts

@@ -1,7 +1,7 @@
 import type { OpenApiReference } from './OpenApiReference';
 
 /**
- * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#exampleObject
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.0.md#example-object
  */
 export interface OpenApiExample extends OpenApiReference {
     summary?: string;

src/openApi/v3/interfaces/OpenApiExternalDocs.ts

@@ -1,5 +1,5 @@
 /**
- * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#externalDocumentationObject
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.0.md#external-documentation-object
  */
 export interface OpenApiExternalDocs {
     description?: string;

src/openApi/v3/interfaces/OpenApiHeader.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
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.0.md#header-object
  */
 export interface OpenApiHeader extends OpenApiReference {
     description?: string;

src/openApi/v3/interfaces/OpenApiInfo.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
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.0.md#info-object
  */
 export interface OpenApiInfo {
     title: string;

src/openApi/v3/interfaces/OpenApiLicense.ts

@@ -1,5 +1,5 @@
 /**
- * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#licenseObject
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.0.md#license-object
  */
 export interface OpenApiLicense {
     name: string;

src/openApi/v3/interfaces/OpenApiLink.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
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.0.md#link-object
  */
 export interface OpenApiLink extends OpenApiReference {
     operationRef?: string;

src/openApi/v3/interfaces/OpenApiMediaType.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
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.0.md#media-type-object
  */
 export interface OpenApiMediaType extends OpenApiReference {
     schema?: OpenApiSchema;

src/openApi/v3/interfaces/OpenApiOAuthFlow.ts

@@ -1,7 +1,7 @@
 import type { Dictionary } from '../../../types/generic';
 
 /**
- * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#oauthFlowObject
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.0.md#oauth-flow-object
  */
 export interface OpenApiOAuthFlow {
     authorizationUrl: string;

src/openApi/v3/interfaces/OpenApiOAuthFlows.ts

@@ -1,7 +1,7 @@
 import type { OpenApiOAuthFlow } from './OpenApiOAuthFlow';
 
 /**
- * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#oauthFlowsObject
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.0.md#oauth-flows-object
  */
 export interface OpenApiOAuthFlows {
     implicit?: OpenApiOAuthFlow;

src/openApi/v3/interfaces/OpenApiOperation.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
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.0.md#operation-object
  */
 export interface OpenApiOperation {
     tags?: string[];

src/openApi/v3/interfaces/OpenApiParameter.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
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.0.md#parameter-object
  */
 export interface OpenApiParameter extends OpenApiReference {
     name: string;

src/openApi/v3/interfaces/OpenApiPath.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
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.0.md#path-item-object
  */
 export interface OpenApiPath {
     delete?: OpenApiOperation;

src/openApi/v3/interfaces/OpenApiPaths.ts

@@ -1,7 +1,7 @@
 import type { OpenApiPath } from './OpenApiPath';
 
 /**
- * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#pathsObject
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.0.md#paths-object
  */
 export interface OpenApiPaths {
     [path: string]: OpenApiPath;

src/openApi/v3/interfaces/OpenApiReference.ts

@@ -1,5 +1,5 @@
 /**
- * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#referenceObject
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.0.md#reference-object
  */
 export interface OpenApiReference {
     $ref?: string;

src/openApi/v3/interfaces/OpenApiRequestBody.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
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.0.md#request-body-object
  */
 export interface OpenApiRequestBody extends OpenApiReference {
     'x-body-name'?: string;

src/openApi/v3/interfaces/OpenApiResponse.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
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.0.md#response-object
  */
 export interface OpenApiResponse extends OpenApiReference {
     description: string;

src/openApi/v3/interfaces/OpenApiResponses.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
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.0.md#responses-object
  */
 interface Response {
     [httpcode: string]: OpenApiResponse;

src/openApi/v3/interfaces/OpenApiSchema.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
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.0.md#schema-object
  */
 export interface OpenApiSchema extends OpenApiReference, WithEnumExtension {
     additionalProperties?: boolean | OpenApiSchema;

src/openApi/v3/interfaces/OpenApiSecurityRequirement.ts

@@ -1,5 +1,5 @@
 /**
- * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#securityRequirementObject
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.0.md#security-requirement-object
  */
 export interface OpenApiSecurityRequirement {
     [name: string]: string;

src/openApi/v3/interfaces/OpenApiSecurityScheme.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
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.0.md#security-scheme-object
  */
 export interface OpenApiSecurityScheme extends OpenApiReference {
     type: 'apiKey' | 'http' | 'oauth2' | 'openIdConnect';

src/openApi/v3/interfaces/OpenApiServer.ts

@@ -2,7 +2,7 @@ import type { Dictionary } from '../../../types/generic';
 import type { OpenApiServerVariable } from './OpenApiServerVariable';
 
 /**
- * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#serverObject
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.0.md#server-object
  */
 export interface OpenApiServer {
     url: string;

src/openApi/v3/interfaces/OpenApiServerVariable.ts

@@ -1,7 +1,7 @@
 import type { WithEnumExtension } from '../../../types/client';
 
 /**
- * https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.0.2.md#serverVariableObject
+ * {@link} https://github.com/OAI/OpenAPI-Specification/blob/master/versions/3.1.0.md#server-variable-object
  */
 export interface OpenApiServerVariable extends WithEnumExtension {
     enum?: (string | number)[];