Various improvements #2

apis/cf/latest/components/requestBodies/ServiceCredentialBindingCreateRequestBody.yaml

@@ -0,0 +1,73 @@
+description: A request to create a service credential binding
+content:
+  application/json:
+    schema:
+      type: object
+      required:
+        - type
+        - relationships
+      properties:
+        type:
+          type: string
+          enum:
+            - app
+            - key
+          description: Type of the service credential binding. Valid values are key and app
+        name:
+          type: string
+          description: Name of the service credential binding. name is optional when the type is app
+        relationships:
+          type: object
+          required:
+            - service_instance
+          properties:
+            service_instance:
+              $ref: '../schemas/RelationshipToOne.yaml'
+              description: The service instance to be bound
+            app:
+              $ref: '../schemas/RelationshipToOne.yaml'
+              description: The app to be bound. Required when type is app
+          description: Relationships for the service credential binding
+        parameters:
+          type: object
+          description: A JSON object that is passed to the service broker
+        metadata:
+          $ref: '../schemas/Metadata.yaml'
+    examples:
+      app_credential_binding:
+        summary: App credential binding
+        value:
+          type: app
+          name: some-binding-name
+          relationships:
+            service_instance:
+              data:
+                guid: "7304bc3c-7010-11ea-8840-48bf6bec2d78"
+            app:
+              data:
+                guid: "e0e4417c-74ee-11ea-a604-48bf6bec2d78"
+          parameters:
+            key1: value1
+            key2: value2
+          metadata:
+            labels:
+              foo: bar
+            annotations:
+              baz: qux
+      key_credential_binding:
+        summary: Key credential binding
+        value:
+          type: key
+          name: some-binding-name
+          relationships:
+            service_instance:
+              data:
+                guid: "7304bc3c-7010-11ea-8840-48bf6bec2d78"
+          parameters:
+            key1: value1
+            key2: value2
+          metadata:
+            labels:
+              foo: bar
+            annotations:
+              baz: qux

apis/cf/latest/components/requestBodies/ServiceCredentialBindingUpdateRequestBody.yaml

@@ -0,0 +1,17 @@
+description: A request to update a service credential binding
+content:
+  application/json:
+    schema:
+      type: object
+      properties:
+        metadata:
+          $ref: '../schemas/Metadata.yaml'
+    examples:
+      update_binding:
+        summary: Update service credential binding
+        value:
+          metadata:
+            labels:
+              foo: bar
+            annotations:
+              baz: qux

apis/cf/latest/components/requestBodies/ServiceInstanceCreateRequestBody.yaml

@@ -0,0 +1,97 @@
+description: A request to create a service instance
+content:
+  application/json:
+    schema:
+      type: object
+      required:
+        - type
+        - name
+        - relationships
+      properties:
+        type:
+          type: string
+          enum:
+            - managed
+            - user-provided
+          description: The type of service instance
+        name:
+          type: string
+          description: Name of the service instance
+        parameters:
+          type: object
+          description: A JSON object that is passed to the service broker (managed services only)
+        credentials:
+          type: object
+          description: A JSON object that is made available to apps bound to this service instance (user-provided services only)
+        tags:
+          type: array
+          items:
+            type: string
+          description: Tags are used by apps to identify service instances; they are shown in the app VCAP_SERVICES env
+        syslog_drain_url:
+          type: string
+          description: URL to which logs for bound applications will be streamed (user-provided services only)
+        route_service_url:
+          type: string
+          description: URL to which requests for bound routes will be forwarded; must use the https protocol (user-provided services only)
+        relationships:
+          type: object
+          required:
+            - space
+          properties:
+            space:
+              $ref: '../schemas/RelationshipToOne.yaml'
+            service_plan:
+              $ref: '../schemas/RelationshipToOne.yaml'
+              description: Required for managed service instances
+          description: Relationships for the service instance
+        metadata:
+          $ref: '../schemas/Metadata.yaml'
+    examples:
+      managed_service_instance:
+        summary: Managed service instance
+        value:
+          type: managed
+          name: my_service_instance
+          parameters:
+            foo: bar
+            baz: qux
+          tags:
+            - foo
+            - bar
+            - baz
+          metadata:
+            annotations:
+              foo: bar
+            labels:
+              baz: qux
+          relationships:
+            space:
+              data:
+                guid: "7304bc3c-7010-11ea-8840-48bf6bec2d78"
+            service_plan:
+              data:
+                guid: "e0e4417c-74ee-11ea-a604-48bf6bec2d78"
+      user_provided_service_instance:
+        summary: User-provided service instance
+        value:
+          type: user-provided
+          name: my_service_instance
+          credentials:
+            foo: bar
+            baz: qux
+          tags:
+            - foo
+            - bar
+            - baz
+          syslog_drain_url: "https://syslog.com/drain"
+          route_service_url: "https://route.com/service"
+          metadata:
+            annotations:
+              foo: bar
+            labels:
+              baz: qux
+          relationships:
+            space:
+              data:
+                guid: "7304bc3c-7010-11ea-8840-48bf6bec2d78"

