@cparra/apexdocs 3.0.0-alpha.9 → 3.0.0-beta.1

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

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

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

@@ -0,0 +1,582 @@
+{
+  "openapi": "3.1.0",
+  "info": {
+    "title": "Open API Example",
+    "version": "3.0.0"
+  },
+  "servers": [
+    {
+      "url": "/services/apexrest/openapi/"
+    }
+  ],
+  "paths": {
+    "AccountService/": {
+      "description": "Account related operations",
+      "get": {
+        "tags": [
+          "Account Service"
+        ],
+        "description": "This is a sample HTTP Get method",
+        "parameters": [
+          {
+            "name": "limit",
+            "in": "query",
+            "required": true,
+            "description": "Limits the number of items on a page",
+            "schema": {
+              "type": "integer"
+            }
+          },
+          {
+            "name": "complex",
+            "in": "cookie",
+            "description": "A more complex schema",
+            "schema": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "name": {
+                    "type": "string"
+                  }
+                }
+              }
+            }
+          }
+        ],
+        "responses": {
+          "100": {
+            "description": "Status code 100",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "anotherObject": {
+                      "description": "An object inside of an object",
+                      "type": "object",
+                      "properties": {
+                        "message": {
+                          "type": "string"
+                        },
+                        "somethingElse": {
+                          "type": "number"
+                        }
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "200": {
+            "description": "Status code 200",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "id": {
+                      "type": "string",
+                      "description": "The super Id."
+                    },
+                    "name": {
+                      "type": "string"
+                    },
+                    "phone": {
+                      "type": "string",
+                      "format": "byte"
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "304": {
+            "description": "Status code 304",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "error": {
+                      "type": "string"
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Status code 400",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "type": "object",
+                    "properties": {
+                      "name": {
+                        "type": "string"
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "500": {
+            "description": "Status code 500",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        }
+      },
+      "post": {
+        "tags": [
+          "Account Service"
+        ],
+        "description": "This is a sample HTTP Post method",
+        "summary": "Posts an Account 2",
+        "requestBody": {
+          "description": "This is an example of a request body",
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "array",
+                "items": {
+                  "type": "object",
+                  "properties": {
+                    "name": {
+                      "type": "string"
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "required": true
+        },
+        "parameters": [
+          {
+            "name": "limit",
+            "in": "query",
+            "required": true,
+            "description": "Limits the number of items on a page",
+            "schema": {
+              "type": "integer"
+            }
+          },
+          {
+            "name": "complex",
+            "in": "cookie",
+            "description": "A more complex schema",
+            "schema": {
+              "type": "array",
+              "items": {
+                "type": "object",
+                "properties": {
+                  "name": {
+                    "type": "string"
+                  }
+                }
+              }
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Status code 200",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "id": {
+                      "type": "string",
+                      "description": "The super Id."
+                    },
+                    "name": {
+                      "type": "string"
+                    },
+                    "phone": {
+                      "type": "string",
+                      "format": "byte"
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "304": {
+            "description": "Status code 304",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "object",
+                  "properties": {
+                    "error": {
+                      "type": "string"
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "400": {
+            "description": "Status code 400",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "array",
+                  "items": {
+                    "type": "object",
+                    "properties": {
+                      "name": {
+                        "type": "string"
+                      }
+                    }
+                  }
+                }
+              }
+            }
+          },
+          "500": {
+            "description": "Status code 500",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        }
+      },
+      "delete": {
+        "tags": [
+          "Account Service"
+        ],
+        "description": "Sample HTTP Delete method with references to other types.",
+        "parameters": [
+          {
+            "name": "limit",
+            "in": "header",
+            "required": true,
+            "description": "My sample description.",
+            "schema": {
+              "$ref": "#/components/schemas/SampleClass"
+            }
+          }
+        ],
+        "responses": {
+          "200": {
+            "description": "Status code 200",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SampleClass"
+                }
+              }
+            }
+          },
+          "304": {
+            "description": "Status code 304",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/ChildClass"
+                }
+              }
+            }
+          },
+          "305": {
+            "description": "Status code 305",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Reference1"
+                }
+              }
+            }
+          },
+          "306": {
+            "description": "Status code 306",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Reference1_array"
+                }
+              }
+            }
+          },
+          "307": {
+            "description": "Status code 307",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/Reference7_Reference7[untypedObject:Reference2]"
+                }
+              }
+            }
+          },
+          "500": {
+            "description": "Status code 500",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SampleClass"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "Contact/": {
+      "description": "Contact related operations",
+      "get": {
+        "tags": [
+          "Contact"
+        ],
+        "description": "This is a sample HTTP Get method",
+        "responses": {
+          "200": {
+            "description": "Status code 200",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "$ref": "#/components/schemas/SampleRestResourceWithInnerClass.InnerClass"
+                }
+              }
+            }
+          }
+        }
+      }
+    },
+    "Order/": {
+      "description": "Order related operations",
+      "get": {
+        "tags": [
+          "Order"
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "param1": {
+                    "type": "string"
+                  },
+                  "param2": {
+                    "$ref": "#/components/schemas/Reference1"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Status code 200",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        }
+      },
+      "patch": {
+        "tags": [
+          "Order"
+        ],
+        "requestBody": {
+          "content": {
+            "application/json": {
+              "schema": {
+                "type": "object",
+                "properties": {
+                  "param1": {
+                    "type": "string"
+                  },
+                  "param2": {
+                    "$ref": "#/components/schemas/Reference1"
+                  }
+                }
+              }
+            }
+          }
+        },
+        "responses": {
+          "200": {
+            "description": "Status code 200",
+            "content": {
+              "application/json": {
+                "schema": {
+                  "type": "string"
+                }
+              }
+            }
+          }
+        }
+      }
+    }
+  },
+  "tags": [
+    {
+      "name": "Account Service",
+      "description": "Account related operations"
+    },
+    {
+      "name": "Contact",
+      "description": "Contact related operations"
+    },
+    {
+      "name": "Order",
+      "description": "Order related operations"
+    }
+  ],
+  "components": {
+    "schemas": {
+      "SampleClass": {
+        "type": "object",
+        "properties": {
+          "MyProp": {
+            "type": "string",
+            "description": "This is a String property."
+          },
+          "AnotherProp": {
+            "type": "number",
+            "description": "This is a Decimal property."
+          },
+          "listOfStrings": {
+            "type": "array",
+            "items": {
+              "type": "string"
+            }
+          },
+          "someVariable": {
+            "type": "string"
+          },
+          "somePrivateStuff": {
+            "type": "string"
+          }
+        }
+      },
+      "ChildClass": {
+        "type": "object",
+        "properties": {
+          "privateStringFromChild": {
+            "type": "string"
+          },
+          "aPrivateString": {
+            "type": "string"
+          }
+        }
+      },
+      "Reference1": {
+        "type": "object",
+        "properties": {
+          "reference2Member": {
+            "$ref": "#/components/schemas/Reference2",
+            "description": "This is a reference 2 member. Lorem."
+          },
+          "reference3Member": {
+            "$ref": "#/components/schemas/Reference3"
+          },
+          "reference4Collection": {
+            "type": "array",
+            "items": {
+              "$ref": "#/components/schemas/Reference4"
+            }
+          },
+          "reference5Member": {
+            "$ref": "#/components/schemas/Reference5"
+          }
+        }
+      },
+      "Reference2": {
+        "type": "object",
+        "properties": {
+          "stringMember": {
+            "type": "string"
+          },
+          "objectReference": {
+            "$ref": "#/components/schemas/Reference3_array",
+            "description": "This is an object reference."
+          }
+        }
+      },
+      "Reference3_array": {
+        "type": "array",
+        "items": {
+          "$ref": "#/components/schemas/Reference3"
+        }
+      },
+      "Reference3": {
+        "type": "object",
+        "properties": {
+          "someBoolean": {
+            "type": "boolean"
+          }
+        }
+      },
+      "Reference4": {
+        "type": "object",
+        "properties": {
+          "someString": {
+            "type": "string"
+          }
+        }
+      },
+      "Reference5": {
+        "type": "object",
+        "properties": {
+          "reference6Member": {
+            "$ref": "#/components/schemas/Reference6"
+          }
+        }
+      },
+      "Reference6": {
+        "type": "object",
+        "properties": {
+          "grandChildString": {
+            "type": "string",
+            "description": "This is the grandchild description."
+          }
+        }
+      },
+      "Reference1_array": {
+        "type": "array",
+        "items": {
+          "$ref": "#/components/schemas/Reference1"
+        }
+      },
+      "Reference7_Reference7[untypedObject:Reference2]": {
+        "type": "object",
+        "properties": {
+          "untypedObject": {
+            "$ref": "#/components/schemas/Reference2"
+          }
+        }
+      },
+      "SampleRestResourceWithInnerClass.InnerClass": {
+        "type": "object",
+        "properties": {
+          "stringMember": {
+            "type": "string"
+          }
+        }
+      }
+    }
+  }
+}

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

@@ -1,3 +1,4 @@
+
 /**
  * @description This is a class description. This class relates to {@link SampleInterface}
  *              But this {@link ClassThatDoesNotExist} does not exist.