Update examples

Author: drwpow

packages/openapi-typescript/examples/digital-ocean-api/DigitalOcean-public.v2.yaml

@@ -2,5 +2,4 @@ lang: cURL
 source: |-
   curl -X GET \
     -H "Content-Type: application/json"  \
-    -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \
     "https://api.digitalocean.com/v2/1-clicks"

packages/openapi-typescript/examples/digital-ocean-api/resources/1-clicks/examples/curl/oneClicks.yml

@@ -3,6 +3,6 @@ source: |-
   import os
   from pydo import Client
 
-  client = Client(token=os.getenv("$DIGITALOCEAN_TOKEN"))
+  client = Client(token="")
 
   one_click_apps = client.one_clicks.list()

packages/openapi-typescript/examples/digital-ocean-api/resources/1-clicks/examples/python/oneClicks.yml

@@ -40,4 +40,4 @@ x-codeSamples:
 
 security:
   - bearer_auth:
-    - '1click:create'
+    - 'kubernetes:update'

packages/openapi-typescript/examples/digital-ocean-api/resources/1-clicks/oneClicks_install_kubernetes.yml

@@ -37,6 +37,4 @@ x-codeSamples:
   - $ref: 'examples/python/oneClicks.yml'
 
 security:
-  - bearer_auth:
-    - '1click:read'
-
+  - bearer_auth: []

packages/openapi-typescript/examples/digital-ocean-api/resources/1-clicks/oneClicks_list.yml

@@ -43,4 +43,4 @@ x-codeSamples:
 
 security:
   - bearer_auth:
-    - 'app:create'
+    - 'app:update'

packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_create_deployment.yml

@@ -4,7 +4,7 @@ summary: Retrieve Exec URL for Deployment
 
 description:
   Returns a websocket URL that allows sending/receiving console input and output
-  to a component of the specified deployment if one exists.
+  to a component of the specified deployment if one exists. Optionally, the instance_name parameter can be provided to retrieve the exec URL for a specific instance. Note that instances are ephemeral; therefore, we recommended to avoid making persistent changes or such scripting around them.
 
 tags:
   - Apps
@@ -13,6 +13,7 @@ parameters:
   - $ref: parameters.yml#/app_id
   - $ref: parameters.yml#/deployment_id
   - $ref: parameters.yml#/component
+  - $ref: parameters.yml#/instance_name
 
 responses:
   "200":
@@ -39,4 +40,4 @@ x-codeSamples:
 
 security:
   - bearer_auth:
-      - "app:update"
+      - "app:access_console"

packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_exec.yml

@@ -38,4 +38,4 @@ x-codeSamples:
 
 security:
   - bearer_auth:
-      - "app:update"
+      - "app:access_console"

packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_exec_active_deployment.yml

@@ -0,0 +1,38 @@
+operationId: apps_get_health
+
+summary: Retrieve App Health
+
+description: Retrieve information like health status, cpu and memory utilization of app components.
+
+parameters:
+  - $ref: parameters.yml#/app_id
+
+tags:
+- Apps
+
+responses:
+  "200":
+    $ref: responses/apps_health.yml
+
+  "401":
+    $ref: ../../shared/responses/unauthorized.yml
+
+  "404":
+    $ref: "../../shared/responses/not_found.yml"
+
+  "429":
+    $ref: "../../shared/responses/too_many_requests.yml"
+
+  "500":
+    $ref: ../../shared/responses/server_error.yml
+
+  default:
+    $ref: ../../shared/responses/unexpected_error.yml
+
+x-codeSamples:
+  - $ref: 'examples/curl/apps_get_health.yml'
+
+security:
+  - bearer_auth:
+    - 'app:read'
+

packages/openapi-typescript/examples/digital-ocean-api/resources/apps/apps_get_health.yml