apis/cf/latest/components/requestBodies/ServiceInstanceUpdateRequestBody.yaml

@@ -0,0 +1,88 @@
+description: A request to update a service instance
+content:
+  application/json:
+    schema:
+      type: object
+      properties:
+        name:
+          type: string
+          description: Name of the service instance
+        parameters:
+          type: object
+          description: A JSON object that is passed to the service broker (managed services only)
+        credentials:
+          type: object
+          description: A JSON object that is made available to apps bound to this service instance (user-provided services only)
+        tags:
+          type: array
+          items:
+            type: string
+          description: Tags are used by apps to identify service instances; they are shown in the app VCAP_SERVICES env
+        syslog_drain_url:
+          type: string
+          description: URL to which logs for bound applications will be streamed (user-provided services only)
+        route_service_url:
+          type: string
+          description: URL to which requests for bound routes will be forwarded; must use the https protocol (user-provided services only)
+        relationships:
+          type: object
+          properties:
+            service_plan:
+              $ref: '../schemas/RelationshipToOne.yaml'
+              description: The service plan from which to create the service instance (managed services only)
+          description: Relationships for the service instance
+        maintenance_info:
+          type: object
+          required:
+            - version
+          properties:
+            version:
+              type: string
+              description: Must be a semantic version value and it must match the version in the maintenance_info for the service instance plan in the updated broker catalog
+          description: Maintenance info object for service instance upgrades (managed services only)
+        metadata:
+          $ref: '../schemas/Metadata.yaml'
+    examples:
+      managed_service_instance:
+        summary: Update managed service instance
+        value:
+          name: my_service_instance
+          parameters:
+            foo: bar
+            baz: qux
+          tags:
+            - foo
+            - bar
+            - baz
+          relationships:
+            service_plan:
+              data:
+                guid: "f2b6ba9c-a4d2-11ea-8ae6-48bf6bec2d78"
+          metadata:
+            annotations:
+              note: detailed information
+            labels:
+              key: value
+      managed_service_instance_upgrade:
+        summary: Upgrade managed service instance
+        value:
+          maintenance_info:
+            version: "2.1.1"
+      user_provided_service_instance:
+        summary: Update user-provided service instance
+        value:
+          name: my_service_instance
+          credentials:
+            foo: bar
+            baz: qux
+          tags:
+            - foo
+            - bar
+            - baz
+          syslog_drain_url: "https://syslog.com/drain"
+          route_service_url: "https://route.com/service"
+          metadata:
+            annotations:
+              foo: bar
+            labels:
+              baz: qux

apis/cf/latest/components/requestBodies/SpaceCreateRequestBody.yaml

@@ -13,8 +13,6 @@ content:
           properties:
             organization:
               $ref: '../schemas/RelationshipToOne.yaml'
-            isolation_segment:
-              $ref: '../schemas/RelationshipToOne.yaml'
           required:
             - organization
         metadata:

