Various improvements

.redocly.lint-ignore.yaml

@@ -1,2 +1,5 @@
 # This file instructs Redocly's linter to ignore the rules contained for specific parts of your API.
-# See https://redoc.ly/docs/cli/ for more information.
+# See https://redocly.com/docs/cli/ for more information.
+apis/cf/latest/paths/Packages.yaml:
+  operation-2xx-response:
+    - '#/~1v3~1packages~1{guid}~1download/get/responses'

apis/cf/latest/components/parameters/SpaceGuid.yaml

@@ -0,0 +1,7 @@
+name: space_guid
+in: path
+required: true
+schema:
+  type: string
+  format: uuid
+description: The unique identifier for the space

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

@@ -0,0 +1,30 @@
+description: App object that needs to be created
+required: true
+content:
+  application/json:
+    schema:
+      type: object
+      properties:
+        name:
+          type: string
+          description: Name of the app
+        environment_variables:
+          type: object
+          description: Environment variables to be used for the App when running
+          additionalProperties:
+            type: string
+        lifecycle:
+          $ref: '../schemas/Lifecycle.yaml'
+        relationships:
+          type: object
+          properties:
+            space:
+              $ref: '../schemas/RelationshipToOne.yaml'
+          required:
+            - space
+        metadata:
+          $ref: '../schemas/Metadata.yaml'
+      required:
+        - name
+        - relationships
+      description: Request schema for creating an app

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

@@ -0,0 +1,20 @@
+description: App object that needs to be updated
+required: true
+content:
+  application/json:
+    schema:
+      type: object
+      properties:
+        name:
+          type: string
+          description: Name of the app
+        environment_variables:
+          type: object
+          description: Environment variables to be used for the App when running
+          additionalProperties:
+            type: string
+        lifecycle:
+          $ref: '../schemas/Lifecycle.yaml'
+        metadata:
+          $ref: '../schemas/Metadata.yaml'
+      description: Request schema for updating an app

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

@@ -0,0 +1,23 @@
+description: Build object that needs to be created
+required: true
+content:
+  application/json:
+    schema:
+      type: object
+      properties:
+        package:
+          type: object
+          properties:
+            guid:
+              type: string
+              format: uuid
+          required:
+            - guid
+          description: App package to stage
+        lifecycle:
+          $ref: '../schemas/Lifecycle.yaml'
+        metadata:
+          $ref: '../schemas/Metadata.yaml'
+      required:
+        - package
+      description: Request schema for creating a build

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

@@ -0,0 +1,25 @@
+description: Buildpack object that needs to be updated
+required: true
+content:
+  application/json:
+    schema:
+      type: object
+      properties:
+        name:
+          type: string
+          description: The name of the buildpack
+        position:
+          type: integer
+          description: The position of the buildpack in the order of execution
+        enabled:
+          type: boolean
+          description: Whether the buildpack is enabled
+        locked:
+          type: boolean
+          description: Whether the buildpack is locked
+        stack:
+          type: string
+          description: The stack the buildpack is compatible with
+        metadata:
+          $ref: '../schemas/Metadata.yaml'
+      description: Request schema for updating a buildpack

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

@@ -0,0 +1,32 @@
+description: Domain object that needs to be created
+required: true
+content:
+  application/json:
+    schema:
+      type: object
+      properties:
+        name:
+          type: string
+          description: Name of the domain
+        internal:
+          type: boolean
+          description: Whether the domain is used for internal (container-to-container) traffic
+        router_group:
+          type: object
+          properties:
+            guid:
+              type: string
+              format: uuid
+          description: The router group the domain will be associated with
+        relationships:
+          type: object
+          properties:
+            organization:
+              $ref: '../schemas/RelationshipToOne.yaml'
+            shared_organizations:
+              $ref: '../schemas/RelationshipToMany.yaml'
+        metadata:
+          $ref: '../schemas/Metadata.yaml'
+      required:
+        - name
+      description: Request schema for creating a domain

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

@@ -0,0 +1,10 @@
+description: Domain object that needs to be updated
+required: true
+content:
+  application/json:
+    schema:
+      type: object
+      properties:
+        metadata:
+          $ref: '../schemas/Metadata.yaml'
+      description: Request schema for updating a domain

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

@@ -0,0 +1,18 @@
+description: Organization object that needs to be created
+required: true
+content:
+  application/json:
+    schema:
+      type: object
+      properties:
+        name:
+          type: string
+          description: Organization name
+        suspended:
+          type: boolean
+          description: Whether an organization is suspended or not
+        metadata:
+          $ref: '../schemas/Metadata.yaml'
+      required:
+        - name
+      description: Request schema for creating an organization

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