@@ -0,0 +1,6 @@
+lang: cURL
+source: |-
+  curl -X GET \
+    -H "Content-Type: application/json" \
+    -H "Authorization: Bearer $DIGITALOCEAN_TOKEN" \
+    "https://api.digitalocean.com/v2/apps/{id}/health"

packages/openapi-typescript/examples/digital-ocean-api/resources/apps/examples/curl/apps_get_health.yml

@@ -8,6 +8,7 @@ enum:
 - DEPLOYMENT_LIVE
 - DOMAIN_FAILED
 - DOMAIN_LIVE
+- AUTOSCALE_FAILED
 - FUNCTIONS_ACTIVATION_COUNT
 - FUNCTIONS_AVERAGE_DURATION_MS
 - FUNCTIONS_ERROR_RATE_PER_MINUTE

packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_alert_spec_rule.yml

@@ -0,0 +1,29 @@
+type: object
+properties:
+  name:
+    type: string
+    example: sample_app
+  cpu_usage_percent:
+    type: number
+    format: double
+    example: 30
+  memory_usage_percent:
+    type: number
+    format: double
+    example: 25
+  replicas_desired:
+    type: integer
+    format: int64
+    example: 1
+  replicas_ready:
+    type: integer
+    format: int64
+    example: 1
+  state:
+    type: string
+    enum:
+      - UNKNOWN
+      - HEALTHY
+      - UNHEALTHY
+    default: UNKNOWN
+    example: HEALTHY

packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_component_health.yml

@@ -29,13 +29,15 @@ properties:
       - MONGODB
       - KAFKA
       - OPENSEARCH
+      - VALKEY
     description: |-
       - MYSQL: MySQL
       - PG: PostgreSQL
       - REDIS: Redis
       - MONGODB: MongoDB
       - KAFKA: Kafka
       - OPENSEARCH: OpenSearch
+      - VALKEY: ValKey
     example: PG
 
   name:

packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_database_spec.yml

@@ -0,0 +1,20 @@
+type: object
+properties:
+  name:
+    type: string
+    example: sample_function
+  functions_component_health_metrics:
+    type: array
+    items:
+      type: object
+      properties:
+        metric_label:
+          type: string
+          example: activations_count
+        metric_value:
+          type: number
+          format: double
+          example: 100
+        time_window:
+          type: string
+          example: 1h

packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_functions_component_health.yml

@@ -0,0 +1,10 @@
+type: object
+properties:
+  components:
+    type: array
+    items:
+      "$ref": app_component_health.yml
+  functions_components:
+    type: array
+    items:
+      "$ref": app_functions_component_health.yml

packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_health.yml

@@ -0,0 +1,54 @@
+type: object
+properties:
+  failure_threshold:
+    type: integer
+    format: int32
+    description: The number of failed health checks before considered unhealthy.
+    minimum: 1
+    maximum: 50
+    example: 18
+
+  port:
+    type: integer
+    format: int64
+    description: The port on which the health check will be performed.
+    example: 80
+    maximum: 65535
+    minimum: 1
+
+  http_path:
+    type: string
+    description: The route path used for the HTTP health check ping. If not set, the HTTP health check will be disabled and a TCP health check used instead.
+    example: /health
+
+  initial_delay_seconds:
+    type: integer
+    format: int32
+    description: The number of seconds to wait before beginning health checks.
+    minimum: 0
+    maximum: 3600
+    example: 30
+
+  period_seconds:
+    type: integer
+    format: int32
+    description: The number of seconds to wait between health checks.
+    minimum: 1
+    maximum: 300
+    example: 10
+
+  success_threshold:
+    type: integer
+    format: int32
+    description: The number of successful health checks before considered healthy.
+    example: 1
+    minimum: 1
+    maximum: 1
+
+  timeout_seconds:
+    type: integer
+    format: int32
+    description: The number of seconds after which the check times out.
+    minimum: 1
+    maximum: 120
+    example: 1

packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_health_check_spec.yml