apis/cf/latest/components/schemas/App.yaml

@@ -14,5 +14,29 @@ allOf:
         $ref: './Relationships.yaml'
       metadata:
         $ref: './Metadata.yaml'
+      links:
+        type: object
+        properties:
+          self:
+            $ref: './Link.yaml'
+            description: The URL to get this app
+          space:
+            $ref: './Link.yaml'
+            description: The URL to get the space for this app
+          processes:
+            $ref: './Link.yaml'
+            description: The URL to get the processes for this app
+          packages:
+            $ref: './Link.yaml'
+            description: The URL to get the packages for this app
+          environment_variables:
+            $ref: './Link.yaml'
+            description: The URL to get the environment variables for this app
+          current_droplet:
+            $ref: './Link.yaml'
+            description: The URL to get the current droplet for this app
+          droplets:
+            $ref: './Link.yaml'
+            description: The URL to get the droplets for this app
 description: >
   Apps represent the core entities in the Cloud Foundry environment. They are the deployable units that run your code. Each app can have multiple processes, routes, and services associated with it. Apps can be scaled horizontally by increasing the number of instances. They can also be updated and restarted as needed.

apis/cf/latest/components/schemas/AppCredentialBinding.yaml

@@ -64,6 +64,8 @@ properties:
         $ref: './Link.yaml'
       service_instance:
         $ref: './Link.yaml'
+      parameters:
+        $ref: './Link.yaml'
   metadata:
     $ref: './Metadata.yaml'
 required:

apis/cf/latest/components/schemas/AppEnvironmentVariables.yaml

@@ -6,5 +6,12 @@ properties:
     additionalProperties:
       type: string
   links:
-    $ref: './Links.yaml'
+    type: object
+    properties:
+      self:
+        $ref: './Link.yaml'
+        description: The URL to get the environment variables for this app
+      app:
+        $ref: './Link.yaml'
+        description: The URL to get the app for these environment variables
 description: 'App environment variables with links'

apis/cf/latest/components/schemas/AuditEvent.yaml

@@ -45,6 +45,10 @@ allOf:
             type: string
             description: The unique identifier for the organization where the event occurred
       links:
-        $ref: './Links.yaml'
+        type: object
+        properties:
+          self:
+            $ref: './Link.yaml'
+            description: The URL to get this audit event
 description: >
   Audit events help Cloud Foundry operators monitor actions taken against resources (such as apps) via user or system actions.

apis/cf/latest/components/schemas/BaseSchema.yaml

@@ -12,10 +12,6 @@ properties:
     type: string
     format: date-time
     description: "The time the resource was last updated\nTimestamps generally appear in created_at and updated_at fields on resources. \nPrecision beyond seconds is not supported, even if the underlying database supports it (e.g. Postgres). \nAs a result, filtering on sub-second timestamps is not allowed.\nAll v3 timestamps have the following format YYYY-MM-DDThh:mm:ssZ.\nExample timestamp (June 30, 2020 at 11:49:04 PM UTC): 2020-06-30T23:49:04Z\n"
-  links:
-    type: object
-    additionalProperties:
-      $ref: './Link.yaml'
 description: |
   A resource represents an individual object within the system, such as an app or a service. It is represented as a JSON object.
   A resource consists of several required resource fields and other attributes specific to the resource.

apis/cf/latest/components/schemas/Build.yaml

@@ -47,6 +47,16 @@ allOf:
             type: string
             description: The email of the user that created the build
       links:
-        $ref: './Links.yaml'
+        type: object
+        properties:
+          self:
+            $ref: './Link.yaml'
+            description: The URL to get this build
+          app:
+            $ref: './Link.yaml'
+            description: The URL to get the app for this build
+          droplet:
+            $ref: './Link.yaml'
+            description: The URL to get the droplet for this build
 description: >
   Builds represent the process of transforming source code into a runnable artifact. Builds can be triggered manually or automatically as part of the app lifecycle. A successful build results in a droplet that can be used to run the app.