@@ -0,0 +1,69 @@
+description: Organization quota object that needs to be created
+required: true
+content:
+  application/json:
+    schema:
+      type: object
+      properties:
+        name:
+          type: string
+          description: Name of the quota
+        apps:
+          type: object
+          description: Quotas that affect applications and application sub-resources
+          properties:
+            per_process_memory_in_mb:
+              type: [integer, "null"]
+              description: Maximum memory for a single process or task
+            total_memory_in_mb:
+              type: [integer, "null"]
+              description: Total memory allowed for all the started processes and running tasks in an organization
+            total_instances:
+              type: [integer, "null"]
+              description: Total instances of all the started processes allowed in an organization
+            log_rate_limit_in_bytes_per_second:
+              type: [integer, "null"]
+              description: Total log rate limit allowed for all the started processes and running tasks in an organization
+            per_app_tasks:
+              type: [integer, "null"]
+              description: Maximum number of running tasks in an organization
+        services:
+          type: object
+          description: Quotas that affect services
+          properties:
+            paid_services_allowed:
+              type: boolean
+              description: Specifies whether instances of paid service plans can be created
+            total_service_instances:
+              type: [integer, "null"]
+              description: Total number of service instances allowed in an organization
+            total_service_keys:
+              type: [integer, "null"]
+              description: Total number of service keys allowed in an organization
+        routes:
+          type: object
+          description: Quotas that affect routes
+          properties:
+            total_routes:
+              type: [integer, "null"]
+              description: Total number of routes allowed in an organization
+            total_reserved_ports:
+              type: [integer, "null"]
+              description: Total number of ports that are reservable by routes in an organization
+        domains:
+          type: object
+          description: Quotas that affect domains
+          properties:
+            total_domains:
+              type: [integer, "null"]
+              description: Total number of domains that can be scoped to an organization
+        relationships:
+          type: object
+          properties:
+            organizations:
+              $ref: '../schemas/RelationshipToMany.yaml'
+        metadata:
+          $ref: '../schemas/Metadata.yaml'
+      required:
+        - name
+      description: Request schema for creating an organization quota

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

@@ -0,0 +1,62 @@
+description: Organization quota object that needs to be updated
+required: true
+content:
+  application/json:
+    schema:
+      type: object
+      properties:
+        name:
+          type: string
+          description: Name of the quota
+        apps:
+          type: object
+          description: Quotas that affect applications and application sub-resources
+          properties:
+            per_process_memory_in_mb:
+              type: [integer, "null"]
+              description: Maximum memory for a single process or task
+            total_memory_in_mb:
+              type: [integer, "null"]
+              description: Total memory allowed for all the started processes and running tasks in an organization
+            total_instances:
+              type: [integer, "null"]
+              description: Total instances of all the started processes allowed in an organization
+            log_rate_limit_in_bytes_per_second:
+              type: [integer, "null"]
+              description: Total log rate limit allowed for all the started processes and running tasks in an organization
+            per_app_tasks:
+              type: [integer, "null"]
+              description: Maximum number of running tasks in an organization
+        services:
+          type: object
+          description: Quotas that affect services
+          properties:
+            paid_services_allowed:
+              type: boolean
+              description: Specifies whether instances of paid service plans can be created
+            total_service_instances:
+              type: [integer, "null"]
+              description: Total number of service instances allowed in an organization
+            total_service_keys:
+              type: [integer, "null"]
+              description: Total number of service keys allowed in an organization
+        routes:
+          type: object
+          description: Quotas that affect routes
+          properties:
+            total_routes:
+              type: [integer, "null"]
+              description: Total number of routes allowed in an organization
+            total_reserved_ports:
+              type: [integer, "null"]
+              description: Total number of ports that are reservable by routes in an organization
+        domains:
+          type: object
+          description: Quotas that affect domains
+          properties:
+            total_domains:
+              type: [integer, "null"]
+              description: Total number of domains that can be scoped to an organization
+        metadata:
+          $ref: '../schemas/Metadata.yaml'
+      description: Request schema for updating an organization quota

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

@@ -0,0 +1,16 @@
+description: Organization object that needs to be updated
+required: true
+content:
+  application/json:
+    schema:
+      type: object
+      properties:
+        name:
+          type: string
+          description: Organization name
+        suspended:
+          type: boolean
+          description: Whether an organization is suspended or not
+        metadata:
+          $ref: '../schemas/Metadata.yaml'
+      description: Request schema for updating an organization

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

@@ -0,0 +1,46 @@
+description: Package object that needs to be created
+required: true
+content:
+  application/json:
+    schema:
+      type: object
+      properties:
+        type:
+          type: string
+          description: Type of the package; valid values are bits or docker
+          enum:
+            - bits
+            - docker
+        data:
+          type: object
+          description: Data for package type
+          properties:
+            image:
+              type: string
+              description: The registry address of the image (for docker packages)
+            username:
+              type: string
+              description: The username for the image's registry (for docker packages)
+            password:
+              type: string
+              description: The password for the image's registry (for docker packages)
+        relationships:
+          type: object
+          properties:
+            app:
+              type: object
+              properties:
+                data:
+                  type: object
+                  properties:
+                    guid:
+                      type: string
+                      format: uuid
+          required:
+            - app
+        metadata:
+          $ref: '../schemas/Metadata.yaml'
+      required:
+        - type
+        - relationships
+      description: Request schema for creating a package

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

@@ -0,0 +1,10 @@
+description: Package object that needs to be updated
+required: true
+content:
+  application/json:
+    schema:
+      type: object
+      properties:
+        metadata:
+          $ref: '../schemas/Metadata.yaml'
+      description: Request schema for updating a package