chore: rename 'x-cli' extension to 'x-mgc'

This makes more sense, as the extensions aren't specific to the CLI, but to the SDK as a whole
MagaluCloud · Oct 30, 2023 · f69edae · f69edae
1 parent f4cbe90
commit f69edae
Show file tree

Hide file tree

Showing 20 changed files with 143 additions and 143 deletions.
diff --git a/mgc/cli/RUNNING.md b/mgc/cli/RUNNING.md
@@ -192,7 +192,7 @@ The CLI can output the requests in the following formats using the `-o` flag:
 - template
 
 Some commands have a default output format defined in the OpenAPI spec using an
-`x-cli` extension. The format will be overridden if the user specify a new
+`x-mgc` extension. The format will be overridden if the user specify a new
 output format.
 
 ### JSON

diff --git a/mgc/cli/openapis/block-storage.openapi.yaml b/mgc/cli/openapis/block-storage.openapi.yaml
@@ -87,7 +87,7 @@ paths:
             security:
             -   OAuth2:
                 - block-storage.read
-        x-cli-hidden: true
+        x-mgc-hidden: true
     /v0/usage:
         get:
             tags:
@@ -215,7 +215,7 @@ paths:
             security:
             -   OAuth2:
                 - block-storage.write
-            x-cli-name: restore
+            x-mgc-name: restore
         delete:
             tags:
             - snapshots
@@ -266,7 +266,7 @@ paths:
             security:
             -   OAuth2:
                 - block-storage.read
-            x-cli-description: List all Block Storage volumes
+            x-mgc-description: List all Block Storage volumes
         post:
             tags:
             - block-storage
@@ -312,7 +312,7 @@ paths:
             security:
             -   OAuth2:
                 - block-storage.write
-            x-cli-description: Create a Block Storage volume
+            x-mgc-description: Create a Block Storage volume
     /v0/volumes/{id}:
         get:
             tags:
@@ -363,13 +363,13 @@ paths:
                             operationId: volume_details_v0_volumes__id__get
                             parameters:
                                 id: $request.path.id
-                            x-cli-extra-parameters:
+                            x-mgc-extra-parameters:
                             -   name: virtual_machine_id
                                 required: true
                                 schema:
                                     type: string
                                     format: uuid
