\DeploynautAPI
Entry point for the deploynaut API
/naut/api/projectname/
/naut/api/projectname/environmentname
Synopsis
class DeploynautAPI
extends APINoun
{
- // members
- private static array $url_handlers = ;
- public static array $allowed_actions = ;
- protected string $link = 'deploynaut/api';
- // Inherited members from APINoun
- protected controller $parent;
- protected DataObject $record;
- protected Member $member;
- // methods
- public string listProjects()
- public APIProject project()
- public APIEnvironment environment()
- protected DNProject getProject()
- protected DNEnvironment getEnvironment()
- public string Link()
- // Inherited methods from APINoun
- public void __construct()
- public void init()
- public DataObject getRecord()
- public Member getMember()
- protected SS_HTTPResponse getAPIResponse()
- protected boolean respondWithJSON()
- protected boolean respondWithText()
- protected array|null getRequestBody()
- protected SS_HTTPResponse message()
Hierarchy
Extends
Tasks
Line | Task |
---|---|
13+ | It might be good to break this out to a controller chain so that "/naut/api/projectname/environmentname" controller chain becomes DeploynautAPI > APIProject > APIEnvironment |
Members
private
-
$url_handlers
Default URL handlers - (Action)/(ID)//(OtherID)
protected
- $link — string
- $member — Member
- $parent — controller
- $record — DataObject
public
- $allowed_actions — array
Methods
protected
- getEnvironment() — Get environment from URL
- getProject() — Get project from URL
public
- Link()
- environment() — Controller Action
- listProjects()
- project() — Controller Action
Inherited from APINoun
protected
- getAPIResponse()
- getRequestBody()
- message() — Return a simple response with a message
- respondWithJSON()
- respondWithText()
public
- getMember()
- getRecord()
- init() — Enable basic auth on the API