AnsweredAssumed Answered

swagger, json, data schema

Question asked by sdetweil2 on Jun 17, 2015
Latest reply on Jul 30, 2015 by JayantChatterjee62134974

Like • Show 0 Likes0
Comment • 8

I'm creating a service with swagger import on 8.1. almost all good.

the swagger file points to the json document schema, and the generated vsi response shows the url of the schema

how do I surface the schema in the service?

I can do JSON protocol filter, which converts it to xml and puts 'parms' on the virtual request, but I have to type the schema in manually.

I can see the 'parms' in the VSE console, transaction inspection view, but cannot access them in the vsi without manually adding them as transaction arguments.

it almost seems like a step was missed..

I don't see any other mechanism, and the Using Data protocols doc doesn't get into this level of detail.

I see I can use an assertion to verify the data matches a schema, but... the schema is in the swagger yaml file, not in a raw json document.

and using the content or a property as the truth of the schema is like having the fox watch the chicken coop!..

again, I am not recording, as none of my service exist yet. so this may be an edge use case.

No one else has this question

Outcomes

sdetweil2 Jul 25, 2015 5:29 PM

need help!

I have one VSI which shows the json body document elements as part of the VSI parameters, and I need to do that again as the api spec has changed.

but I cannot figure out how I did it.

the service from yaml gets the urls correct, but never shows any mechanism to map the body to arguments.

I have tried all kinds of protocol filters, json/xml/data copier, in different orders.

the Json protocol filter seems to work but I don't see the properties until the response selection step.

I know I didn't do it by hand, there are 100's of json document elements.

Actions

sdetweil2 @ sdetweil2 on Jul 27, 2015 1:49 PM

anybody? I hate to burden Support with this 'how to'

opened support ticket

Actions

sdetweil2 @ sdetweil2 on Jul 27, 2015 7:59 PM

Until this gets solved, I am doing the VSI by hand.. (again, cannot record what does not exist)

how do I deal with optional parameters (from the json body).

it 'looks like' I have to have an EXACT vsi transaction pattern for every combo of attributes (json body elements). altho the sub transaction match could be by operation.

for example, one of the data items is a variable length array, min1- max3 elements

so I have to have transctions with 1 element, 2 elements, and 3 elements,

and there is a url parameter, so I have to have one without (for all three) and one with (for all three)

the parameter is true/false, so by using Operation match, I don't have to have a unique transaction pattern for each state.

with 1000s of patterns for this api set.. it will be a long slog if I have to do it manually.. and they have changed the api 25 times in the last 2 weeks. (thanks to the existing simulator which has exposed functional problems) so it would impossible to keep up..

Actions

sdetweil2 @ sdetweil2 on Jul 30, 2015 2:45 AM

Support responded today, the swagger importer does not examine the schema tag in the YAML 2.0 spec. and as such cannot map the body documents to parameters like wsdl/wadl do..

bummer.. makes working with swagger and json much more difficult.

the yaml importer should work like it does for wsdl/wadl.. follow the data structures..

Actions

JayantChatterjee62134974 @ sdetweil2 on Jul 30, 2015 5:50 PM

Remove the optional parameters. Use a Request Data Manager filter in the end. With this filter you either Remove the parameters which you do not want or Keep the parameters which you want.

For example you get a address fields where Address Line 2 is Optional. You can either Remove AddressLine 2 or you can Keep "AddressLine1, City, State, Zip".

Actions

sdetweil2 @ JayantChatterjee62134974 on Jul 30, 2015 5:53 PM

but.... if addressLine2 comes in, it has to go back out. , same with addressLine3. the api data protocol requires this

Actions

JayantChatterjee62134974 @ sdetweil2 on Jul 30, 2015 6:03 PM

1. First copy the AddressLine2 to MetaData in Req Data Manager

Copy argument named AddressLine2 to metadata AddressLine2 for OperationName

2. Remove it as an argument.

Delete argument names AddressLine2 OperationName

3. Now in the response xml, parameterize the AddressLine2 value as {{=metadata_AddressLine2}}

This way you retain the value and are able to Magic String, but you do not use it for matching.

Actions

JayantChatterjee62134974 @ JayantChatterjee62134974 on Jul 30, 2015 6:05 PM

