Skip to content

[Typescript] Add Headers to Request #10406

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.

Sign up for GitHub

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

Closed
ksvirkou-hubspot wants to merge 14 commits into from
Closed

[Typescript] Add Headers to Request #10406

Show file tree
Hide file tree
Changes from 4 commits
Commits
Show all changes
14 commits
Select commit Hold shift + click to select a range
29f1e49
add headers
ksvirkou-hubspot Sep 15, 2021
5f26bd5
add samples
ksvirkou-hubspot Sep 16, 2021
01410ba
update function make request
ksvirkou-hubspot Sep 24, 2021
ff5de88
generate samples
ksvirkou-hubspot Sep 24, 2021
f0e3247
rename setHeaders to addHeaders
ksvirkou-hubspot Oct 1, 2021
bfb51d1
generete samples
ksvirkou-hubspot Oct 1, 2021
fe1bcd8
Merge pull request #1 from OpenAPITools/master
ksvirkou-hubspot Oct 5, 2021
1f0c1d7
Merge pull request #3 from OpenAPITools/master
ksvirkou-hubspot Oct 28, 2021
90bb539
Merge pull request #4 from OpenAPITools/master
ksvirkou-hubspot Nov 9, 2021
e29ae3d
clone headers for RequestContext
ksvirkou-hubspot Nov 25, 2021
cc34f89
regenerate tests
ksvirkou-hubspot Nov 25, 2021
4013b16
Merge pull request #5 from OpenAPITools/master
ksvirkou-hubspot Nov 25, 2021
0b64f3b
Merge pull request #6 from OpenAPITools/master
ksvirkou-hubspot Nov 26, 2021
935fa84
fix abstract class
ksvirkou-hubspot Nov 26, 2021
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: 6 additions & 3 deletions modules/openapi-generator/src/main/resources/typescript/http/http.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -57,6 +57,8 @@ export type HttpFile = {{{fileContentDataType}}} & { readonly name: string };
{{/node}}
{{/platforms}}

export type Headers = { [key: string]: string }

{{#platforms}}
{{#deno}}
/**
Expand Down Expand Up @@ -110,7 +112,7 @@ export type RequestBody = undefined | string | FormData | URLSearchParams;
* Represents an HTTP request context
*/
export class RequestContext {
private headers: { [key: string]: string } = {};
private headers: Headers = {};
private body: RequestBody = undefined;
private url: URLParse;

Expand All @@ -120,8 +122,9 @@ export class RequestContext {
* @param url url of the requested resource
* @param httpMethod http method
*/
public constructor(url: string, private httpMethod: HttpMethod) {
public constructor(url: string, private httpMethod: HttpMethod, headers: Headers = {}) {
this.url = new URLParse(url, true);
this.headers = headers;
}

/*
Expand Down Expand Up @@ -157,7 +160,7 @@ export class RequestContext {
return this.httpMethod;
}

public getHeaders(): { [key: string]: string } {
public getHeaders(): Headers {
return this.headers;
}

Expand Down
21 changes: 18 additions & 3 deletions modules/openapi-generator/src/main/resources/typescript/http/servers.mustache
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
import { RequestContext, HttpMethod } from "./http/http{{extensionForDeno}}";
import { RequestContext, HttpMethod, Headers } from "./http/http{{extensionForDeno}}";

export interface BaseServerConfiguration {
getHeaders(): Headers
makeRequestContext(endpoint: string, httpMethod: HttpMethod): RequestContext;
setHeaders(headers: Headers): any;
setHeaderParam(key: string, value: string): void
}

/**
Expand All @@ -11,7 +14,7 @@ export interface BaseServerConfiguration {
*
*/
export class ServerConfiguration<T extends { [key: string]: string }> implements BaseServerConfiguration {
public constructor(private url: string, private variableConfiguration: T) {}
public constructor(private url: string, private variableConfiguration: T, private headers: Headers = {}) {}

/**
* Sets the value of the variables of this server.
Expand All @@ -26,6 +29,18 @@ export class ServerConfiguration<T extends { [key: string]: string }> implements
return this.variableConfiguration
}

public setHeaders(headers: Headers): void {
Copy link
Contributor

@amakhrov amakhrov Sep 24, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

nit: Any thoughts about changing the name?
getHeaders return all headers - quite expected
But setHeaders does not set all headers, instead it's an additive operation merging new headers with existing ones

Consequently, it's not possible to remove a header previously added to the server configuration.

I mean - it resembles the existing setVariables method, true. Not sure if that interface was well thought through, though (e.g. getConfiguration instead of getVariables indicates otherwise :) )

Copy link
Contributor Author

@ksvirkou-hubspot ksvirkou-hubspot Sep 27, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

You are right
I think It is better to change the function
@amakhrov

Copy link
Contributor Author

@ksvirkou-hubspot ksvirkou-hubspot Sep 27, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more. 

public setHeaders(headers: Headers): void {
     this.headers = headers;
}

What do you think?

Copy link
Contributor Author

@ksvirkou-hubspot ksvirkou-hubspot Sep 27, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

or we can rename it to mergeHeaders or addHeaders

Copy link
Contributor Author

@ksvirkou-hubspot ksvirkou-hubspot Sep 28, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@amakhrov

Copy link
Contributor

@amakhrov amakhrov Sep 30, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

addHeaders sounds reasonable!

Copy link
Contributor Author

@ksvirkou-hubspot ksvirkou-hubspot Oct 1, 2021

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Done
@amakhrov

Object.assign(this.headers, headers);
}

public getHeaders(): Headers {
return this.headers
}

public setHeaderParam(key: string, value: string): void {
this.headers[key] = value;
}

private getUrl() {
let replacedUrl = this.url;
for (const key in this.variableConfiguration) {
Expand All @@ -44,7 +59,7 @@ export class ServerConfiguration<T extends { [key: string]: string }> implements
*
*/
public makeRequestContext(endpoint: string, httpMethod: HttpMethod): RequestContext {
return new RequestContext(this.getUrl() + endpoint, httpMethod);
return new RequestContext(this.getUrl() + endpoint, httpMethod, this.headers);
}
}

Expand Down
9 changes: 6 additions & 3 deletions samples/openapi3/client/petstore/typescript/builds/composed-schemas/http/http.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,8 @@ export enum HttpMethod {
*/
export type HttpFile = Blob & { readonly name: string };

export type Headers = { [key: string]: string }


export class HttpException extends Error {
public constructor(msg: string) {
Expand All @@ -41,7 +43,7 @@ export type RequestBody = undefined | string | FormData | URLSearchParams;
* Represents an HTTP request context
*/
export class RequestContext {
private headers: { [key: string]: string } = {};
private headers: Headers = {};
private body: RequestBody = undefined;
private url: URLParse;

Expand All @@ -51,8 +53,9 @@ export class RequestContext {
* @param url url of the requested resource
* @param httpMethod http method
*/
public constructor(url: string, private httpMethod: HttpMethod) {
public constructor(url: string, private httpMethod: HttpMethod, headers: Headers = {}) {
this.url = new URLParse(url, true);
this.headers = headers;
}

/*
Expand Down Expand Up @@ -88,7 +91,7 @@ export class RequestContext {
return this.httpMethod;
}

public getHeaders(): { [key: string]: string } {
public getHeaders(): Headers {
return this.headers;
}

Expand Down
21 changes: 18 additions & 3 deletions samples/openapi3/client/petstore/typescript/builds/composed-schemas/servers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
import { RequestContext, HttpMethod } from "./http/http";
import { RequestContext, HttpMethod, Headers } from "./http/http";

export interface BaseServerConfiguration {
getHeaders(): Headers
makeRequestContext(endpoint: string, httpMethod: HttpMethod): RequestContext;
setHeaders(headers: Headers): any;
setHeaderParam(key: string, value: string): void
}

/**
Expand All @@ -11,7 +14,7 @@ export interface BaseServerConfiguration {
*
*/
export class ServerConfiguration<T extends { [key: string]: string }> implements BaseServerConfiguration {
public constructor(private url: string, private variableConfiguration: T) {}
public constructor(private url: string, private variableConfiguration: T, private headers: Headers = {}) {}

/**
* Sets the value of the variables of this server.
Expand All @@ -26,6 +29,18 @@ export class ServerConfiguration<T extends { [key: string]: string }> implements
return this.variableConfiguration
}

public setHeaders(headers: Headers): void {
Object.assign(this.headers, headers);
}

public getHeaders(): Headers {
return this.headers
}

public setHeaderParam(key: string, value: string): void {
this.headers[key] = value;
}

private getUrl() {
let replacedUrl = this.url;
for (const key in this.variableConfiguration) {
Expand All @@ -44,7 +59,7 @@ export class ServerConfiguration<T extends { [key: string]: string }> implements
*
*/
public makeRequestContext(endpoint: string, httpMethod: HttpMethod): RequestContext {
return new RequestContext(this.getUrl() + endpoint, httpMethod);
return new RequestContext(this.getUrl() + endpoint, httpMethod, this.headers);
}
}

Expand Down
9 changes: 6 additions & 3 deletions samples/openapi3/client/petstore/typescript/builds/default/http/http.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ export type HttpFile = {
name: string
};

export type Headers = { [key: string]: string }


export class HttpException extends Error {
public constructor(msg: string) {
Expand All @@ -47,7 +49,7 @@ export type RequestBody = undefined | string | FormData | URLSearchParams;
* Represents an HTTP request context
*/
export class RequestContext {
private headers: { [key: string]: string } = {};
private headers: Headers = {};
private body: RequestBody = undefined;
private url: URLParse;

Expand All @@ -57,8 +59,9 @@ export class RequestContext {
* @param url url of the requested resource
* @param httpMethod http method
*/
public constructor(url: string, private httpMethod: HttpMethod) {
public constructor(url: string, private httpMethod: HttpMethod, headers: Headers = {}) {
this.url = new URLParse(url, true);
this.headers = headers;
}

/*
Expand Down Expand Up @@ -94,7 +97,7 @@ export class RequestContext {
return this.httpMethod;
}

public getHeaders(): { [key: string]: string } {
public getHeaders(): Headers {
return this.headers;
}

Expand Down
21 changes: 18 additions & 3 deletions samples/openapi3/client/petstore/typescript/builds/default/servers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
import { RequestContext, HttpMethod } from "./http/http";
import { RequestContext, HttpMethod, Headers } from "./http/http";

export interface BaseServerConfiguration {
getHeaders(): Headers
makeRequestContext(endpoint: string, httpMethod: HttpMethod): RequestContext;
setHeaders(headers: Headers): any;
setHeaderParam(key: string, value: string): void
}

/**
Expand All @@ -11,7 +14,7 @@ export interface BaseServerConfiguration {
*
*/
export class ServerConfiguration<T extends { [key: string]: string }> implements BaseServerConfiguration {
public constructor(private url: string, private variableConfiguration: T) {}
public constructor(private url: string, private variableConfiguration: T, private headers: Headers = {}) {}

/**
* Sets the value of the variables of this server.
Expand All @@ -26,6 +29,18 @@ export class ServerConfiguration<T extends { [key: string]: string }> implements
return this.variableConfiguration
}

public setHeaders(headers: Headers): void {
Object.assign(this.headers, headers);
}

public getHeaders(): Headers {
return this.headers
}

public setHeaderParam(key: string, value: string): void {
this.headers[key] = value;
}

private getUrl() {
let replacedUrl = this.url;
for (const key in this.variableConfiguration) {
Expand All @@ -44,7 +59,7 @@ export class ServerConfiguration<T extends { [key: string]: string }> implements
*
*/
public makeRequestContext(endpoint: string, httpMethod: HttpMethod): RequestContext {
return new RequestContext(this.getUrl() + endpoint, httpMethod);
return new RequestContext(this.getUrl() + endpoint, httpMethod, this.headers);
}
}

Expand Down
9 changes: 6 additions & 3 deletions samples/openapi3/client/petstore/typescript/builds/deno/http/http.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,8 @@ export enum HttpMethod {
*/
export type HttpFile = Blob & { readonly name: string };

export type Headers = { [key: string]: string }

/**
* URLParse Wrapper for Deno
*/
Expand Down Expand Up @@ -70,7 +72,7 @@ export type RequestBody = undefined | string | FormData | URLSearchParams;
* Represents an HTTP request context
*/
export class RequestContext {
private headers: { [key: string]: string } = {};
private headers: Headers = {};
private body: RequestBody = undefined;
private url: URLParse;

Expand All @@ -80,8 +82,9 @@ export class RequestContext {
* @param url url of the requested resource
* @param httpMethod http method
*/
public constructor(url: string, private httpMethod: HttpMethod) {
public constructor(url: string, private httpMethod: HttpMethod, headers: Headers = {}) {
this.url = new URLParse(url, true);
this.headers = headers;
}

/*
Expand Down Expand Up @@ -117,7 +120,7 @@ export class RequestContext {
return this.httpMethod;
}

public getHeaders(): { [key: string]: string } {
public getHeaders(): Headers {
return this.headers;
}

Expand Down
21 changes: 18 additions & 3 deletions samples/openapi3/client/petstore/typescript/builds/deno/servers.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,10 @@
import { RequestContext, HttpMethod } from "./http/http.ts";
import { RequestContext, HttpMethod, Headers } from "./http/http.ts";

export interface BaseServerConfiguration {
getHeaders(): Headers
makeRequestContext(endpoint: string, httpMethod: HttpMethod): RequestContext;
setHeaders(headers: Headers): any;
setHeaderParam(key: string, value: string): void
}

/**
Expand All @@ -11,7 +14,7 @@ export interface BaseServerConfiguration {
*
*/
export class ServerConfiguration<T extends { [key: string]: string }> implements BaseServerConfiguration {
public constructor(private url: string, private variableConfiguration: T) {}
public constructor(private url: string, private variableConfiguration: T, private headers: Headers = {}) {}

/**
* Sets the value of the variables of this server.
Expand All @@ -26,6 +29,18 @@ export class ServerConfiguration<T extends { [key: string]: string }> implements
return this.variableConfiguration
}

public setHeaders(headers: Headers): void {
Object.assign(this.headers, headers);
}

public getHeaders(): Headers {
return this.headers
}

public setHeaderParam(key: string, value: string): void {
this.headers[key] = value;
}

private getUrl() {
let replacedUrl = this.url;
for (const key in this.variableConfiguration) {
Expand All @@ -44,7 +59,7 @@ export class ServerConfiguration<T extends { [key: string]: string }> implements
*
*/
public makeRequestContext(endpoint: string, httpMethod: HttpMethod): RequestContext {
return new RequestContext(this.getUrl() + endpoint, httpMethod);
return new RequestContext(this.getUrl() + endpoint, httpMethod, this.headers);
}
}

Expand Down
9 changes: 6 additions & 3 deletions samples/openapi3/client/petstore/typescript/builds/inversify/http/http.ts
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,8 @@ export type HttpFile = {
name: string
};

export type Headers = { [key: string]: string }


export class HttpException extends Error {
public constructor(msg: string) {
Expand All @@ -47,7 +49,7 @@ export type RequestBody = undefined | string | FormData | URLSearchParams;
* Represents an HTTP request context
*/
export class RequestContext {
private headers: { [key: string]: string } = {};
private headers: Headers = {};
private body: RequestBody = undefined;
private url: URLParse;

Expand All @@ -57,8 +59,9 @@ export class RequestContext {
* @param url url of the requested resource
* @param httpMethod http method
*/
public constructor(url: string, private httpMethod: HttpMethod) {
public constructor(url: string, private httpMethod: HttpMethod, headers: Headers = {}) {
this.url = new URLParse(url, true);
this.headers = headers;
}

/*
Expand Down Expand Up @@ -94,7 +97,7 @@ export class RequestContext {
return this.httpMethod;
}

public getHeaders(): { [key: string]: string } {
public getHeaders(): Headers {
return this.headers;
}

Expand Down
Loading