Skip to content

Pdf file request with response headers #1043

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 13 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
9 changes: 9 additions & 0 deletions CHANGELOG.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,15 @@
# Changelog
All notable changes to this project will be documented in this file.

## unreleased
### Added
- Added `requestApiResult` as additional request function
### Changed
- Changed ApiResult to be generic and also contain response header
### Fixed
- Fixed binary response type to process as a Blob rather than text/string (#986)
- Use type-only imports for axios (#1037)

## [0.22.0] - 2022-04-26
### Fixed
- Upgraded dependencies
Expand Down
8 changes: 7 additions & 1 deletion src/openApi/v2/parser/getOperation.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import type { Operation } from '../../../client/interfaces/Operation';
import type { OperationParameters } from '../../../client/interfaces/OperationParameters';
import type { OperationResponse } from '../../../client/interfaces/OperationResponse';
import type { OpenApi } from '../interfaces/OpenApi';
import type { OpenApiOperation } from '../interfaces/OpenApiOperation';
import { getOperationErrors } from './getOperationErrors';
Expand All @@ -11,6 +12,10 @@ import { getOperationResults } from './getOperationResults';
import { getServiceName } from './getServiceName';
import { sortByRequired } from './sortByRequired';

const getOperationResultsWithoutHeader = (operationResults: OperationResponse[]) => {
return operationResults.filter(operationResult => operationResult.in !== 'header');
};

export const getOperation = (
openApi: OpenApi,
url: string,
Expand Down Expand Up @@ -63,8 +68,9 @@ export const getOperation = (
const operationResults = getOperationResults(operationResponses);
operation.errors = getOperationErrors(operationResponses);
operation.responseHeader = getOperationResponseHeader(operationResults);
const operationResultsWithoutHeader = getOperationResultsWithoutHeader(operationResults);

operationResults.forEach(operationResult => {
operationResultsWithoutHeader.forEach(operationResult => {
operation.results.push(operationResult);
operation.imports.push(...operationResult.imports);
});
Expand Down
28 changes: 20 additions & 8 deletions src/openApi/v2/parser/getOperationResponse.ts
Original file line number Diff line number Diff line change
Expand Up @@ -7,12 +7,8 @@ import { getModel } from './getModel';
import { getRef } from './getRef';
import { getType } from './getType';

export const getOperationResponse = (
openApi: OpenApi,
response: OpenApiResponse,
responseCode: number
): OperationResponse => {
const operationResponse: OperationResponse = {
const getDefaultOperationResponse = (responseCode: number, response: OpenApiResponse): OperationResponse => {
return {
in: 'response',
name: '',
code: responseCode,
Expand All @@ -31,6 +27,14 @@ export const getOperationResponse = (
enums: [],
properties: [],
};
};

export const getOperationResponseContent = (
openApi: OpenApi,
response: OpenApiResponse,
responseCode: number
): OperationResponse => {
const operationResponse = getDefaultOperationResponse(responseCode, response);

// If this response has a schema, then we need to check two things:
// if this is a reference then the parameter is just the 'name' of
Expand Down Expand Up @@ -80,6 +84,15 @@ export const getOperationResponse = (
return operationResponse;
}
}
return operationResponse;
};

export const getOperationResponseHeaders = (
openApi: OpenApi,
response: OpenApiResponse,
responseCode: number
): OperationResponse | null => {
const operationResponse = getDefaultOperationResponse(responseCode, response);

// We support basic properties from response headers, since both
// fetch and XHR client just support string types.
Expand All @@ -94,6 +107,5 @@ export const getOperationResponse = (
}
}
}

return operationResponse;
return null;
};
10 changes: 7 additions & 3 deletions src/openApi/v2/parser/getOperationResponses.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import type { OperationResponse } from '../../../client/interfaces/OperationResp
import type { OpenApi } from '../interfaces/OpenApi';
import type { OpenApiResponse } from '../interfaces/OpenApiResponse';
import type { OpenApiResponses } from '../interfaces/OpenApiResponses';
import { getOperationResponse } from './getOperationResponse';
import { getOperationResponseContent, getOperationResponseHeaders } from './getOperationResponse';
import { getOperationResponseCode } from './getOperationResponseCode';
import { getRef } from './getRef';

Expand All @@ -18,8 +18,12 @@ export const getOperationResponses = (openApi: OpenApi, responses: OpenApiRespon
const responseCode = getOperationResponseCode(code);

if (responseCode) {
const operationResponse = getOperationResponse(openApi, response, responseCode);
operationResponses.push(operationResponse);
const operationResponseContent = getOperationResponseContent(openApi, response, responseCode);
operationResponses.push(operationResponseContent);
const operationResponseHeaders = getOperationResponseHeaders(openApi, response, responseCode);
if (operationResponseHeaders !== null) {
operationResponses.push(operationResponseHeaders);
}
}
}
}
Expand Down
8 changes: 7 additions & 1 deletion src/openApi/v3/parser/getOperation.ts
Original file line number Diff line number Diff line change
@@ -1,5 +1,6 @@
import type { Operation } from '../../../client/interfaces/Operation';
import type { OperationParameters } from '../../../client/interfaces/OperationParameters';
import type { OperationResponse } from '../../../client/interfaces/OperationResponse';
import type { OpenApi } from '../interfaces/OpenApi';
import type { OpenApiOperation } from '../interfaces/OpenApiOperation';
import type { OpenApiRequestBody } from '../interfaces/OpenApiRequestBody';
Expand All @@ -14,6 +15,10 @@ import { getRef } from './getRef';
import { getServiceName } from './getServiceName';
import { sortByRequired } from './sortByRequired';

const getOperationResultsWithoutHeader = (operationResults: OperationResponse[]) => {
return operationResults.filter(operationResult => operationResult.in !== 'header');
};

export const getOperation = (
openApi: OpenApi,
url: string,
Expand Down Expand Up @@ -74,8 +79,9 @@ export const getOperation = (
const operationResults = getOperationResults(operationResponses);
operation.errors = getOperationErrors(operationResponses);
operation.responseHeader = getOperationResponseHeader(operationResults);
const operationResultsWithoutHeader = getOperationResultsWithoutHeader(operationResults);

operationResults.forEach(operationResult => {
operationResultsWithoutHeader.forEach(operationResult => {
operation.results.push(operationResult);
operation.imports.push(...operationResult.imports);
});
Expand Down
28 changes: 20 additions & 8 deletions src/openApi/v3/parser/getOperationResponse.ts
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,8 @@ import { getModel } from './getModel';
import { getRef } from './getRef';
import { getType } from './getType';

export const getOperationResponse = (
openApi: OpenApi,
response: OpenApiResponse,
responseCode: number
): OperationResponse => {
const operationResponse: OperationResponse = {
const getDefaultOperationResponse = (responseCode: number, response: OpenApiResponse): OperationResponse => {
return {
in: 'response',
name: '',
code: responseCode,
Expand All @@ -32,6 +28,14 @@ export const getOperationResponse = (
enums: [],
properties: [],
};
};

export const getOperationResponseContent = (
openApi: OpenApi,
response: OpenApiResponse,
responseCode: number
): OperationResponse => {
const operationResponse = getDefaultOperationResponse(responseCode, response);

if (response.content) {
const content = getContent(openApi, response.content);
Expand Down Expand Up @@ -79,6 +83,15 @@ export const getOperationResponse = (
}
}
}
return operationResponse;
};

export const getOperationResponseHeaders = (
openApi: OpenApi,
response: OpenApiResponse,
responseCode: number
): OperationResponse | null => {
const operationResponse = getDefaultOperationResponse(responseCode, response);

// We support basic properties from response headers, since both
// fetch and XHR client just support string types.
Expand All @@ -93,6 +106,5 @@ export const getOperationResponse = (
}
}
}

return operationResponse;
return null;
};
10 changes: 7 additions & 3 deletions src/openApi/v3/parser/getOperationResponses.ts
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@ import type { OperationResponse } from '../../../client/interfaces/OperationResp
import type { OpenApi } from '../interfaces/OpenApi';
import type { OpenApiResponse } from '../interfaces/OpenApiResponse';
import type { OpenApiResponses } from '../interfaces/OpenApiResponses';
import { getOperationResponse } from './getOperationResponse';
import { getOperationResponseContent, getOperationResponseHeaders } from './getOperationResponse';
import { getOperationResponseCode } from './getOperationResponseCode';
import { getRef } from './getRef';

Expand All @@ -18,8 +18,12 @@ export const getOperationResponses = (openApi: OpenApi, responses: OpenApiRespon
const responseCode = getOperationResponseCode(code);

if (responseCode) {
const operationResponse = getOperationResponse(openApi, response, responseCode);
operationResponses.push(operationResponse);
const operationResponseContent = getOperationResponseContent(openApi, response, responseCode);
operationResponses.push(operationResponseContent);
const operationResponseHeaders = getOperationResponseHeaders(openApi, response, responseCode);
if (operationResponseHeaders !== null) {
operationResponses.push(operationResponseHeaders);
}
}
}
}
Expand Down
2 changes: 1 addition & 1 deletion src/templates/core/ApiError.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ export class ApiError extends Error {
public readonly statusText: string;
public readonly body: any;

constructor(response: ApiResult, message: string) {
constructor(response: ApiResult<any>, message: string) {
super(message);

this.name = 'ApiError';
Expand Down
1 change: 1 addition & 0 deletions src/templates/core/ApiRequestOptions.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ export type ApiRequestOptions = {
readonly formData?: Record<string, any>;
readonly body?: any;
readonly mediaType?: string;
readonly responseType?: 'blob';
readonly responseHeader?: string;
readonly errors?: Record<number, string>;
};
5 changes: 3 additions & 2 deletions src/templates/core/ApiResult.hbs
Original file line number Diff line number Diff line change
@@ -1,9 +1,10 @@
{{>header}}

export type ApiResult = {
export type ApiResult<T> = {
readonly url: string;
readonly ok: boolean;
readonly status: number;
readonly statusText: string;
readonly body: any;
readonly body: T;
readonly header: string | undefined;
};
4 changes: 4 additions & 0 deletions src/templates/core/BaseHttpRequest.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,11 @@ import type { HttpClient } from '@angular/common/http';
import type { Observable } from 'rxjs';

import type { ApiRequestOptions } from './ApiRequestOptions';
import type { ApiResult } from './ApiResult';
import type { OpenAPIConfig } from './OpenAPI';
{{else}}
import type { ApiRequestOptions } from './ApiRequestOptions';
import type { ApiResult } from './ApiResult';
import type { CancelablePromise } from './CancelablePromise';
import type { OpenAPIConfig } from './OpenAPI';
{{/equals}}
Expand All @@ -25,7 +27,9 @@ export abstract class BaseHttpRequest {

{{#equals @root.httpClient 'angular'}}
public abstract request<T>(options: ApiRequestOptions): Observable<T>;
public abstract requestApiResult<T>(options: ApiRequestOptions): Observable<ApiResult<T>>;
{{else}}
public abstract request<T>(options: ApiRequestOptions): CancelablePromise<T>;
public abstract requestApiResult<T>(options: ApiRequestOptions): CancelablePromise<ApiResult<T>>;
{{/equals}}
}
24 changes: 22 additions & 2 deletions src/templates/core/HttpRequest.hbs
Original file line number Diff line number Diff line change
Expand Up @@ -6,16 +6,18 @@ import { HttpClient } from '@angular/common/http';
import type { Observable } from 'rxjs';

import type { ApiRequestOptions } from './ApiRequestOptions';
import type { ApiResult } from './ApiResult';
import { BaseHttpRequest } from './BaseHttpRequest';
import type { OpenAPIConfig } from './OpenAPI';
import { OpenAPI } from './OpenAPI';
import { request as __request } from './request';
import { request as __request, requestApiResult as __requestApiResult } from './request';
{{else}}
import type { ApiRequestOptions } from './ApiRequestOptions';
import type { ApiResult } from './ApiResult';
import { BaseHttpRequest } from './BaseHttpRequest';
import type { CancelablePromise } from './CancelablePromise';
import type { OpenAPIConfig } from './OpenAPI';
import { request as __request } from './request';
import { request as __request, requestApiResult as __requestApiResult } from './request';
{{/equals}}

{{#equals @root.httpClient 'angular'}}
Expand Down Expand Up @@ -47,6 +49,15 @@ export class {{httpRequest}} extends BaseHttpRequest {
public override request<T>(options: ApiRequestOptions): Observable<T> {
return __request(this.config, this.http, options);
}
/**
* Request method with ResponseHeader
* @param options The request options from the service
* @returns Observable<ApiResult<T>>
* @throws ApiError
*/
public override requestApiResult<T>(options: ApiRequestOptions): Observable<ApiResult<T>> {
return __requestApiResult(this.config, this.http, options);
}
{{else}}
/**
* Request method
Expand All @@ -57,5 +68,14 @@ export class {{httpRequest}} extends BaseHttpRequest {
public override request<T>(options: ApiRequestOptions): CancelablePromise<T> {
return __request(this.config, options);
}
/**
* Request method with ResponseHeader
* @param options The request options from the service
* @returns CancelablePromise<ApiResult<T>>
* @throws ApiError
*/
public override requestApiResult<T>(options: ApiRequestOptions): CancelablePromise<ApiResult<T>> {
return __requestApiResult(this.config, options);
}
{{/equals}}
}
Loading