Azure Page type nextLink properties should be readOnly: true (#231

) This PR fixes https://github.com/Azure/typespec-azure-pr/issues/3924 by marking `nextLink` properties with `@visibility("read")` so that the OpenAPI output for these properties contains `readOnly: true`. --------- Co-authored-by: Timothee Guerin <timothee.guerin@outlook.com>
Azure · Mar 1, 2024 · 9b6e252 · 9b6e252
1 parent 54f5a32
commit 9b6e252
Show file tree

Hide file tree

Showing 46 changed files with 216 additions and 93 deletions.
diff --git a/.chronus/changes/next-link-read-only-2024-1-28-21-59-17.md b/.chronus/changes/next-link-read-only-2024-1-28-21-59-17.md
@@ -0,0 +1,8 @@
+---
+# Change versionKind to one of: internal, fix, dependencies, feature, deprecation, breaking
+changeKind: fix
+packages:
+  - "@azure-tools/typespec-azure-core"
+---
+
+Azure `Page` type `nextLink` properties are now marked as `readonly`
diff --git a/...core/data-plane/api-path-parameter/@azure-tools/typespec-autorest/2022-08-31/openapi.json b/...core/data-plane/api-path-parameter/@azure-tools/typespec-autorest/2022-08-31/openapi.json
@@ -1110,7 +1110,8 @@
         "nextLink": {
           "type": "string",
           "format": "uri",
-          "description": "The link to the next page of items"
+          "description": "The link to the next page of items",
+          "readOnly": true
         }
       },
       "required": [
@@ -1132,7 +1133,8 @@
         "nextLink": {
           "type": "string",
           "format": "uri",
-          "description": "The link to the next page of items"
+          "description": "The link to the next page of items",
+          "readOnly": true
         }
       },
       "required": [

diff --git a/...utput/azure/core/data-plane/api-path-parameter/@typespec/openapi3/openapi.2022-08-31.yaml b/...utput/azure/core/data-plane/api-path-parameter/@typespec/openapi3/openapi.2022-08-31.yaml
@@ -836,6 +836,7 @@ components:
           type: string
           format: uri
           description: The link to the next page of items
+          readOnly: true
       description: Paged collection of Manufacturer items
     PagedWidget:
       type: object
@@ -851,6 +852,7 @@ components:
           type: string
           format: uri
           description: The link to the next page of items
+          readOnly: true
       description: Paged collection of Widget items
     RepeatabilityResult:
       type: string

diff --git a/.../core/data-plane/custom-error-type/@azure-tools/typespec-autorest/2022-08-31/openapi.json b/.../core/data-plane/custom-error-type/@azure-tools/typespec-autorest/2022-08-31/openapi.json
@@ -558,7 +558,8 @@
         "nextLink": {
           "type": "string",
           "format": "uri",
-          "description": "The link to the next page of items"
+          "description": "The link to the next page of items",
+          "readOnly": true
         }
       },
       "required": [

diff --git a/...output/azure/core/data-plane/custom-error-type/@typespec/openapi3/openapi.2022-08-31.yaml b/...output/azure/core/data-plane/custom-error-type/@typespec/openapi3/openapi.2022-08-31.yaml
@@ -448,6 +448,7 @@ components:
           type: string
           format: uri
           description: The link to the next page of items
+          readOnly: true
       description: Paged collection of Widget items
     RepeatabilityResult:
       type: string

diff --git a/...t/output/azure/core/data-plane/formrecognizer/@azure-tools/typespec-autorest/openapi.json b/...t/output/azure/core/data-plane/formrecognizer/@azure-tools/typespec-autorest/openapi.json
@@ -2037,7 +2037,8 @@
         "nextLink": {
           "type": "string",
           "format": "uri",
-          "description": "The link to the next page of items"
+          "description": "The link to the next page of items",
+          "readOnly": true
         }
       },
       "required": [
@@ -2059,7 +2060,8 @@
         "nextLink": {
           "type": "string",
           "format": "uri",
-          "description": "The link to the next page of items"
+          "description": "The link to the next page of items",
+          "readOnly": true
         }
       },
       "required": [

diff --git a/.../samples/test/output/azure/core/data-plane/formrecognizer/@typespec/openapi3/openapi.yaml b/.../samples/test/output/azure/core/data-plane/formrecognizer/@typespec/openapi3/openapi.yaml
@@ -1400,6 +1400,7 @@ components:
           type: string
           format: uri
           description: The link to the next page of items
+          readOnly: true
       description: Paged collection of ModelSummary items
     PagedOperationInfo:
       type: object
@@ -1415,6 +1416,7 @@ components:
           type: string
           format: uri
           description: The link to the next page of items
+          readOnly: true
       description: Paged collection of OperationInfo items
     SelectionMarkState:
       type: string

diff --git a/...tput/azure/core/data-plane/language/authoring/@azure-tools/typespec-autorest/openapi.json b/...tput/azure/core/data-plane/language/authoring/@azure-tools/typespec-autorest/openapi.json
@@ -1191,7 +1191,8 @@
         "nextLink": {
           "type": "string",
           "format": "uri",
-          "description": "The link to the next page of items"
+          "description": "The link to the next page of items",
+          "readOnly": true
         }
       },
       "required": [
@@ -1213,7 +1214,8 @@
         "nextLink": {
           "type": "string",
           "format": "uri",
-          "description": "The link to the next page of items"
+          "description": "The link to the next page of items",
+          "readOnly": true
         }
       },
       "required": [
@@ -1235,7 +1237,8 @@
         "nextLink": {
           "type": "string",
           "format": "uri",
-          "description": "The link to the next page of items"
+          "description": "The link to the next page of items",
+          "readOnly": true
         }
       },
       "required": [
@@ -1257,7 +1260,8 @@
         "nextLink": {
           "type": "string",
           "format": "uri",
-          "description": "The link to the next page of items"
+          "description": "The link to the next page of items",
+          "readOnly": true
         }
       },
       "required": [

diff --git a/...ples/test/output/azure/core/data-plane/language/authoring/@typespec/openapi3/openapi.yaml b/...ples/test/output/azure/core/data-plane/language/authoring/@typespec/openapi3/openapi.yaml
@@ -901,6 +901,7 @@ components:
           type: string
           format: uri
           description: The link to the next page of items
+          readOnly: true
       description: Paged collection of Deployment items
     PagedProject:
       type: object
@@ -916,6 +917,7 @@ components:
           type: string
           format: uri
           description: The link to the next page of items
+          readOnly: true
       description: Paged collection of Project items
     PagedSupportedLanguage:
       type: object
@@ -931,6 +933,7 @@ components:
           type: string
           format: uri
           description: The link to the next page of items
+          readOnly: true
       description: A collection of SupportedLanguage resources.
     PagedTrainingConfigVersion:
       type: object
@@ -946,6 +949,7 @@ components:
           type: string
           format: uri
           description: The link to the next page of items
+          readOnly: true
       description: A collection of TrainingConfigVersion resources.
     Project:
       type: object

diff --git a/.../output/azure/core/data-plane/languageqna/Raw/@azure-tools/typespec-autorest/openapi.json b/.../output/azure/core/data-plane/languageqna/Raw/@azure-tools/typespec-autorest/openapi.json
@@ -1479,7 +1479,8 @@
         "nextLink": {
           "type": "string",
           "format": "uri",
-          "description": "The link to the next page of items"
+          "description": "The link to the next page of items",
+          "readOnly": true
         }
       },
       "required": [
@@ -1501,7 +1502,8 @@
         "nextLink": {
           "type": "string",
           "format": "uri",
-          "description": "The link to the next page of items"
+          "description": "The link to the next page of items",
+          "readOnly": true
         }
       },
       "required": [
@@ -1523,7 +1525,8 @@
         "nextLink": {
           "type": "string",
           "format": "uri",
-          "description": "The link to the next page of items"
+          "description": "The link to the next page of items",
+          "readOnly": true
         }
       },
       "required": [
@@ -1545,7 +1548,8 @@
         "nextLink": {
           "type": "string",
           "format": "uri",
-          "description": "The link to the next page of items"
+          "description": "The link to the next page of items",
+          "readOnly": true
         }
       },
       "required": [

diff --git a/...samples/test/output/azure/core/data-plane/languageqna/Raw/@typespec/openapi3/openapi.yaml b/...samples/test/output/azure/core/data-plane/languageqna/Raw/@typespec/openapi3/openapi.yaml
@@ -1115,6 +1115,7 @@ components:
           type: string
           format: uri
           description: The link to the next page of items
+          readOnly: true
       description: Paged collection of ProjectDeployment items
     PagedProjectMetadata:
       type: object
@@ -1130,6 +1131,7 @@ components:
           type: string
           format: uri
           description: The link to the next page of items
+          readOnly: true
       description: Paged collection of ProjectMetadata items
     PagedQnaSourceRecord:
       type: object
@@ -1145,6 +1147,7 @@ components:
           type: string
           format: uri
           description: The link to the next page of items
+          readOnly: true
       description: Paged collection of QnaSourceRecord items
     PagedSynonymAsset:
       type: object
@@ -1160,6 +1163,7 @@ components:
           type: string
           format: uri
           description: The link to the next page of items
+          readOnly: true
       description: Paged collection of SynonymAsset items
     ProjectDeployment:
       type: object

diff --git a/...e/core/data-plane/trait-versioning/@azure-tools/typespec-autorest/2022-08-31/openapi.json b/...e/core/data-plane/trait-versioning/@azure-tools/typespec-autorest/2022-08-31/openapi.json
@@ -1014,7 +1014,8 @@
         "nextLink": {
           "type": "string",
           "format": "uri",
-          "description": "The link to the next page of items"
+          "description": "The link to the next page of items",
+          "readOnly": true
         }
       },
       "required": [
@@ -1036,7 +1037,8 @@
         "nextLink": {
           "type": "string",
           "format": "uri",
-          "description": "The link to the next page of items"
+          "description": "The link to the next page of items",
+          "readOnly": true
         }
       },
       "required": [

diff --git a/...e/core/data-plane/trait-versioning/@azure-tools/typespec-autorest/2023-02-07/openapi.json b/...e/core/data-plane/trait-versioning/@azure-tools/typespec-autorest/2023-02-07/openapi.json
@@ -1110,7 +1110,8 @@
         "nextLink": {
           "type": "string",
           "format": "uri",
-          "description": "The link to the next page of items"
+          "description": "The link to the next page of items",
+          "readOnly": true
         }
       },
       "required": [
@@ -1132,7 +1133,8 @@
         "nextLink": {
           "type": "string",
           "format": "uri",
-          "description": "The link to the next page of items"
+          "description": "The link to the next page of items",
+          "readOnly": true
         }
       },
       "required": [

diff --git a/.../output/azure/core/data-plane/trait-versioning/@typespec/openapi3/openapi.2022-08-31.yaml b/.../output/azure/core/data-plane/trait-versioning/@typespec/openapi3/openapi.2022-08-31.yaml
@@ -753,6 +753,7 @@ components:
           type: string
           format: uri
           description: The link to the next page of items
+          readOnly: true
       description: Paged collection of Manufacturer items
     PagedWidget:
       type: object
@@ -768,6 +769,7 @@ components:
           type: string
           format: uri
           description: The link to the next page of items
+          readOnly: true
       description: Paged collection of Widget items
     RepeatabilityResult:
       type: string

diff --git a/.../output/azure/core/data-plane/trait-versioning/@typespec/openapi3/openapi.2023-02-07.yaml b/.../output/azure/core/data-plane/trait-versioning/@typespec/openapi3/openapi.2023-02-07.yaml
@@ -837,6 +837,7 @@ components:
           type: string
           format: uri
           description: The link to the next page of items
+          readOnly: true
       description: Paged collection of Manufacturer items
     PagedWidget:
       type: object
@@ -852,6 +853,7 @@ components:
           type: string
           format: uri
           description: The link to the next page of items
+          readOnly: true
       description: Paged collection of Widget items
     RepeatabilityResult:
       type: string

diff --git a/...ure/core/data-plane/widget-manager/@azure-tools/typespec-autorest/2022-08-31/openapi.json b/...ure/core/data-plane/widget-manager/@azure-tools/typespec-autorest/2022-08-31/openapi.json
@@ -2021,7 +2021,8 @@
         "nextLink": {
           "type": "string",
           "format": "uri",
-          "description": "The link to the next page of items"
+          "description": "The link to the next page of items",
+          "readOnly": true
         }
       },
       "required": [
@@ -2043,7 +2044,8 @@
         "nextLink": {
           "type": "string",
           "format": "uri",
-          "description": "The link to the next page of items"
+          "description": "The link to the next page of items",
+          "readOnly": true
         }
       },
       "required": [
@@ -2065,7 +2067,8 @@
         "nextLink": {
           "type": "string",
           "format": "uri",
-          "description": "The link to the next page of items"
+          "description": "The link to the next page of items",
+          "readOnly": true
         }
       },
       "required": [

diff --git a/...st/output/azure/core/data-plane/widget-manager/@typespec/openapi3/openapi.2022-08-31.yaml b/...st/output/azure/core/data-plane/widget-manager/@typespec/openapi3/openapi.2022-08-31.yaml
@@ -1481,6 +1481,7 @@ components:
           type: string
           format: uri
           description: The link to the next page of items
+          readOnly: true
       description: Paged collection of Manufacturer items
     PagedWidget:
       type: object
@@ -1496,6 +1497,7 @@ components:
           type: string
           format: uri
           description: The link to the next page of items
+          readOnly: true
       description: Paged collection of Widget items
     PagedWidgetPart:
       type: object
@@ -1511,6 +1513,7 @@ components:
           type: string
           format: uri
           description: The link to the next page of items
+          readOnly: true
       description: Paged collection of WidgetPart items
     RepeatabilityResult:
       type: string