@cparra/apexdocs 3.0.0 → 3.1.1

package/examples/markdown-jsconfig/sfdx-project.json

@@ -1,12 +0,0 @@
-{
-  "packageDirectories": [
-    {
-      "path": "force-app",
-      "default": true
-    }
-  ],
-  "name": "plain-markdown",
-  "namespace": "",
-  "sfdcLoginUrl": "https://login.salesforce.com",
-  "sourceApiVersion": "59.0"
-}

package/examples/open-api/README.md

@@ -1,5 +0,0 @@
-# OpenApi Example
-
-This project contains an example for generating OpenAPI documentation from your Apex source code.
-
-The configuration can be found in the `package.json` file, under the `apexdocs` key.

package/examples/open-api/config/project-scratch-def.json

@@ -1,13 +0,0 @@
-{
-  "orgName": "openapi example",
-  "edition": "Developer",
-  "features": ["EnableSetPasswordInApi"],
-  "settings": {
-    "lightningExperienceSettings": {
-      "enableS1DesktopEnabled": true
-    },
-    "mobileSettings": {
-      "enableS1EncryptedStoragePref2": false
-    }
-  }
-}

package/examples/open-api/docs/openapi.json

@@ -1,14 +0,0 @@
-{
-  "openapi": "3.1.0",
-  "info": {
-    "title": "Open API Example",
-    "version": "3.0.0"
-  },
-  "servers": [
-    {
-      "url": "/services/apexrest/openapi/"
-    }
-  ],
-  "paths": {},
-  "tags": []
-}

package/examples/open-api/force-app/main/default/classes/ChildClass.cls

@@ -1,42 +0,0 @@
-/**
- * @description Some desc
- * @group Classes
- */
-public class ChildClass extends ParentClass implements SampleInterface {
-    private String privateStringFromChild;
-    private String aPrivateString;
-
-    public void doSomething() {
-        System.debug('Do something');
-    }
-
-    /**
-     * @description This method was overridden.
-     * @return A String.
-     * @mermaid
-     * sequenceDiagram
-     *     participant dotcom
-     *     participant iframe
-     *     participant viewscreen
-     *     dotcom->>iframe: loads html w/ iframe url
-     *     iframe->>viewscreen: request template
-     *     viewscreen->>iframe: html & javascript
-     *     iframe->>dotcom: iframe ready
-     *     dotcom->>iframe: set mermaid data on iframe
-     *     iframe->>iframe: render mermaid
-     */
-    public override String overridableMethodOverridden() {
-        return null ?? '';
-    }
-
-    /**
-     * @description Executes the command.
-     */
-    public void execute();
-
-    /**
-     * @description Returns a value based on the executed command.
-     * @return The value
-     */
-    public String getValue();
-}

package/examples/open-api/force-app/main/default/classes/SampleClass.cls

