Skip to content

Commit 0809f26

Browse files
pathawkspathawks
committed
Copy all chapters from OpenOffice file
1 parent d416ee5 commit 0809f26

11 files changed

Lines changed: 1514 additions & 8 deletions

‎WebInterface.tex‎

Lines changed: 2 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,12 +3,13 @@
33
\usepackage[colorlinks=true,urlcolor=blue,linkcolor=black,pdftitle=StarExec\ Web\ Interface]{hyperref}
44
\usepackage{enumitem}
55
\usepackage{xcolor}
6+
\usepackage[T1]{fontenc}
67
\setlist[description]{leftmargin=\parindent,labelindent=\parindent}
78
\usepackage{titlesec}
89
\titleformat{\chapter}{}{}{0pt}{\bfseries\LARGE\ifnum\value{chapter}>0\relax\arabic{chapter}\ \ \ ~\fi}
910
\begin{document}
1011
\newcommand{\type}[1]{\emph{\color{gray}#1}\ --\ }
11-
\newcommand{\relurl}[1]{\href{https://www.starexec.org/starexec/secure/#1}{#1}}
12+
\newcommand{\relurl}[1]{\href{https://www.starexec.org/starexec/secure/#1}{\texttt{#1}}}
1213
\newcommand{\servicesurl}[1]{\href{https://www.starexec.org/starexec/#1}{#1}}
1314

1415
\title{StarExec Web Interface}

‎chapters/01Introduction.tex‎

Lines changed: 7 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@ \section{Using the URLs}
44
Except for noted exceptions, URLs documented in the functions below are suffixes of the following URL, which points to the secure resources of Starexec.
55
\\\url{https://www.starexec.org/starexec/secure/}\\
66

7-
The largest exception to this is that all URLs that begin with ?services? do not have the ?secure? prefix. So, any URL that begins with services/ is a suffix of the following URL.
7+
The largest exception to this is that all URLs that begin with ``services'' do not have the ``secure'' prefix. So, any URL that begins with services/ is a suffix of the following URL.
88
\\\url{https://www.starexec.org/starexec/}\\
99

1010
Other exceptions are noted where applicable in the function documentation.
@@ -14,7 +14,7 @@ \section{Logging In}
1414

1515
To be able to access Starexec resources, you will need to log into Starexec and maintain a secure channel. Logging in is a multistep protocol, with 3 main steps. First, authorization works on a challenge-based system, which means you cannot log in until you request a secure resource. Next, you must provide your username and password, and finally, you will access a secure resource.
1616

17-
\subsection{First Step -- Requesting a Secure Resource}
17+
\subsection*{First Step -- Requesting a Secure Resource}
1818

1919
\begin{description}
2020
\item [URL] \relurl{index.jsp}
@@ -28,7 +28,7 @@ \subsection{First Step -- Requesting a Secure Resource}
2828
\end{description}
2929
\end{description}
3030

31-
\subsection{Second Step -- Providing Login Credentials}
31+
\subsection*{Second Step -- Providing Login Credentials}
3232

3333
\begin{description}
3434
\item [URL] \relurl{j\_security\_check}
@@ -45,7 +45,7 @@ \subsection{Second Step -- Providing Login Credentials}
4545
\item [Returns] A jSON string containing a status object
4646
\end{description}
4747

48-
\subsection{Third Step -- Accessing Secure Resources}
48+
\subsection*{Third Step -- Accessing Secure Resources}
4949

5050
\begin{description}
5151
\item [URL] \relurl{index.jsp}
@@ -62,9 +62,9 @@ \section{Maintaining a Session}
6262
After you have logged in, you must maintain a session for as long as you want to make requests to the secure resources of Starexec. To maintain a session, your HTTP requests should have the following header keys with the appropriate values.
6363

6464
\begin{description}
65-
\item [Cookie] \type{String} Should contain a string of the form ``killmenothing; JSESSIONID=" + your JSESSIONID obtained when logging in.
66-
\item [Connection] \type{String} Should be ``keep-alive"
67-
\item [Accept-Language] \type{String} Should be ``en-US,en;q=0.5"
65+
\item [Cookie] \type{String} Should contain a string of the form ``killmenothing; JSESSIONID='' + your JSESSIONID obtained when logging in.
66+
\item [Connection] \type{String} Should be ``keep-alive''
67+
\item [Accept-Language] \type{String} Should be ``en-US,en;q=0.5''
6868
\end{description}
6969

7070
\section{Permissions}

‎chapters/02Spaces.tex‎

Lines changed: 198 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1 +1,199 @@
11
\chapter{Spaces}
2+
3+
\section{Add Space}
4+
\begin{description}
5+
\item [URL] \relurl{{add/space}}
6+
\item [Method] POST
7+
\item [Parameter Encoding] application/x-www-form-urlencoded
8+
\item [Parameters] \
9+
\begin{description}
10+
\item [parent] \type{Integer} The ID of the parent space of this new space.
11+
\item [name] \type{String} The new space name
12+
\item [desc] \type{String} The new space description
13+
\item [locked] \type{Boolean} Whether the space should be locked
14+
\item [users] \type{Boolean} True to inherit all users from the parent space and false otherwise.
15+
\item [sticky] \type{Boolean} Whether the new space should have sticky leaders set
16+
\item [+ all permissions parameters except isLeader (see the permissions section)] Specifies the default permissions for new users being added to the space.
17+
\end{description}
18+
\item [Description] Creates a new space using the given attributes.
19+
\item [Returns] An HTTP message with 200 status on success, and an HTTP message with an error status on failure.
20+
\item [Return Cookies] \
21+
\begin{description}
22+
\item [New\_ID] \type{Integer} On success, contains the ID of the newly created space.
23+
\item [STATUS\_MESSAGE\_STRING] \type{Integer} On failure, contains an error message.
24+
\end{description}
25+
\end{description}
26+
27+
\section{Upload Space XML}
28+
\begin{description}
29+
\item [URL] \relurl{{upload/space}}
30+
\item [Method] POST
31+
\item [Parameter Encoding] multipart/form-data
32+
\item [Parameters] \
33+
\begin{description}
34+
\item [space] \type{Integer} The ID of the space to use as the parent space for the new upload
35+
\item [f] \type{File} The archive file containing the space XML.
36+
\end{description}
37+
\item [Description] Uploads a space XML file and creates new spaces based on the XML
38+
\item [Returns] An HTTP redirect to the upload status page on success, and an HTTP message with an error status on failure.
39+
\item [Return Cookies] \
40+
\begin{description}
41+
\item [STATUS\_MESSAGE\_STRING] \type{Integer} On failure, contains an error message.
42+
\end{description}
43+
\end{description}
44+
45+
\section{Download Space}
46+
\begin{description}
47+
\item [URL] \relurl{{download}}
48+
\item [Method] GET
49+
\item [Parameter Encoding] application/x-www-form-urlencoded
50+
\item [Parameters] \
51+
\begin{description}
52+
\item [type] \type{String} Should be ``space''
53+
\item [id] \type{Integer} The ID of the space to download.
54+
\item [includesolvers] \type{Boolean} Whether to include solvers in the download.
55+
\item [includebenchmarks] \type{Boolean} Whether to include benchmarks in the download.
56+
\item [hierarchy] \type{Boolean} True to download the space hierarchy rooted at the given space, and false to download only the given space.
57+
\end{description}
58+
\item [Description] Makes a request to download an archive containing a directory representation of a space or space hierarchy, optionally including all the solvers and benchmarks in the spaces.
59+
\item [Returns] An HTTP response with an output stream for the request archive on success. On failure, the response will contain an HTTP error code and a page with an error message.
60+
\item [Return Cookies] \
61+
\begin{description}
62+
\item [STATUS\_MESSAGE\_STRING] \type{Integer} On failure, contains an error message.
63+
\end{description}
64+
\end{description}
65+
66+
\section{Download Space XML}
67+
\begin{description}
68+
\item [URL] \relurl{{download}}
69+
\item [Method] GET
70+
\item [Parameter Encoding] application/x-www-form-urlencoded
71+
\item [Parameters] \
72+
\begin{description}
73+
\item [type] \type{String} Should be ``spaceXML''
74+
\item [id] \type{Integer} The ID of the space to get the XML for.
75+
\item [includeattrs] \type{Boolean} Whether to include benchmark attributes in the XML.
76+
\item [updates] \type{Boolean} Whether to include benchmark update tags in the XML.
77+
\item [upid] \type{Integer} The ID of the update processor to include for all the update tags. Applies only if updates is true.
78+
\end{description}
79+
\item [Description] Makes a request to download an archive containing the XML representation of a space hierarchy.
80+
\item [Returns] An HTTP response with an output stream for the request archive on success. On failure, the response will contain an HTTP error code and a page with an error message.
81+
\item [Return Cookies] \
82+
\begin{description}
83+
\item [STATUS\_MESSAGE\_STRING] \type{Integer} On failure, contains an error message.
84+
\end{description}
85+
\end{description}
86+
87+
\section{Copy Spaces}
88+
\begin{description}
89+
\item [URL] \servicesurl{services/spaces/\{spaceId\}/copySpace}
90+
\item [URL Variables] \
91+
\begin{description}
92+
\item [spaceId] \type{Integer} The ID of the space that you want to copy other spaces into
93+
\end{description}
94+
\item [Method] POST
95+
\item [Parameter Encoding] application/x-www-form-urlencoded
96+
\item [Parameters] \
97+
\begin{description}
98+
\item [selectedIds] \type{Integer List} A list of space IDs, where each space will be copied into the destination space
99+
\item [copyHierarchy] \type{Boolean} True to copy entire space hierarchies into the destination space. False to copy only the spaces in selectedIds without their hierarchies.
100+
\end{description}
101+
\item [Description] Copies spaces into a single destination space. All benchmarks, solvers, and jobs will be linked into the newly created spaces.
102+
\item [Returns] A jSON string containing a status object.
103+
\item [Return Cookies] \
104+
\begin{description}
105+
\item [New\_ID] \type{Integer} A comma-separated list of the new space IDs.
106+
\end{description}
107+
\end{description}
108+
109+
\section{Link all Orphaned Primitives to Space}
110+
\begin{description}
111+
\item [URL] \servicesurl{services/linkAllOrphaned/\{userId\}/\{spaceId\}}
112+
\item [URL Variables] \
113+
\begin{description}
114+
\item [userId] \type{Integer} Your user ID
115+
\item [spaceId] \type{Integer} The ID of the space to place all of the orphaned primitives into.
116+
\end{description}
117+
\item [Method] POST
118+
\item [Description] Links all “orphaned” solvers, benchmarks, and jobs that you own in the given space.
119+
\item [Returns] A jSON string containing a status object.
120+
\end{description}
121+
122+
\section{Edit Space Attributes}
123+
\begin{description}
124+
\item [URL] \servicesurl{services/edit/space/\{spaceId\}}
125+
\item [URL Variables] \
126+
\begin{description}
127+
\item [spaceId] \type{Integer} The ID of the space to edit
128+
\end{description}
129+
\item [Method] POST
130+
\item [Parameter Encoding] application/x-www-form-urlencoded
131+
\item [Parameters] \
132+
\begin{description}
133+
\item [name] \type{String} The new space name
134+
\item [description] \type{String} The new space description
135+
\item [locked] \type{Boolean} Whether the space should be locked
136+
\item [sticky] \type{Boolean} Whether the new space should have sticky leaders set
137+
\item [+ all permissions parameters except isLeader (see the permissions section)] Specifies the default permissions for new users being added to the space.
138+
\end{description}
139+
\item [Description] Edits an existing space by providing a new values for all space attributes
140+
\item [Returns] A jSON string containing a status object.
141+
\end{description}
142+
143+
\section{Edit Single Space Attribute}
144+
\begin{description}
145+
\item [URL] \servicesurl{services/edit/space/\{attr\}/\{spaceId\}}
146+
\item [URL Variables] \
147+
\begin{description}
148+
\item [attr] \type{String} The attribute to edit. Can be ``name'' or ``description''
149+
\item [spaceId] \type{Integer} The ID of the space to edit
150+
\end{description}
151+
\item [Method] POST
152+
\item [Parameter Encoding] application/x-www-form-urlencoded
153+
\item [Parameters] \
154+
\begin{description}
155+
\item [val] \type{String} The new value to use for the given attribute
156+
\end{description}
157+
\item [Description] Edits an existing space by providing a new value for the given attribute
158+
\item [Returns] A jSON string containing a status object.
159+
\end{description}
160+
161+
\section{View Space Visibility}
162+
\begin{description}
163+
\item [URL] \servicesurl{services/space/isSpacePublic/\{spaceId\}}
164+
\item [URL Variables] \
165+
\begin{description}
166+
\item [spaceId] \type{Integer} The ID of the space to check visibility of.
167+
\end{description}
168+
\item [Method] POST
169+
\item [Description] Checks whether the given space is public or private.
170+
\item [Returns] A jSON string containing 1 if the space is public and 0 otherwise.
171+
\end{description}
172+
173+
\section{Edit Space Visibility}
174+
\begin{description}
175+
\item [URL] \servicesurl{services/space/changePublic/\{spaceId\}/\{hierarchy\}/\{makePublic\}}
176+
\item [URL Variables] \
177+
\begin{description}
178+
\item [spaceId] \type{Integer} The ID of the space to edit.
179+
\item [hierarchy] \type{Boolean} True to edit the entire space hierarchy and false to edit the single space.
180+
\item [makePublic] \type{Boolean} True to make spaces public and false to make them private
181+
\end{description}
182+
\item [Method] POST
183+
\item [Description] Sets the given space, and optionally the full space hierarchy rooted there, to either public or private.
184+
\item [Returns] A jSON string containing a status object.
185+
\end{description}
186+
187+
\section{Remove Spaces}
188+
\begin{description}
189+
\item [URL] \servicesurl{services/remove/subspace}
190+
\item [Method] POST
191+
\item [Parameter Encoding] application/x-www-form-urlencoded
192+
\item [Parameters] \
193+
\begin{description}
194+
\item [{selectedIds[]}] \type{Integer List} The list of space IDs to use
195+
\item [recyclePrims] \type{Boolean} If true, all solvers and benchmarks located anywhere in any space hierarchy being removed will be recycled. Only solvers and benchmarks that you have permission to edit will be recycled.
196+
\end{description}
197+
\item [Description] Removes all the given spaces, including their full space hierarchies.
198+
\item [Returns] A jSON string containing a status object.
199+
\end{description}

0 commit comments

Comments
 (0)