feat(spec): codify Encoding in specific requestBody mediatypes

.github/workflows/validate-markdown.yaml

@@ -18,10 +18,14 @@ jobs:
     runs-on: ubuntu-latest
 
     steps:
-    - uses: actions/checkout@v2 # checkout repo content
-    - uses: actions/setup-node@v1 # setup Node.js
+    - uses: actions/checkout@v4 # checkout repo content
       with:
-        node-version: '14.x'
+        fetch-depth: 0
+    - name: use the javascript environment from main
+      run: |
+        git checkout remotes/origin/main -- package.json package-lock.json
+    - uses: actions/setup-node@v4 # setup Node.js
+      with:
+        node-version: '20.x'
     - name: Validate markdown
-      run: npx mdv versions/3.*.md
-
+      run: npx --yes mdv versions/3.*.md

.gitignore

@@ -5,7 +5,6 @@
 target
 atlassian-ide-plugin.xml
 node_modules/
-package-lock.json
 deploy/
 history
 Gemfile.lock

schemas/v3.0/schema.yaml

@@ -392,6 +392,26 @@ definitions:
     additionalProperties: false
 
   MediaType:
+    type: object
+    properties:
+      schema:
+        oneOf:
+          - $ref: '#/definitions/Schema'
+          - $ref: '#/definitions/Reference'
+      example: {}
+      examples:
+        type: object
+        additionalProperties:
+          oneOf:
+            - $ref: '#/definitions/Example'
+            - $ref: '#/definitions/Reference'
+    patternProperties:
+      '^x-': {}
+    additionalProperties: false
+    allOf:
+      - $ref: '#/definitions/ExampleXORExamples'
+
+  MediaTypeWithEncoding:
     type: object
     properties:
       schema:
@@ -758,6 +778,9 @@ definitions:
         type: object
         additionalProperties:
           $ref: '#/definitions/MediaType'
+        patternProperties:
+          "^application/x-www-form-urlencoded$|^multipart\/.+$":
+            $ref: "#/definitions/MediaTypeWithEncoding"
       required:
         type: boolean
         default: false

schemas/v3.1/schema.yaml

@@ -499,10 +499,24 @@ $defs:
     type: object
     additionalProperties:
       $ref: '#/$defs/media-type'
+    patternProperties:
+      '^application/x-www-form-urlencoded$|^multipart\/.+$':
+        $ref: '#/$defs/media-type-with-encoding'
     propertyNames:
       format: media-range
 
   media-type:
+    $comment: https://spec.openapis.org/oas/v3.1.0#media-type-object
+    type: object
+    properties:
+      schema:
+        $dynamicRef: '#meta'
+    allOf:
+      - $ref: '#/$defs/specification-extensions'
+      - $ref: '#/$defs/examples'
+    unevaluatedProperties: false
+
+  media-type-with-encoding:
     $comment: https://spec.openapis.org/oas/v3.1.0#media-type-object
     type: object
     properties:

versions/3.0.0.md

@@ -1544,7 +1544,7 @@ requestBody:
             # default Content-Type for arrays is based on the `inner` type (object shown, so `application/json` in this example)
             type: array
             items:
-              type: '#/components/schemas/Address'
+              $ref: '#/components/schemas/Address'
 ```
 
 An `encoding` attribute is introduced to give you control over the serialization of parts of `multipart` request bodies.  This attribute is _only_ applicable to `multipart` and `application/x-www-form-urlencoded` request bodies.

versions/3.0.1.md

@@ -1544,7 +1544,7 @@ requestBody:
             # default Content-Type for arrays is based on the `inner` type (object shown, so `application/json` in this example)
             type: array
             items:
-              type: '#/components/schemas/Address'
+              $ref: '#/components/schemas/Address'
 ```
 
 An `encoding` attribute is introduced to give you control over the serialization of parts of `multipart` request bodies.  This attribute is _only_ applicable to `multipart` and `application/x-www-form-urlencoded` request bodies.

versions/3.0.2.md

@@ -1566,7 +1566,7 @@ requestBody:
             # default Content-Type for arrays is based on the `inner` type (object shown, so `application/json` in this example)
             type: array
             items:
-              type: '#/components/schemas/Address'
+              $ref: '#/components/schemas/Address'
 ```
 
 An `encoding` attribute is introduced to give you control over the serialization of parts of `multipart` request bodies.  This attribute is _only_ applicable to `multipart` and `application/x-www-form-urlencoded` request bodies.

versions/3.0.3.md

@@ -1569,7 +1569,7 @@ requestBody:
             # default Content-Type for arrays is based on the `inner` type (object shown, so `application/json` in this example)
             type: array
             items:
-              type: '#/components/schemas/Address'
+              $ref: '#/components/schemas/Address'
 ```
 
 An `encoding` attribute is introduced to give you control over the serialization of parts of `multipart` request bodies.  This attribute is _only_ applicable to `multipart` and `application/x-www-form-urlencoded` request bodies.