@@ -0,0 +1,4 @@
+properties:
+  app_health:
+    "$ref": app_health.yml
+type: object

packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_health_response.yml

@@ -1,7 +1,7 @@
 type: object
 properties:
   path:
-    $ref: app_ingress_spec_rule_string_match.yml
+    $ref: app_ingress_spec_rule_string_match_prefix.yml
+  authority:
+    $ref: app_ingress_spec_rule_string_match_exact.yml
 description: The match configuration for the rule.
-required:
-  - path

packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_ingress_spec_rule_match.yml

@@ -0,0 +1,9 @@
+type: object
+properties:
+  exact:
+    type: string
+    maxLength: 256
+    example: "example.com"
+description: The authority to match on.
+required:
+  - exact

packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_ingress_spec_rule_string_match_exact.yml

@@ -0,0 +1,10 @@
+type: object
+properties:
+  prefix:
+    type: string
+    description: Prefix-based match. For example, `/api` will match `/api`, `/api/`, and any nested paths such as `/api/v1/endpoint`.
+    maxLength: 256
+    example: /api
+description: The path to match on.
+required:
+  - prefix

packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_ingress_spec_rule_string_match_prefix.yml

@@ -7,7 +7,7 @@ properties:
     example: true
   archive:
     type: boolean
-    description: Indicates whether the app should be archived. Setting this to true implies that enabled is set to true. Note that this feature is currently in closed beta.
+    description: Indicates whether the app should be archived. Setting this to true implies that enabled is set to true.
     example: true
   offline_page_url:
     type: string

packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_maintenance_spec.yml

@@ -13,6 +13,9 @@ allOf:
     health_check:
       $ref: app_service_spec_health_check.yml
 
+    liveness_health_check:
+      $ref: app_health_check_spec.yml
+
     protocol:
       type: string
       description: |

packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_service_spec.yml

@@ -5,6 +5,8 @@ allOf:
   properties:
     termination:
       $ref: app_worker_spec_termination.yml
+    liveness_health_check:
+      $ref: app_health_check_spec.yml
 required:
   - name
 

packages/openapi-typescript/examples/digital-ocean-api/resources/apps/models/app_worker_spec.yml

@@ -6,8 +6,8 @@ accept:
   schema:
     type: string
     enum:
-    - application/json
-    - application/yaml
+      - application/json
+      - application/yaml
   example: application/json
 
 content-type:
@@ -18,8 +18,8 @@ content-type:
   schema:
     type: string
     enum:
-    - application/json
-    - application/yaml
+      - application/json
+      - application/yaml
   example: application/json
 
 app_id:
@@ -67,7 +67,8 @@ slug_size:
   example: apps-s-1vcpu-0.5gb
 
 component:
-  description: An optional component name. If set, logs will be limited to this component
+  description:
+    An optional component name. If set, logs will be limited to this component
     only.
   in: path
   name: component_name
@@ -105,17 +106,18 @@ log_type:
   schema:
     default: UNSPECIFIED
     enum:
-    - UNSPECIFIED
-    - BUILD
-    - DEPLOY
-    - RUN
-    - RUN_RESTARTED
+      - UNSPECIFIED
+      - BUILD
+      - DEPLOY
+      - RUN
+      - RUN_RESTARTED
     type: string
   example: BUILD
 
 time_wait:
-  description: 'An optional time duration to wait if the underlying component instance
-    is not immediately available. Default: `3m`.'
+  description:
+    "An optional time duration to wait if the underlying component instance
+    is not immediately available. Default: `3m`."
   in: query
   name: pod_connection_timeout
   schema:
@@ -139,3 +141,12 @@ alert_id:
   schema:
     type: string
   example: 5a624ab5-dd58-4b39-b7dd-8b7c36e8a91d
+
+instance_name:
+  description: The name of the actively running ephemeral compute instance
+  in: query
+  name: instance_name
+  required: false
+  schema:
+    type: string
+  example: go-app-d768568df-zz77d