Commit from m3o/m3o action

m3o · Jul 4, 2023 · cbdf284 · cbdf284
1 parent 58b8402
commit cbdf284
Show file tree

Hide file tree

Showing 27 changed files with 1,129 additions and 1,129 deletions.
diff --git a/examples/app/README.md b/examples/app/README.md
@@ -4,234 +4,234 @@ An [m3o.com](https://m3o.com) API. For example usage see [m3o.com/App/api](https
 
 Endpoints:
 
-## Run
+## Status
 
-Run an app from source
+Get the status of an app
 
 
-[https://m3o.com/app/api#Run](https://m3o.com/app/api#Run)
+[https://m3o.com/app/api#Status](https://m3o.com/app/api#Status)
 
 ```js
 const { AppService } = require('m3o/app');
 
 const appService = new AppService(process.env.M3O_API_TOKEN)
 
-// Run an app from source
-async function runAnApp() {
-	const rsp = await appService.run({
-  "branch": "master",
-  "name": "helloworld",
-  "port": 8080,
-  "region": "europe-west1",
-  "repo": "github.com/asim/helloworld"
+// Get the status of an app
+async function getTheStatusOfAnApp() {
+	const rsp = await appService.status({
+  "name": "helloworld"
 })
 	console.log(rsp)
 
 }
 
-runAnApp()
+getTheStatusOfAnApp()
 ```
-## Regions
+## Update
 
-Return the support regions
+Update the app. The latest source code will be downloaded, built and deployed.
 
 
-[https://m3o.com/app/api#Regions](https://m3o.com/app/api#Regions)
+[https://m3o.com/app/api#Update](https://m3o.com/app/api#Update)
 
 ```js
 const { AppService } = require('m3o/app');
 
 const appService = new AppService(process.env.M3O_API_TOKEN)
 
-// Return the support regions
-async function listRegions() {
-	const rsp = await appService.regions({})
+// Update the app. The latest source code will be downloaded, built and deployed.
+async function updateAnApp() {
+	const rsp = await appService.update({
+  "name": "helloworld"
+})
 	console.log(rsp)
 
 }
 
-listRegions()
+updateAnApp()
 ```
-## Status
+## Logs
 
-Get the status of an app
+Get the logs for an app
 
 
-[https://m3o.com/app/api#Status](https://m3o.com/app/api#Status)
+[https://m3o.com/app/api#Logs](https://m3o.com/app/api#Logs)
 
 ```js
 const { AppService } = require('m3o/app');
 
 const appService = new AppService(process.env.M3O_API_TOKEN)
 
-// Get the status of an app
-async function getTheStatusOfAnApp() {
-	const rsp = await appService.status({
+// Get the logs for an app
+async function retrieveBuildLogsForAnApp() {
+	const rsp = await appService.logs({
+  "logs_type": "build",
   "name": "helloworld"
 })
 	console.log(rsp)
 
 }
 
-getTheStatusOfAnApp()
+retrieveBuildLogsForAnApp()
 ```
-## Resolve
+## Reserve
 
-Resolve an app by id to its raw backend endpoint
+Reserve app names
 
 
-[https://m3o.com/app/api#Resolve](https://m3o.com/app/api#Resolve)
+[https://m3o.com/app/api#Reserve](https://m3o.com/app/api#Reserve)
 
 ```js
 const { AppService } = require('m3o/app');
 
 const appService = new AppService(process.env.M3O_API_TOKEN)
 
-// Resolve an app by id to its raw backend endpoint
-async function resolveAppById() {
-	const rsp = await appService.resolve({
-  "id": "helloworld"
+// Reserve app names
+async function reserveAppName() {
+	const rsp = await appService.reserve({
+  "name": "helloworld"
 })
 	console.log(rsp)
 
 }
 
-resolveAppById()
+reserveAppName()
 ```
-## Delete
+## Get
 
-Delete an app
+Get an app by name
 
 
-[https://m3o.com/app/api#Delete](https://m3o.com/app/api#Delete)
+[https://m3o.com/app/api#Get](https://m3o.com/app/api#Get)
 
 ```js
 const { AppService } = require('m3o/app');
 
 const appService = new AppService(process.env.M3O_API_TOKEN)
 
-// Delete an app
-async function deleteAnApp() {
-	const rsp = await appService.delete({
+// Get an app by name
+async function getAnApp() {
+	const rsp = await appService.get({
   "name": "helloworld"
 })
 	console.log(rsp)
 
 }
 
-deleteAnApp()
+getAnApp()
 ```
-## Logs
+## List
 
-Get the logs for an app
+List all the apps
 
 
-[https://m3o.com/app/api#Logs](https://m3o.com/app/api#Logs)
+[https://m3o.com/app/api#List](https://m3o.com/app/api#List)
 
 ```js
 const { AppService } = require('m3o/app');
 
 const appService = new AppService(process.env.M3O_API_TOKEN)
 
-// Get the logs for an app
-async function retrieveBuildLogsForAnApp() {
-	const rsp = await appService.logs({
-  "logs_type": "build",
-  "name": "helloworld"
-})
+// List all the apps
+async function listTheApps() {
+	const rsp = await appService.list({})
 	console.log(rsp)
 
 }
 
-retrieveBuildLogsForAnApp()
+listTheApps()
 ```
-## Reserve
+## Run
 
-Reserve app names
+Run an app from source
 
 
-[https://m3o.com/app/api#Reserve](https://m3o.com/app/api#Reserve)
+[https://m3o.com/app/api#Run](https://m3o.com/app/api#Run)
 
 ```js
 const { AppService } = require('m3o/app');
 
 const appService = new AppService(process.env.M3O_API_TOKEN)
 
-// Reserve app names
-async function reserveAppName() {
-	const rsp = await appService.reserve({
-  "name": "helloworld"
+// Run an app from source
+async function runAnApp() {
+	const rsp = await appService.run({
+  "branch": "master",
+  "name": "helloworld",
+  "port": 8080,
+  "region": "europe-west1",
+  "repo": "github.com/asim/helloworld"
 })
 	console.log(rsp)
 
 }
 
-reserveAppName()
+runAnApp()
 ```
-## List
+## Regions
 
-List all the apps
+Return the support regions
 
 
-[https://m3o.com/app/api#List](https://m3o.com/app/api#List)
+[https://m3o.com/app/api#Regions](https://m3o.com/app/api#Regions)
 
 ```js
 const { AppService } = require('m3o/app');
 
 const appService = new AppService(process.env.M3O_API_TOKEN)
 
-// List all the apps
-async function listTheApps() {
-	const rsp = await appService.list({})
+// Return the support regions
+async function listRegions() {
+	const rsp = await appService.regions({})
 	console.log(rsp)
 
 }
 
-listTheApps()
+listRegions()
 ```
-## Get
+## Resolve
 
-Get an app by name
+Resolve an app by id to its raw backend endpoint
 
 
-[https://m3o.com/app/api#Get](https://m3o.com/app/api#Get)
+[https://m3o.com/app/api#Resolve](https://m3o.com/app/api#Resolve)
 
 ```js
 const { AppService } = require('m3o/app');
 
 const appService = new AppService(process.env.M3O_API_TOKEN)
 
-// Get an app by name
-async function getAnApp() {
-	const rsp = await appService.get({
-  "name": "helloworld"
+// Resolve an app by id to its raw backend endpoint
+async function resolveAppById() {
+	const rsp = await appService.resolve({
+  "id": "helloworld"
 })
 	console.log(rsp)
 
 }
 
-getAnApp()
+resolveAppById()
 ```
-## Update
+## Delete
 
-Update the app. The latest source code will be downloaded, built and deployed.
+Delete an app
 
 
-[https://m3o.com/app/api#Update](https://m3o.com/app/api#Update)
+[https://m3o.com/app/api#Delete](https://m3o.com/app/api#Delete)
 
 ```js
 const { AppService } = require('m3o/app');
 
 const appService = new AppService(process.env.M3O_API_TOKEN)
 
-// Update the app. The latest source code will be downloaded, built and deployed.
-async function updateAnApp() {
-	const rsp = await appService.update({
+// Delete an app
+async function deleteAnApp() {
+	const rsp = await appService.delete({
   "name": "helloworld"
 })
 	console.log(rsp)
 
 }
 
-updateAnApp()
+deleteAnApp()
 ```