fix: refine scheduled integration tests

Author: simonsdave

.circleci/config.yml

@@ -315,7 +315,7 @@ workflows:
     when:
       and:
         - equal: [scheduled_pipeline, << pipeline.trigger_source >>]
-        - equal: ["integration_tests", << pipeline.schedule.name >>]
+        - equal: ["Integration Tests", << pipeline.schedule.name >>]
     jobs:
       - pull_docker_images_and_run_integration_tests:
           context:

docs/CircleCI-API.md

@@ -1,10 +1,26 @@
 # CircleCI API
 
 * [CircleCI API Developer's Guide](https://circleci.com/docs/2.0/api-developers-guide/)
+* [CircleCI API (v2)](https://circleci.com/docs/api/v2/)
 
 ## Authentication
 
 * generate [Personal API Token](https://app.circleci.com/settings/user/tokens) which is associated with a user
+
+* save token in ```~/.circleci.creds``` formatted like
+
+```ini
+# created 8 Jan '22 - personal access token for Dave
+PERSONAL_API_TOKEN=1234567890abcdef
+```
+
+* extract using something like
+
+```bash
+~> PERSONAL_API_TOKEN=$(grep PERSONAL_API_TOKEN ~/.circleci.creds | sed -e 's|^.*=||g')
+~>
+```
+
 * test the token works
 
 ```bash
@@ -81,16 +97,17 @@
 * [Scheduled Pipelines](https://circleci.com/docs/2.0/scheduled-pipelines)
 * [7 Jan '22 - Getting started with scheduled pipelines](https://circleci.com/blog/using-scheduled-pipelines/)
 * can configure schedules under ```project settings / triggers``` (ex [https://app.circleci.com/settings/project/github/simonsdave/cloudfeaster/triggers](https://app.circleci.com/settings/project/github/simonsdave/cloudfeaster/triggers))
+* [Schedule CircleCI API (v2)](https://circleci.com/docs/api/v2/#tag/Schedule)
 
 ### Get All Schedules
 
 ```bash
 ~> curl \
     -s \
-    --verbose \
     --header "Circle-Token: ${PERSONAL_API_TOKEN}" \
     --header 'Accept: application/json' \
     https://circleci.com/api/v2/project/gh/simonsdave/cloudfeaster/schedule
+~>
 ```
 
 ### Create Schedule
@@ -101,23 +118,81 @@
 ```bash
 ~> curl \
     -s \
-    --verbose \
     --header "Circle-Token: ${PERSONAL_API_TOKEN}" \
     -X POST \
     --header 'Content-Type: application/json' \
     --data-raw '{
-        "name": "Run Integration Tests",
-        "description": "Run intergration tests every day",
+        "name": "Integration Tests",
+        "description": "Run Intergration Tests",
         "attribution-actor": "system",
         "parameters": {
             "branch": "master"
         },
         "timetable": {
             "per-hour": 1,
-            "hours-of-day": [16],
+            "hours-of-day": [21],
             "days-of-week": ["MON", "TUE", "WED", "THU", "FRI", "SAT", "SUN"]
         }
     }' \
     --header 'Accept: application/json' \
-    https://circleci.com/api/v2/project/gh/simonsdave/cloudfeaster/schedule
+    https://circleci.com/api/v2/project/gh/simonsdave/cloudfeaster/schedule | jq .
+{
+  "description": "Run Intergration Tests",
+  "updated-at": "2022-01-09T20:13:18.855Z",
+  "name": "Integration Tests",
+  "id": "00000000-1111-2222-3333-444444444444",
+  "project-slug": "gh/simonsdave/cloudfeaster",
+  "created-at": "2022-01-09T20:13:18.855Z",
+  "parameters": {
+    "branch": "master"
+  },
+  "actor": {
+    "login": "system-actor",
+    "name": "Scheduled",
+    "id": "55555555-1111-2222-3333-444444444444",
+  },
+  "timetable": {
+    "per-hour": 1,
+    "hours-of-day": [
+      21
+    ],
+    "days-of-week": [
+      "MON",
+      "TUE",
+      "WED",
+      "THU",
+      "FRI",
+      "SAT",
+      "SUN"
+    ]
+  }
+}
+~>
+```
+
+### Get A Schedule
+
+* get a schedule after it's been created
+
+```bash
+~> curl \
+    -s \
+    --header "Circle-Token: ${PERSONAL_API_TOKEN}" \
+    --header 'Accept: application/json' \
+    https://circleci.com/api/v2/project/gh/simonsdave/cloudfeaster/schedule/00000000-1111-2222-3333-444444444444
+~>
+```
+
+## Delete Schedule
+
+* delete a schedule after it's been created
+
+```bash
+~> curl \
+    -s \
+    --header "Circle-Token: ${PERSONAL_API_TOKEN}" \
+    -X DELETE \
+    --header 'Accept: application/json' \
+    https://circleci.com/api/v2/project/gh/simonsdave/cloudfeaster/schedule/00000000-1111-2222-3333-444444444444
+~>
 ```