#Script Pages

<back to all web services

QueryGitHubRepos

import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryBase:
    skip: Optional[int] = None
    take: Optional[int] = None
    order_by: Optional[str] = None
    order_by_desc: Optional[str] = None
    include: Optional[str] = None
    fields: Optional[str] = None
    meta: Optional[Dict[str, str]] = None


T = TypeVar('T')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryData(Generic[T], QueryBase, IReturn[QueryResponse[T]]):
    @staticmethod
    def response_type(): return QueryResponse[T]


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GithubUser:
    id: int = 0
    login: Optional[str] = None
    avatar__url: Optional[str] = None
    url: Optional[str] = None
    followers: Optional[int] = None
    following: Optional[int] = None
    type: Optional[str] = None
    public__gists: Optional[int] = None
    location: Optional[str] = None
    company: Optional[str] = None
    html__url: Optional[str] = None
    public__repos: Optional[int] = None
    created__at: Optional[datetime.datetime] = None
    blog: Optional[str] = None
    email: Optional[str] = None
    name: Optional[str] = None
    hireable: Optional[bool] = None
    gravatar__id: Optional[str] = None
    bio: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class GithubRepo:
    id: int = 0
    name: Optional[str] = None
    description: Optional[str] = None
    homepage: Optional[str] = None
    language: Optional[str] = None
    watchers__count: int = 0
    stargazes__count: int = 0
    forks__count: int = 0
    open__issues__count: int = 0
    size: int = 0
    full__name: Optional[str] = None
    created_at: datetime.datetime = datetime.datetime(1, 1, 1)
    pushed__at: Optional[datetime.datetime] = None
    updated__at: Optional[datetime.datetime] = None
    has_issues: bool = False
    has__downloads: bool = False
    has__wiki: bool = False
    has__pages: bool = False
    fork: bool = False
    owner: Optional[GithubUser] = None
    svn__url: Optional[str] = None
    mirror__url: Optional[str] = None
    url: Optional[str] = None
    ssh__url: Optional[str] = None
    html__url: Optional[str] = None
    clone__url: Optional[str] = None
    git__url: Optional[str] = None
    private: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryGitHubRepos(QueryData[GithubRepo]):
    user_name: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Order:
    order_id: int = 0
    customer_id: Optional[str] = None
    order_date: datetime.datetime = datetime.datetime(1, 1, 1)
    total: float = 0.0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Customer:
    customer_id: Optional[str] = None
    company_name: Optional[str] = None
    address: Optional[str] = None
    city: Optional[str] = None
    region: Optional[str] = None
    postal_code: Optional[str] = None
    country: Optional[str] = None
    phone: Optional[str] = None
    fax: Optional[str] = None
    orders: Optional[List[Order]] = None


Customer = TypeVar('Customer')


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class QueryResponse(Generic[Customer]):
    offset: int = 0
    total: int = 0
    results: Optional[List[Customer]] = None
    meta: Optional[Dict[str, str]] = None
    response_status: Optional[ResponseStatus] = None

Python QueryGitHubRepos DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + 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>