@@ -1,167 +0,0 @@
-
-/**
- * @description This is a class description. This class relates to {@link SampleInterface}
- *              But this {@link ClassThatDoesNotExist} does not exist.
- *              You can also link using this syntax <<SampleInterface>>
- * @group Main
- * @CustomAnnotation A Custom annotation
- * @author Cesar Parra
- * @see SampleInterface
- */
-@NamespaceAccessible
-public virtual with sharing class SampleClass {
-    /**
-     * @description This is a namespace accessible enum
-     */
-    @NamespaceAccessible
-    public enum InnerEnum {
-        A,
-        B,
-        C
-    }
-
-    // @start-group Common Constants
-
-    public List<String> listOfStrings;
-
-    /**
-     * @description This is a constant.
-     */
-    @NamespaceAccessible
-    public static final String A_CONSTANT = 'My Constant Value';
-    public static final String ANOTHER_CONSTANT = 'My Constant Value';
-    // @end-group
-
-    // @start-group 'General' Constants
-    /**
-     * @description This is a constant.
-     */
-    @NamespaceAccessible
-    public static final String GENERAL_A_CONSTANT = 'My Constant Value';
-    public static final String GENERAL_ANOTHER_CONSTANT = 'My Constant Value';
-    // @end-group
-
-    // @start-group Other variables
-    public String someVariable = 'test';
-    // @end-group
-
-    // @start-group My Super Group
-    /**
-     * @description Constructs a SampleClass without any arguments. This relates to {@link SampleInterface}
-     * @throws ExcName some exception
-     * @CustomAnnotation A Custom method annotation
-     * @see SampleInterface
-     * @example
-     * // Example
-     * SampleClass sampleInstance = new SampleClass();
-     */
-    @NamespaceAccessible
-    public SampleClass() {
-        System.debug('Constructor');
-    }
-    // @end-group
-
-    /**
-     * @description Constructs a SampleClass with an argument.
-     * @param argument1 Argument1 definition
-     * @param argument2 Argument2 definition
-     */
-    public SampleClass(String argument1, String argument2) {
-        System.debug('Constructor');
-    }
-
-
-    // @start-group A method group
-    /**
-     * @description Executes commands based on the passed in argument.
-     * @example
-     * String result = SampleClass.testMethod();
-     * System.debug(result);
-     * @param argument1 Argument1 to debug
-     * @param argument2 Argument2 to debug
-     * @return Empty string
-     */
-    @NamespaceAccessible
-    public static String sampleMethod(String argument1, String argument2) {
-        System.debug('Execute');
-        return '';
-    }
-
-    /**
-     * @description Something here
-     * @arg1 The arg1 description
-     */
-    public static String anotherSampleMethod(String arg1) {
-        System.debug('something');
-        return '';
-    }
-
-    public static Map<Id, List<String>> yetAnotherSampleMethod(String arg1) {
-        System.debug('something');
-        return new Map<Id, List<String>>();
-    }
-    // @end-group
-
-
-    /**
-     * @description Calls the method.
-     * This methods allows you to call it.
-     */
-    public static void call() {
-    }
-
-    /**
-     * @description This is a String property.
-     */
-    @AuraEnabled
-    @Deprecated
-    public String MyProp { get; set; }
-
-    /**
-     * @description This is a Decimal property.
-     */
-    @AuraEnabled
-    public Decimal AnotherProp { get; private set; }
-
-    private String somePrivateStuff;
-
-    /**
-     * @description Inner class belonging to SampleClass.
-     */
-    public class InnerClass {
-        /**
-         * @description Description of the inner property.
-         */
-        public String InnerProp {
-            get;
-            set;
-        }
-
-        /**
-         * @description Executes from the inner class.
-         */
-        public void innerMethod() {
-            System.debug('Executing inner method.');
-        }
-    }
-
-    /**
-     * @description Inner class belonging to SampleClass.
-     */
-    public class AnotherInnerClass {
-        /**
-         * @description Description of the inner property.
-         */
-        public String InnerProp {
-            get;
-            set;
-        }
-
-        /**
-         * @description Executes from the inner class.
-         */
-        public void innerMethod() {
-            System.debug('Executing inner method.');
-        }
-    }
-}

package/examples/open-api/force-app/main/default/restapi/SampleRestResource.cls

