apps: Add missing domains list to the app objects (#776)

The list of domains on the app object was missing from the specification, this PR updates the app and apps response examples as well as the app model.
digitalocean · Feb 1, 2023 · 1f764fe · 1f764fe
1 parent 9e455b7
commit 1f764fe
Show file tree

Hide file tree

Showing 3 changed files with 192 additions and 3 deletions.
diff --git a/specification/resources/apps/models/app_domain_validation.yml b/specification/resources/apps/models/app_domain_validation.yml
@@ -0,0 +1,11 @@
+properties:
+  "txt_name":
+    title: "TXT record name"
+    type: string
+    readOnly: true
+    example: "_acme-challenge.app.example.com"
+  "txt_value":
+    title: "TXT record value"
+    type: string
+    readOnly: true
+    example: "lXLOcN6cPv0nproViNcUHcahD9TrIPlNgdwesj0pYpk"
diff --git a/specification/resources/apps/models/apps_domain.yml b/specification/resources/apps/models/apps_domain.yml
@@ -9,4 +9,19 @@ properties:
     $ref: apps_domain_progress.yml
   spec:
     $ref: app_domain_spec.yml
+  validations:
+    title: "List of TXT validation records"
+    type: array
+    items:
+      $ref: app_domain_validation.yml
+  rotate_validation_records:
+    title: "Validation values have changed and require manual intervention"
+    type: boolean
+    readOnly: true
+  certificate_expires_at:
+    title: "Current SSL certificate expiration time"
+    type: string
+    format: date-time
+    readOnly: true
+    example: "2024-01-29T23:59:59Z"
 type: object
diff --git a/specification/resources/apps/responses/examples.yml b/specification/resources/apps/responses/examples.yml
@@ -17,6 +17,11 @@ apps:
               http_port: 8080
               routes:
                 - path: /
+          domains:
+          - domain: "sample-php.example.com"
+            type: "PRIMARY"
+            zone: "example.com"
+            minimum_tls_version: "1.3"
         default_ingress: https://sample-php-iaj87.ondigitalocean.app
         created_at: 2020-11-19T20:27:18Z
         updated_at: 2020-12-01T00:42:16Z
@@ -37,6 +42,11 @@ apps:
                 routes:
                   - path: /
             region: fra
+            domains:
+              - domain: "sample-php.example.com"
+                type: "PRIMARY"
+                zone: "example.com"
+                minimum_tls_version: "1.3"
           services:
             - name: sample-php
               source_commit_hash: 54d4a727f457231062439895000d45437c7bb405
@@ -71,7 +81,7 @@ apps:
           phase: ACTIVE
           tier_slug: basic
         last_deployment_created_at: 2020-12-01T00:40:05Z
-        live_url: https://sample-php-iaj87.ondigitalocean.app
+        live_url: https://sample-php.example.com
         region:
           slug: fra
           label: Frankfurt
@@ -80,8 +90,80 @@ apps:
           data_centers:
           - fra1
         tier_slug: basic
-        live_url_base: https://sample-php-iaj87.ondigitalocean.app
-        live_domain: sample-php-iaj87.ondigitalocean.app
+        live_url_base: https://sample-php.example.com
+        live_domain: sample-php.example.com
+        domains:
+        - id: 0831f444-a1a7-11ed-828c-ef59494480b5
+          phase: "ACTIVE"
+          spec:
+            domain: "sample-php.example.com"
+            type: "PRIMARY"
+            zone: "example.com"
+            minimum_tls_version: "1.3"
+          rotate_validation_records: false
+          certificate_expires_at: "2024-01-29T23:59:59Z"
+          progress:
+            steps:
+            - ended_at: '0001-01-01T00:00:00Z'
+              name: default-ingress-ready
+              started_at: '2023-01-30T22:15:45.021896292Z'
+              status: SUCCESS
+            - ended_at: '0001-01-01T00:00:00Z'
+              name: ensure-zone
+              started_at: '2023-01-30T22:15:45.022017004Z'
+              status: SUCCESS
+            - ended_at: '2023-01-30T15:42:28.50752065Z'
+              name: ensure-ns-records
+              started_at: '2023-01-30T22:15:45.025567874Z'
+              status: SUCCESS
+            - ended_at: '0001-01-01T00:00:00Z'
+              name: verify-nameservers
+              started_at: '2023-01-30T22:15:45.033591906Z'
+              status: SUCCESS
+            - ended_at: '0001-01-01T00:00:00Z'
+              name: ensure-record
+              started_at: '2023-01-30T22:15:45.156750604Z'
+              status: SUCCESS
+            - ended_at: '2023-01-30T15:43:30.258626422Z'
+              name: ensure-alias-record
+              started_at: '2023-01-30T22:15:45.165933869Z'
+              status: SUCCESS
+            - ended_at: '2023-01-30T15:43:30.258808279Z'
+              name: ensure-wildcard-record
+              started_at: '2023-01-30T22:15:45.166093422Z'
+              status: SUCCESS
+            - ended_at: '0001-01-01T00:00:00Z'
+              name: verify-cname
+              started_at: '2023-01-30T22:15:45.166205559Z'
+              status: SUCCESS
+            - ended_at: '2023-01-30T15:43:30.475903785Z'
+              name: ensure-ssl-txt-record-saved
+              started_at: '2023-01-30T22:15:45.295237186Z'
+              status: SUCCESS
+            - ended_at: '2023-01-30T15:43:30.476017236Z'
+              name: ensure-ssl-txt-record
+              started_at: '2023-01-30T22:15:45.295315291Z'
+              status: SUCCESS
+            - ended_at: '2023-01-30T15:43:30.476094058Z'
+              name: ensure-renewal-email
+              started_at: '2023-01-30T22:15:45.295374087Z'
+              status: SUCCESS
+            - ended_at: '0001-01-01T00:00:00Z'
+              name: ensure-CA-authorization
+              started_at: '2023-01-30T22:15:45.295428101Z'
+              status: SUCCESS
+            - ended_at: '0001-01-01T00:00:00Z'
+              name: ensure-certificate
+              started_at: '2023-01-30T22:15:45.978756406Z'
+              status: SUCCESS
+            - ended_at: '2023-01-30T15:43:52.570612857Z'
+              name: create-deployment
+              started_at: '0001-01-01T00:00:00Z'
+              status: SUCCESS
+            - ended_at: '2023-01-30T15:43:31.333582377Z'
+              name: configuration-alert
+              started_at: '2023-01-30T22:15:46.278987808Z'
+              status: SUCCESS
     links:
       pages: {}
     meta:
@@ -108,6 +190,10 @@ app:
           routes:
           - path: "/"
         region: ams
+        domains:
+        - domain: "sample-golang.example.com"
+          zone: "example.com"
+          minimum_tls_version: "1.3"
       default_ingress: https://sample-golang-zyhgn.ondigitalocean.app
       created_at: '2021-02-10T16:45:14Z'
       updated_at: '2021-02-10T17:06:56Z'
@@ -128,6 +214,10 @@ app:
             routes:
             - path: "/"
           region: ams
+          domains:
+          - domain: "sample-golang.example.com"
+            zone: "example.com"
+            minimum_tls_version: "1.3"
         services:
         - name: web
           source_commit_hash: db6936cb46047c576962962eed81ad52c21f35d7
@@ -202,6 +292,79 @@ app:
       live_url_base: https://sample-golang-zyhgn.ondigitalocean.app
       live_domain: sample-golang-zyhgn.ondigitalocean.app
       project_id: 88b72d1a-b78a-4d9f-9090-b53c4399073f
+      domains:
+      - id: e206c64e-a1a3-11ed-9e6e-9b7b6dc9a52b
+        phase: "CONFIGURING"
+        spec:
+          domain: "sample-golang.example.com"
+          type: "PRIMARY"
+          zone: "example.com"
+          minimum_tls_version: "1.3"
+        rotate_validation_records: false
+        certificate_expires_at: "2024-01-29T23:59:59Z"
+        progress:
+          steps:
+          - ended_at: '0001-01-01T00:00:00Z'
+            name: default-ingress-ready
+            started_at: '2023-01-30T22:15:45.021896292Z'
+            status: SUCCESS
+          - ended_at: '0001-01-01T00:00:00Z'
+            name: ensure-zone
+            started_at: '2023-01-30T22:15:45.022017004Z'
+            status: SUCCESS
+          - ended_at: '2023-01-30T15:42:28.50752065Z'
+            name: ensure-ns-records
+            started_at: '2023-01-30T22:15:45.025567874Z'
+            status: SUCCESS
+          - ended_at: '0001-01-01T00:00:00Z'
+            name: verify-nameservers
+            started_at: '2023-01-30T22:15:45.033591906Z'
+            status: SUCCESS
+          - ended_at: '0001-01-01T00:00:00Z'
+            name: ensure-record
+            started_at: '2023-01-30T22:15:45.156750604Z'
+            status: SUCCESS
+          - ended_at: '2023-01-30T15:43:30.258626422Z'
+            name: ensure-alias-record
+            started_at: '2023-01-30T22:15:45.165933869Z'
+            status: SUCCESS
+          - ended_at: '2023-01-30T15:43:30.258808279Z'
+            name: ensure-wildcard-record
+            started_at: '2023-01-30T22:15:45.166093422Z'
+            status: SUCCESS
+          - ended_at: '0001-01-01T00:00:00Z'
+            name: verify-cname
+            started_at: '2023-01-30T22:15:45.166205559Z'
+            status: SUCCESS
+          - ended_at: '2023-01-30T15:43:30.475903785Z'
+            name: ensure-ssl-txt-record-saved
+            started_at: '2023-01-30T22:15:45.295237186Z'
+            status: SUCCESS
+          - ended_at: '2023-01-30T15:43:30.476017236Z'
+            name: ensure-ssl-txt-record
+            started_at: '2023-01-30T22:15:45.295315291Z'
+            status: SUCCESS
+          - ended_at: '2023-01-30T15:43:30.476094058Z'
+            name: ensure-renewal-email
+            started_at: '2023-01-30T22:15:45.295374087Z'
+            status: SUCCESS
+          - ended_at: '0001-01-01T00:00:00Z'
+            name: ensure-CA-authorization
+            started_at: '2023-01-30T22:15:45.295428101Z'
+            status: SUCCESS
+          - ended_at: '0001-01-01T00:00:00Z'
+            name: ensure-certificate
+            started_at: '2023-01-30T22:15:45.978756406Z'
+            status: RUNNING
+          - ended_at: '0001-01-01T00:00:00'
+            name: create-deployment
+            started_at: '0001-01-01T00:00:00Z'
+            status: PENDING
+          - ended_at: '0001-01-01T00:00:00'
+            name: configuration-alert
+            started_at: '0001-01-01T00:00:00'
+            status: PENDING
+
 
 deployments:
   value: