Code
These are the endpoints used to retrieve system code: packages, classes and methods.
It is important to mention that the JSON objects returned by these endpoints should include common properties of every object
. This is used by Webside IDE to provide inspection services over objects of the meta-model (classes, methods, etc.). These are the common properties at the moment:
Endpoints
Method | Path | Description | Parameters | Payload |
---|---|---|---|---|
GET | Retrieve methods satisfying the condition specified in the query (or all the methods in the system if no condition is provided) |
| - | |
GET | Retrieve all subclasses of a given root class (if no root is provided, the uppermost class in the system is used). It is also possible get a tree-like structure as well as to limit the depth in the classes hierarchy |
| - | |
GET | Retrieve a given class | - | - | |
GET | Retrieve superclasses a given class | - | - | |
GET | Retrieve subclasses a given class | - | - | |
GET | Retrieve instance and class variables of a given class | - | - | |
GET | Retrieve instance variables of a given class | - | - | |
GET | Retrieve class variables of a given class | - | - | |
GET | Retrieve categories of a given class | - | - | |
GET | Retrieve categories used throughout the hierarchy of a given class | - | - | |
GET | Retrieve methods of a given class | - | - | |
GET | Retrieve selectors of a given class | - | - | |
GET | Retrieve the method with the given selector in the given class | - | - | |
GET | Retrieve all categories in the system | - | - | |
GET | Retrieve popular categories used throughout the system | - | - | |
GET | Retrieve all packages |
| - | |
GET | Retrieve a given package | - | - | |
GET | Retrieve actual classes of a given package |
| - | |
GET | Retrieve actual methods of a given package | - | - | |
GET | Perform a search on the system |
| - | |
GET | Retrieve completion entries for a given code, position and context | - | - | |
GET | Provide a class template |
| - | |
GET | Provide a method template | - | - | |
POST | Find a selector in a piece of source code | - | - |
Last updated