-                            x-cli-wait-termination:
+                            x-mgc-wait-termination:
                                 maxRetries: 2
                                 interval: 5s
                                 jsonPathQuery: $.result.attachments[?(@.virtual_machine_id
@@ -383,7 +383,7 @@ paths:
             security:
             -   OAuth2:
                 - block-storage.read
-            x-cli-description: Get a Block Storage volume details
+            x-mgc-description: Get a Block Storage volume details
         delete:
             tags:
             - block-storage
@@ -419,7 +419,7 @@ paths:
             security:
             -   OAuth2:
                 - block-storage.write
-            x-cli-description: Delete a Block Storage volume
+            x-mgc-description: Delete a Block Storage volume
         patch:
             tags:
             - block-storage
@@ -468,7 +468,7 @@ paths:
             security:
             -   OAuth2:
                 - block-storage.write
-            x-cli-description: Update a Block Storage volume
+            x-mgc-description: Update a Block Storage volume
     /v0/volumes/{id}/attach/{virtual_machine_id}:
         post:
             tags:
@@ -513,7 +513,7 @@ paths:
                             operationId: volume_details_v0_volumes__id__get
                             parameters:
                                 id: $request.path.id
-                            x-cli-wait-termination:
+                            x-mgc-wait-termination:
                                 maxRetries: 1
                                 interval: 5s
                                 jsonPathQuery: $.result.attachments[?(@.virtual_machine_id
@@ -527,7 +527,7 @@ paths:
             security:
             -   OAuth2:
                 - block-storage.write
-            x-cli-name: attach
+            x-mgc-name: attach
     /v0/volumes/{id}/detach/{virtual_machine_id}:
         post:
             tags:
@@ -586,7 +586,7 @@ paths:
             security:
             -   OAuth2:
                 - block-storage.write
-            x-cli-name: detach
+            x-mgc-name: detach
 components:
     schemas:
         AttachmentResponse:
@@ -1102,7 +1102,7 @@ components:
 tags:
 -   name: healthchecks
     description: healthchecks
-    x-cli-hidden: true
+    x-mgc-hidden: true
 -   name: usage
     description: usage
 -   name: snapshots
@@ -1111,8 +1111,8 @@ tags:
     description: volume types
 -   name: block-storage
     description: block storage
-    x-cli-description: Block Storage Volume Resources
-    x-cli-name: volume
+    x-mgc-description: Block Storage Volume Resources
+    x-mgc-name: volume
 servers:
 -   url: https://api-block-storage{env}.{region}.jaxyendy.com
     variables:
@@ -1129,7 +1129,7 @@ servers:
             enum:
             - ''
             - .pre-prod
-            x-cli-transforms:
+            x-mgc-transforms:
             -   type: translate
                 translations:
                 -   from: prod

diff --git a/mgc/cli/openapis/dbaas.openapi.yaml b/mgc/cli/openapis/dbaas.openapi.yaml
@@ -282,7 +282,7 @@ paths:
             security:
             -   OAuth2:
                 - dbaas.read
-            x-cli-wait-termination:
+            x-mgc-wait-termination:
                 maxRetries: 30
                 interval: 10s
                 jsonPathQuery: $.result.status == "ACTIVE" || $.result.status == "ERROR"
@@ -1967,7 +1967,7 @@ servers:
             enum:
             - ''
             - .pre-prod
-            x-cli-transforms:
+            x-mgc-transforms:
             -   type: translate
                 translations:
                 -   from: prod

diff --git a/mgc/cli/openapis/mke.openapi.yaml b/mgc/cli/openapis/mke.openapi.yaml
@@ -27,7 +27,7 @@ servers:
             enum:
             - ''
             - .pre-prod
-            x-cli-transforms:
+            x-mgc-transforms:
             -   type: translate
                 translations:
                 -   from: prod

diff --git a/mgc/cli/openapis/network.openapi.yaml b/mgc/cli/openapis/network.openapi.yaml
@@ -151,7 +151,7 @@ paths:
                 required: true
                 schema:
                     title: Vpc Id
-                x-cli-name: vpc
+                x-mgc-name: vpc
             -   name: detailed
                 in: query
                 required: false
@@ -200,8 +200,8 @@ paths:
                             schema:
                                 $ref: '#/components/schemas/HTTPValidationError'
             viveiro: true
-            x-cli-description: List VPC ports
-            x-cli-name: list-vpc-ports
+            x-mgc-description: List VPC ports
+            x-mgc-name: list-vpc-ports
             security:
             -   OAuth2:
                 - network.read
@@ -4676,7 +4676,7 @@ servers:
             enum:
             - ''
             - .pre-prod
-            x-cli-transforms:
+            x-mgc-transforms:
             -   type: translate
                 translations:
                 -   from: prod
@@ -4685,30 +4685,30 @@ servers:
                     to: .pre-prod
 tags:
 -   name: vpc
-    x-cli-description: Virtual Private Cloud (VPC)
+    x-mgc-description: Virtual Private Cloud (VPC)
 -   name: port
-    x-cli-description: VPC Port
+    x-mgc-description: VPC Port
 -   name: security_group
-    x-cli-description: VPC Security Groups
+    x-mgc-description: VPC Security Groups
 -   name: rule
-    x-cli-description: VPC Rules
+    x-mgc-description: VPC Rules
 -   name: public_ip
-    x-cli-description: VPC Public IPs
+    x-mgc-description: VPC Public IPs
 -   name: subnets
-    x-cli-description: VPC Subnets
+    x-mgc-description: VPC Subnets
 -   name: healthcheck
-    x-cli-hidden: true
+    x-mgc-hidden: true
 -   name: xaas_vpc
-    x-cli-hidden: true
+    x-mgc-hidden: true
 -   name: xaas_subnetpools
-    x-cli-hidden: true
+    x-mgc-hidden: true
 -   name: xaas_rule
-    x-cli-hidden: true
+    x-mgc-hidden: true
 -   name: xaas_security_group
-    x-cli-hidden: true
+    x-mgc-hidden: true
 -   name: xaas_port
-    x-cli-hidden: true
+    x-mgc-hidden: true
 -   name: xaas_subnets
-    x-cli-hidden: true
+    x-mgc-hidden: true
 -   name: quotas
-    x-cli-description: VPC Quotas
+    x-mgc-description: VPC Quotas
diff --git a/mgc/cli/openapis/object-storage.openapi.disabled.yaml b/mgc/cli/openapis/object-storage.openapi.disabled.yaml
@@ -25,7 +25,7 @@ servers:
             enum:
             - ''
             - .pre-prod
-            x-cli-transforms:
+            x-mgc-transforms:
             -   type: translate
                 translations:
                 -   from: prod