<commit_before>#labels Phase-Design
#Specification for Apollo Web Services

=1. Design Goals=
=2. System Requirements=
=3. Architecture=

==3.2 Apollo Web Service==
==3.3 Apollo Client Web Service==
===Implementation of an Apollo Client Web Service requires implementing the following methods:===
||*return value*||*method name*||*parameters*||
||int runId||run||RunRequestObjType||
||RunResponseObjType||getResults||int runId||
||RunStatusEnum||getStatus||int runId||
||SupportedTypeCollectionType||getUnregisteredParametersDescription||none||
||RunRequestObjType||getDefaultRunParametersObj||none||
||String description||getModelDescription||none||

Note 1: Prefix RunRequestObjType and RunResponseObjType with the type of used in the model that the web service is exposing.  (e.g. for an AgentBased model, RunRequestObjType would be renamed AgentBasedRunRequestObjType)
===Example implementation of an Apollo Client Web Service exposing an Agent Based Model===
||*return value*||*method name*||*parameters*||
||int runId||run||AgentBasedModelRunRequestObjType||
||AgentBasedModelRunResponseObjType||getResults||int runId||
||RunStatusEnum||getStatus||int runId||
||SupportedTypeCollectionType||getUnregisteredParametersDescription||none||
||AgentBasedModelRunRequestObjType||getDefaultRunParametersObj||none||
||String description||getModelDescription||none||


Note 2: Non-native classes are defined by this specification.  See Chapter 4 for a description of the non-native classes. 

=4. Classes=<commit_msg>Edited wiki page ApolloWebServicesSpecification through web user interface.<commit_after>#labels Phase-Design
#Specification for Apollo Web Services

=1. Design Goals=
==1.1 General==
  #  Future: Provide a unified API that can be used by both the Apollo Web Service and Apollo-Enabled Epidemic-Model Web Services
==1.2 Apollo Web Service==
  #  Provide facilities which allow desktop applications to inter-operate with multiple epidemic models connecting to a single endpoint
  #  Communicate (only) with implementations of the Apollo-Enabled Epidemic-Model Web Service, to:
    * submit run requests to epidemic models
    * check status of previous run requests
    * request results of previous runs
    * request the default configuration of an epidemic model 
  # Maintain a registry of available Apollo-Enabled Epidemic-Model Web Services
==1.3 Apollo-Enabled Epidemic-Model Web Service==
 
=2. System Requirements=
=3. Architecture=

==3.2 Apollo Web Service==
==3.3 Apollo Client Web Service==
===Implementation of an Apollo Client Web Service requires implementing the following methods:===
||*return value*||*method name*||*parameters*||
||int runId||run||RunRequestObjType||
||RunResponseObjType||getResults||int runId||
||RunStatusEnum||getStatus||int runId||
||SupportedTypeCollectionType||getUnregisteredParametersDescription||none||
||RunRequestObjType||getDefaultRunParametersObj||none||
||String description||getModelDescription||none||

Note 1: Prefix RunRequestObjType and RunResponseObjType with the type of used in the model that the web service is exposing.  (e.g. for an AgentBased model, RunRequestObjType would be renamed AgentBasedRunRequestObjType)
===Example implementation of an Apollo Client Web Service exposing an Agent Based Model===
||*return value*||*method name*||*parameters*||
||int runId||run||AgentBasedModelRunRequestObjType||
||AgentBasedModelRunResponseObjType||getResults||int runId||
||RunStatusEnum||getStatus||int runId||
||SupportedTypeCollectionType||getUnregisteredParametersDescription||none||
||AgentBasedModelRunRequestObjType||getDefaultRunParametersObj||none||
||String description||getModelDescription||none||


Note 2: Non-native classes are defined by this specification.  See Chapter 4 for a description of the non-native classes. 

=4. Classes=
{'fraction_non_alphanumeric': 0.10267155578837088, 'fraction_numerical': 0.007333682556312206, 'mean_word_length': 7.524553571428571, 'pattern_counts': {'":': 0, '<': 3, '<?xml version=': 0, '>': 3, 'https://': 0, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '5438058', 'n_tokens_mistral': 1036, 'n_tokens_neox': 967, 'n_words': 351}