@@ -1,195 +0,0 @@
-/**
- * @description Account related operations
- */
-@RestResource(UrlMapping='/AccountService/*')
-global with sharing class SampleRestResource {
-    /**
-     * @description Sample HTTP Delete method with references to other types.
-     * @http-parameter
-     * name: limit
-     * in: header
-     * required: true
-     * description: My sample description.
-     * schema: SampleClass
-     * @http-response
-     * statusCode: 200
-     * schema: SampleClass
-     * @http-response
-     * statusCode: 500
-     * schema: SampleClass
-     * @http-response
-     * statusCode: 304
-     * schema: ChildClass
-     * @http-response
-     * statusCode: 305
-     * schema: Reference1
-     * @http-response
-     * statusCode: 306
-     * schema: List<Reference1>
-     * @http-response
-     * statusCode: 307
-     * schema: Reference7[untypedObject:Reference2]
-     */
-    @HttpDelete
-    global static void doDelete() {
-        RestRequest req = RestContext.request;
-        RestResponse res = RestContext.response;
-        String accountId = req.requestURI.substring(req.requestURI.lastIndexOf('/') + 1);
-        Account account = [SELECT Id FROM Account WHERE Id = :accountId];
-        delete account;
-    }
-
-    /**
-     * @description This is a sample HTTP Get method
-     * @return An Account SObject.
-     * @http-parameter
-     * name: limit
-     * in: query
-     * required: true
-     * description: Limits the number of items on a page
-     * schema:
-     *   type: integer
-     * @http-parameter
-     * name: complex
-     * in: cookie
-     * description: A more complex schema
-     * schema:
-     *   type: array
-     *   items:
-     *     type: object
-     *     properties:
-     *       name:
-     *         type: string
-     * @http-response
-     * statusCode: 200
-     * schema:
-     *   type: object
-     *   properties:
-     *     id:
-     *       type: string
-     *       description: The super Id.
-     *     name:
-     *       type: string
-     *     phone:
-     *       type: string
-     *       format: byte
-     * @http-response
-     * statusCode: 500
-     * schema:
-     *   type: string
-     * @http-response
-     * statusCode: 304
-     * schema:
-     *   type: object
-     *   properties:
-     *     error:
-     *       type: string
-     * @http-response
-     * statusCode: 400
-     * schema:
-     *   type: array
-     *   items:
-     *     type: object
-     *     properties:
-     *       name:
-     *         type: string
-     * @http-response
-     * statusCode: 100
-     * schema:
-     *   type: object
-     *   properties:
-     *     anotherObject:
-     *       description: An object inside of an object
-     *       type: object
-     *       properties:
-     *         message:
-     *           type: string
-     *         somethingElse:
-     *           type: number
-     */
-    @HttpGet
-    global static Account doGet() {
-        RestRequest req = RestContext.request;
-        RestResponse res = RestContext.response;
-        String accountId = req.requestURI.substring(req.requestURI.lastIndexOf('/') + 1);
-        Account result = [SELECT Id, Name, Phone, Website FROM Account WHERE Id = :accountId];
-        return result;
-    }
-
-    /**
-     * @summary Posts an Account 2
-     * @description This is a sample HTTP Post method
-     * @return A String SObject.
-     * @http-parameter
-     * name: limit
-     * in: query
-     * required: true
-     * description: Limits the number of items on a page
-     * schema:
-     *   type: integer
-     * @http-parameter
-     * name: complex
-     * in: cookie
-     * description: A more complex schema
-     * schema:
-     *   type: array
-     *   items:
-     *     type: object
-     *     properties:
-     *       name:
-     *         type: string
-     * @http-request-body
-     * description: This is an example of a request body
-     * required: true
-     * schema:
-     *   type: array
-     *   items:
-     *     type: object
-     *     properties:
-     *       name:
-     *         type: string
-     * @http-response
-     * statusCode: 200
-     * schema:
-     *   type: object
-     *   properties:
-     *     id:
-     *       type: string
-     *       description: The super Id.
-     *     name:
-     *       type: string
-     *     phone:
-     *       type: string
-     *       format: byte
-     * @http-response
-     * statusCode: 500
-     * schema:
-     *   type: string
-     * @http-response
-     * statusCode: 304
-     * schema:
-     *   type: object
-     *   properties:
-     *     error:
-     *       type: string
-     * @http-response
-     * statusCode: 400
-     * schema:
-     *   type: array
-     *   items:
-     *     type: object
-     *     properties:
-     *       name:
-     *         type: string
-     */
-    @HttpPost
-    global static String doPost(String name,
-        String phone, String website) {
-        Account account = new Account();
-        account.Name = name;
-        account.phone = phone;
-        account.website = website;
-        insert account;
-        return account.Id;
-    }
-}

package/examples/open-api/force-app/main/default/restapi/SampleRestResourceToSkip.cls

