"use strict";
export class QueryBase {
/** @param {{skip?:number,take?:number,orderBy?:string,orderByDesc?:string,include?:string,fields?:string,meta?:{ [index: string]: string; }}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?number} */
skip;
/** @type {?number} */
take;
/** @type {string} */
orderBy;
/** @type {string} */
orderByDesc;
/** @type {string} */
include;
/** @type {string} */
fields;
/** @type {{ [index: string]: string; }} */
meta;
}
/** @typedef T {any} */
export class QueryData extends QueryBase {
/** @param {{skip?:number,take?:number,orderBy?:string,orderByDesc?:string,include?:string,fields?:string,meta?:{ [index: string]: string; }}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
}
export class GithubUser {
/** @param {{id?:number,login?:string,avatar_Url?:string,url?:string,followers?:number,following?:number,type?:string,public_Gists?:number,location?:string,company?:string,html_Url?:string,public_Repos?:number,created_At?:string,blog?:string,email?:string,name?:string,hireable?:boolean,gravatar_Id?:string,bio?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
id;
/** @type {string} */
login;
/** @type {string} */
avatar_Url;
/** @type {string} */
url;
/** @type {?number} */
followers;
/** @type {?number} */
following;
/** @type {string} */
type;
/** @type {?number} */
public_Gists;
/** @type {string} */
location;
/** @type {string} */
company;
/** @type {string} */
html_Url;
/** @type {?number} */
public_Repos;
/** @type {?string} */
created_At;
/** @type {string} */
blog;
/** @type {string} */
email;
/** @type {string} */
name;
/** @type {?boolean} */
hireable;
/** @type {string} */
gravatar_Id;
/** @type {string} */
bio;
}
export class GithubRepo {
/** @param {{id?:number,name?:string,description?:string,homepage?:string,language?:string,watchers_Count?:number,stargazes_Count?:number,forks_Count?:number,open_Issues_Count?:number,size?:number,full_Name?:string,created_at?:string,pushed_At?:string,updated_At?:string,has_issues?:boolean,has_Downloads?:boolean,has_Wiki?:boolean,has_Pages?:boolean,fork?:boolean,owner?:GithubUser,svn_Url?:string,mirror_Url?:string,url?:string,ssh_Url?:string,html_Url?:string,clone_Url?:string,git_Url?:string,private?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
id;
/** @type {string} */
name;
/** @type {string} */
description;
/** @type {string} */
homepage;
/** @type {string} */
language;
/** @type {number} */
watchers_Count;
/** @type {number} */
stargazes_Count;
/** @type {number} */
forks_Count;
/** @type {number} */
open_Issues_Count;
/** @type {number} */
size;
/** @type {string} */
full_Name;
/** @type {string} */
created_at;
/** @type {?string} */
pushed_At;
/** @type {?string} */
updated_At;
/** @type {boolean} */
has_issues;
/** @type {boolean} */
has_Downloads;
/** @type {boolean} */
has_Wiki;
/** @type {boolean} */
has_Pages;
/** @type {boolean} */
fork;
/** @type {GithubUser} */
owner;
/** @type {string} */
svn_Url;
/** @type {string} */
mirror_Url;
/** @type {string} */
url;
/** @type {string} */
ssh_Url;
/** @type {string} */
html_Url;
/** @type {string} */
clone_Url;
/** @type {string} */
git_Url;
/** @type {boolean} */
private;
}
export class QueryGitHubRepos extends QueryData {
/** @param {{userName?:string,skip?:number,take?:number,orderBy?:string,orderByDesc?:string,include?:string,fields?:string,meta?:{ [index: string]: string; }}} [init] */
constructor(init) { super(init); Object.assign(this, init) }
/** @type {string} */
userName;
}
export class Order {
/** @param {{orderId?:number,customerId?:string,orderDate?:string,total?:number}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
orderId;
/** @type {string} */
customerId;
/** @type {string} */
orderDate;
/** @type {number} */
total;
}
export class Customer {
/** @param {{customerId?:string,companyName?:string,address?:string,city?:string,region?:string,postalCode?:string,country?:string,phone?:string,fax?:string,orders?:Order[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
customerId;
/** @type {string} */
companyName;
/** @type {string} */
address;
/** @type {string} */
city;
/** @type {string} */
region;
/** @type {string} */
postalCode;
/** @type {string} */
country;
/** @type {string} */
phone;
/** @type {string} */
fax;
/** @type {Order[]} */
orders;
}
/** @typedef T {any} */
export class QueryResponse {
/** @param {{offset?:number,total?:number,results?:T[],meta?:{ [index: string]: string; },responseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
offset;
/** @type {number} */
total;
/** @type {T[]} */
results;
/** @type {{ [index: string]: string; }} */
meta;
/** @type {ResponseStatus} */
responseStatus;
}
JavaScript QueryGitHubRepos DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /xml/reply/QueryGitHubRepos HTTP/1.1
Host: sharpscript.net
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<QueryGitHubRepos xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SharpScript">
<Skip xmlns="http://schemas.servicestack.net/types">0</Skip>
<Take xmlns="http://schemas.servicestack.net/types">0</Take>
<OrderBy xmlns="http://schemas.servicestack.net/types">String</OrderBy>
<OrderByDesc xmlns="http://schemas.servicestack.net/types">String</OrderByDesc>
<Include xmlns="http://schemas.servicestack.net/types">String</Include>
<Fields xmlns="http://schemas.servicestack.net/types">String</Fields>
<Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays" xmlns="http://schemas.servicestack.net/types">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>String</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</Meta>
<UserName>String</UserName>
</QueryGitHubRepos>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<QueryResponseOfGithubRepoA703xr44 xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.servicestack.net/types">
<Offset>0</Offset>
<Total>0</Total>
<Results xmlns:d2p1="http://schemas.datacontract.org/2004/07/SharpScript">
<d2p1:GithubRepo>
<d2p1:Clone_Url>String</d2p1:Clone_Url>
<d2p1:Created_at>0001-01-01T00:00:00</d2p1:Created_at>
<d2p1:Description>String</d2p1:Description>
<d2p1:Fork>false</d2p1:Fork>
<d2p1:Forks_Count>0</d2p1:Forks_Count>
<d2p1:Full_Name>String</d2p1:Full_Name>
<d2p1:Git_Url>String</d2p1:Git_Url>
<d2p1:Has_Downloads>false</d2p1:Has_Downloads>
<d2p1:Has_Pages>false</d2p1:Has_Pages>
<d2p1:Has_Wiki>false</d2p1:Has_Wiki>
<d2p1:Has_issues>false</d2p1:Has_issues>
<d2p1:Homepage>String</d2p1:Homepage>
<d2p1:Html_Url>String</d2p1:Html_Url>
<d2p1:Id>0</d2p1:Id>
<d2p1:Language>String</d2p1:Language>
<d2p1:Mirror_Url>String</d2p1:Mirror_Url>
<d2p1:Name>String</d2p1:Name>
<d2p1:Open_Issues_Count>0</d2p1:Open_Issues_Count>
<d2p1:Owner>
<d2p1:Avatar_Url>String</d2p1:Avatar_Url>
<d2p1:Bio>String</d2p1:Bio>
<d2p1:Blog>String</d2p1:Blog>
<d2p1:Company>String</d2p1:Company>
<d2p1:Created_At>0001-01-01T00:00:00</d2p1:Created_At>
<d2p1:Email>String</d2p1:Email>
<d2p1:Followers>0</d2p1:Followers>
<d2p1:Following>0</d2p1:Following>
<d2p1:Gravatar_Id>String</d2p1:Gravatar_Id>
<d2p1:Hireable>false</d2p1:Hireable>
<d2p1:Html_Url>String</d2p1:Html_Url>
<d2p1:Id>0</d2p1:Id>
<d2p1:Location>String</d2p1:Location>
<d2p1:Login>String</d2p1:Login>
<d2p1:Name>String</d2p1:Name>
<d2p1:Public_Gists>0</d2p1:Public_Gists>
<d2p1:Public_Repos>0</d2p1:Public_Repos>
<d2p1:Type>String</d2p1:Type>
<d2p1:Url>String</d2p1:Url>
</d2p1:Owner>
<d2p1:Private>false</d2p1:Private>
<d2p1:Pushed_At>0001-01-01T00:00:00</d2p1:Pushed_At>
<d2p1:Size>0</d2p1:Size>
<d2p1:Ssh_Url>String</d2p1:Ssh_Url>
<d2p1:Stargazes_Count>0</d2p1:Stargazes_Count>
<d2p1:Svn_Url>String</d2p1:Svn_Url>
<d2p1:Updated_At>0001-01-01T00:00:00</d2p1:Updated_At>
<d2p1:Url>String</d2p1:Url>
<d2p1:Watchers_Count>0</d2p1:Watchers_Count>
</d2p1:GithubRepo>
</Results>
<Meta xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:KeyValueOfstringstring>
<d2p1:Key>String</d2p1:Key>
<d2p1:Value>String</d2p1:Value>
</d2p1:KeyValueOfstringstring>
</Meta>
<ResponseStatus>
<ErrorCode>String</ErrorCode>
<Message>String</Message>
<StackTrace>String</StackTrace>
<Errors>
<ResponseError>
<ErrorCode>String</ErrorCode>
<FieldName>String</FieldName>
<Message>String</Message>
<Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</Meta>
</ResponseError>
</Errors>
<Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</Meta>
</ResponseStatus>
</QueryResponseOfGithubRepoA703xr44>