Make sure the filters are in the same order. You have first copy and then remove the argument.

Actions

8 Replies

sdetweil2 Jul 25, 2015 5:29 PM
Mark Correct
Correct Answer
need help!

I have one VSI which shows the json body document elements as part of the VSI parameters, and I need to do that again as the api spec has changed.

but I cannot figure out how I did it.

the service from yaml gets the urls correct, but never shows any mechanism to map the body to arguments.
I have tried all kinds of protocol filters, json/xml/data copier, in different orders.

the Json protocol filter seems to work but I don't see the properties until the response selection step.

I know I didn't do it by hand, there are 100's of json document elements.
Like • Show 0 Likes0
Actions
- sdetweil2 @ sdetweil2 on Jul 27, 2015 1:49 PM
  Mark Correct
  Correct Answer
  anybody? I hate to burden Support with this 'how to'
  
  opened support ticket
  Like • Show 0 Likes0
  Actions
  - sdetweil2 @ sdetweil2 on Jul 27, 2015 7:59 PM
    Mark Correct
    Correct Answer
    Until this gets solved, I am doing the VSI by hand.. (again, cannot record what does not exist)
    
    how do I deal with optional parameters (from the json body).
    
    it 'looks like' I have to have an EXACT vsi transaction pattern for every combo of attributes (json body elements). altho the sub transaction match could be by operation.
    
    for example, one of the data items is a variable length array, min1- max3 elements
    
    so I have to have transctions with 1 element, 2 elements, and 3 elements,
    and there is a url parameter, so I have to have one without (for all three) and one with (for all three)
    the parameter is true/false, so by using Operation match, I don't have to have a unique transaction pattern for each state.
    
    with 1000s of patterns for this api set.. it will be a long slog if I have to do it manually.. and they have changed the api 25 times in the last 2 weeks. (thanks to the existing simulator which has exposed functional problems) so it would impossible to keep up..
    Like • Show 0 Likes0
    Actions
    - sdetweil2 @ sdetweil2 on Jul 30, 2015 2:45 AM
      Mark Correct
      Correct Answer
      Support responded today, the swagger importer does not examine the schema tag in the YAML 2.0 spec. and as such cannot map the body documents to parameters like wsdl/wadl do..
      
      bummer.. makes working with swagger and json much more difficult.
      
      the yaml importer should work like it does for wsdl/wadl.. follow the data structures..
      Like • Show 0 Likes0
      Actions
    - JayantChatterjee62134974 @ sdetweil2 on Jul 30, 2015 5:50 PM
      Mark Correct
      Correct Answer
      Remove the optional parameters. Use a Request Data Manager filter in the end. With this filter you either Remove the parameters which you do not want or Keep the parameters which you want.
      
      For example you get a address fields where Address Line 2 is Optional. You can either Remove AddressLine 2 or you can Keep "AddressLine1, City, State, Zip".
      Like • Show 0 Likes0
      Actions
      - sdetweil2 @ JayantChatterjee62134974 on Jul 30, 2015 5:53 PM
        Mark Correct
        Correct Answer
        but.... if addressLine2 comes in, it has to go back out. , same with addressLine3. the api data protocol requires this
        Like • Show 0 Likes0
        Actions
        JayantChatterjee62134974 @ sdetweil2 on Jul 30, 2015 6:03 PM
        Mark Correct
        Correct Answer
        1. First copy the AddressLine2 to MetaData in Req Data Manager
        
        Copy argument named AddressLine2 to metadata AddressLine2 for OperationName
        
        2. Remove it as an argument.
        
        Delete argument names AddressLine2 OperationName
        
        3. Now in the response xml, parameterize the AddressLine2 value as {{=metadata_AddressLine2}}
        
        This way you retain the value and are able to Magic String, but you do not use it for matching.
        Like • Show 0 Likes0
        Actions
        JayantChatterjee62134974 @ JayantChatterjee62134974 on Jul 30, 2015 6:05 PM
        Mark Correct
        Correct Answer
        Make sure the filters are in the same order. You have first copy and then remove the argument.
        Like • Show 0 Likes0
        Actions

swagger, json, data schema

Outcomes

Related Content

Recommended Content

Incoming Links