@@ -1,35 +0,0 @@
-/**
- * @description This rest resource should be skipped
- * @ignore
- */
-@RestResource(UrlMapping='/ResourceToSkip/*')
-global with sharing class SampleRestResourceToSkip {
-    @HttpDelete
-    global static void doDelete() {
-        RestRequest req = RestContext.request;
-        RestResponse res = RestContext.response;
-        String accountId = req.requestURI.substring(req.requestURI.lastIndexOf('/') + 1);
-        Account account = [SELECT Id FROM Account WHERE Id = :accountId];
-        delete account;
-    }
-
-    @HttpGet
-    global static Account doGet() {
-        RestRequest req = RestContext.request;
-        RestResponse res = RestContext.response;
-        String accountId = req.requestURI.substring(req.requestURI.lastIndexOf('/') + 1);
-        Account result = [SELECT Id, Name, Phone, Website FROM Account WHERE Id = :accountId];
-        return result;
-    }
-
-    @HttpPost
-    global static String doPost(String name,
-        String phone, String website) {
-        Account account = new Account();
-        account.Name = name;
-        account.phone = phone;
-        account.website = website;
-        insert account;
-        return account.Id;
-    }
-}

package/examples/open-api/force-app/main/default/restapi/SampleRestResourceWithInnerClass.cls

@@ -1,24 +0,0 @@
-/**
- * @description Contact related operations
- */
-@RestResource(urlMapping='/Contact/*')
-global with sharing class SampleRestResourceWithInnerClass {
-    /**
-     * @description This is a sample HTTP Get method
-     * @return A SampleRestResourceWithInnerClass.InnerClass Object.
-     * @http-response
-     * statusCode: 200
-     * schema: SampleRestResourceWithInnerClass.InnerClass
-     */
-    @HttpGet
-    global static InnerClass doGet() {
-        RestRequest req = RestContext.request;
-        RestResponse res = RestContext.response;
-        String contactId = req.requestURI.substring(req.requestURI.lastIndexOf('/') + 1);
-        return new InnerClass();
-    }
-
-    global class InnerClass {
-        global String stringMember;
-    }
-}

package/examples/open-api/force-app/main/default/restapi/SampleRestResourceWithoutApexDocs.cls

@@ -1,15 +0,0 @@
-/**
- * @description Order related operations
- */
-@RestResource(urlMapping='/Order/*')
-global with sharing class SampleRestResourceWithoutApexDocs {
-    @HttpGet
-    global static String doGet(String param1, Reference1 param2) {
-        return 'Hello World!';
-    }
-
-    @HttpPatch
-    global static String doPatch(String param1, Reference1 param2) {
-        return 'Hello World!';
-    }
-}

package/examples/open-api/force-app/main/default/restapi/references/Reference1.cls

@@ -1,9 +0,0 @@
-public class Reference1 {
-    /**
-     * @description This is a reference 2 member. Lorem.
-     */
-    public Reference2 reference2Member;
-    public Reference3 reference3Member;
-    public List<Reference4> reference4Collection;
-    public Reference5 reference5Member;
-}

package/examples/open-api/force-app/main/default/restapi/references/Reference2.cls

@@ -1,9 +0,0 @@
-public class Reference2 {
-    public String stringMember;
-
-    /**
-     * @description This is an object reference.
-     * @http-schema List<Reference3>
-     */
-    public Object objectReference;
-}

package/examples/open-api/force-app/main/default/restapi/references/Reference3.cls

@@ -1,3 +0,0 @@
-public class Reference3 {
-    public Boolean someBoolean;
-}

package/examples/open-api/force-app/main/default/restapi/references/Reference4.cls

@@ -1,3 +0,0 @@
-public class Reference4 {
-    public String someString;
-}

package/examples/open-api/force-app/main/default/restapi/references/Reference5.cls

@@ -1,3 +0,0 @@
-public class Reference5 {
-    public Reference6 reference6Member;
-}

package/examples/open-api/force-app/main/default/restapi/references/Reference6.cls

@@ -1,6 +0,0 @@
-public class Reference6 {
-    /**
-     * @description This is the grandchild description.
-     */
-    public String grandChildString;
-}

package/examples/open-api/force-app/main/default/restapi/references/Reference7.cls

@@ -1,3 +0,0 @@
-public class Reference7 {
-    public Object untypedObject;
-}