OpenAPI: xml

Question

Hello,&nbsp;I would like to define for a put request a request body as described:&nbsp;&lt;startupConfig&gt;&nbsp; &nbsp; &lt;kroneMaterialNumbers&gt;&nbsp; &nbsp; &nbsp; &nbsp; &lt;KMAT number="204241000" nameProduktstrukturService="BX404-10"&gt;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &lt;WorkingSteps&gt;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &lt;WorkingStep OrderNr="1"&gt;stepSetup&lt;/WorkingStep&gt;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &lt;WorkingStep OrderNr="2"&gt;stepKSC&lt;/WorkingStep&gt;&nbsp;Because of Working Step is an array I can't find a solution to describe the attribute "OrderNr" in OpenAPI 3.0&nbsp;I tried to use properties&nbsp;&nbsp;WorkingStep :&nbsp; type: array&nbsp; properties:properties:&nbsp; number:&nbsp; &nbsp; type: integer&nbsp; &nbsp; xml:&nbsp; &nbsp; &nbsp;attribute: true&nbsp; items:&nbsp; &nbsp;...&nbsp;but no attributes are display or generated.&nbsp;Can anyone help?

chichepo · Answer

chris01&nbsp;I tried this definition:&nbsp;components:
  schemas:
    KroneMaterialNumbers:
      type: object
      properties:
        kroneMaterialNumbers:
          $ref: '#/components/schemas/KMAT'
      xml:
        attribute: true
        name: kroneMaterialNumbers
    KMAT:
      type: object
      xml:
        name: KMAT
      properties:
        number:
          type: string
          example: 204241000
          xml:
            attribute: true
        nameProduktstrukturService:
          type: string
          example: BX404-10
          xml:
            attribute: true
        workingSteps:
          $ref: '#/components/schemas/WorkingSteps'
          
    WorkingSteps:
      type: array
      items:
        $ref: '#/components/schemas/WorkingStep'
      xml:
        wrapped : true
        name: WorkingSteps

WorkingStep:
      type: object
      xml: 
        name: WorkingStep
      properties:
        OrderNr:
          type: string
          example: 1
          xml:
            attribute: true&nbsp;&nbsp;I get this:By the way, you can check this pageLet me know

chris01 · Answer

Hello Chichepo,&nbsp;thanks for your answer. My problem is, by your solutions you get an array like this:&nbsp;&nbsp; &nbsp; &nbsp; &nbsp; &lt;KMAT number="204241000" nameProduktstrukturService="BX404-10"&gt;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &lt;WorkingSteps&gt;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &lt;WorkingStep OrderNr="1"&gt;stepSetup&lt;/WorkingStep&gt;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &lt;/WorkingSteps&gt;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &lt;WorkingSteps&gt;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &lt;WorkingStep OrderNr="2"&gt;stepSetup&lt;/WorkingStep&gt;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &lt;/WorkingSteps&gt;&nbsp; &nbsp; &nbsp; &nbsp; &lt;/KMAT&gt;&nbsp;but what I'm looking for is to process this kind of input:&nbsp;&nbsp; &nbsp; &nbsp; &nbsp; &lt;KMAT number="204241000" nameProduktstrukturService="BX404-10"&gt;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &lt;WorkingSteps&gt;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &lt;WorkingStep OrderNr="1"&gt;stepSetup&lt;/WorkingStep&gt;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &lt;WorkingStep OrderNr="2"&gt;stepKSC&lt;/WorkingStep&gt;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &lt;WorkingStep OrderNr="3"&gt;stepCleanHubDrive&lt;/WorkingStep&gt;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &lt;WorkingStep OrderNr="4"&gt;stepHeadersimulator&lt;/WorkingStep&gt;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &lt;WorkingStep OrderNr="5"&gt;stepParkBrake&lt;/WorkingStep&gt;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &lt;WorkingStep OrderNr="6"&gt;stepFieldSimulationHighPressureFor&lt;/WorkingStep&gt;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &lt;WorkingStep OrderNr="7"&gt;stepFieldSimulationHighPressureBack&lt;/WorkingStep&gt;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &lt;WorkingStep OrderNr="8"&gt;stepFieldSimulationIntake1&lt;/WorkingStep&gt;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &lt;WorkingStep OrderNr="9"&gt;stepFieldSimulationIntake2&lt;/WorkingStep&gt;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &lt;WorkingStep OrderNr="10"&gt;stepFieldSimulationHeader&lt;/WorkingStep&gt;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &lt;WorkingStep OrderNr="12"&gt;stepSpeedForwardRoad&lt;/WorkingStep&gt;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &lt;WorkingStep OrderNr="11"&gt;stepMRDT&lt;/WorkingStep&gt;&nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &nbsp; &lt;/WorkingSteps&gt;&nbsp; &nbsp; &nbsp; &nbsp; &lt;/KMAT&gt;&nbsp;The function which I want to implement is to import a given set xmls and I can't change the format because of it is still be used.&nbsp;Regards&nbsp;

Forum Discussion

OpenAPI: xml

Related Content

Defining conditional attributes in OpenAPI

c# openapi parameter schema object

Sub Tags Option in OpenAPI 3.0

Creating OpenAPI definition from Java code

Import OpenAPI spec error

Recent Discussions

SwaggerHub InActive User Deletion

Cannot export API - No owner available

3.1.0 Editor exports inlined?

Error exporting Standardization rules

Import API using API endpoint with Authorization