Forum Discussion

ANRAPI's avatar
ANRAPI
New Contributor
5 years ago

Openapi 3.0.1 in ReadyAPI 3.0.0

I'm working with ReadyAPI 3.0.0. I want to add API from Swagger/OpenAPI Definition 5REST) with Jsonfile {"openapi":"3.0.1",... It worked well in the previous version of swagger jsonfile {"swagger":...
REST
  • sonya_m's avatar
    sonya_m
    5 years ago

    Thank you richie, nmrao!

     

    ANRAPI , were you able to solve this yet? If not, opening a support ticket might be a good idea. 

     

     

richie's avatar
richie
Community Hero
Hi ANRAPI,

You dont actually mention what the problem is! :)

You ask about a solution and mention openapi v3.0, but whats actually happening?

Whats actually the response when you try and load in the file?
Are you sure that openAPI v3.0 is supported by ReadyAPI! V3.0?

Cheers

Rich
ANRAPI's avatar
ANRAPI
New Contributor
5 years ago

richie 

Recently we have updated the Json-files {"swagger":"2.0",...} to {"openapi":"3.0.1",...} It worked well with version 2.0.
If I add the API with Json {"openapi":"3.0.1",...} the following type of errors is given:
1/  attribute paths.'/api/v1/...'(post).swaggerIgnore is unexpected

2/  attribute components.schemas.Support.Api.Controllers.OAuth.ClientCredentialGrant.ClientCredentialGrantWithAllScopesRequest.additionalProperties is not of type `object`
3/ attribute components.schemas.Schema name Infrastructure.Api.Hydra.HydraCollection  doesn't adhere to regular expression ^[a-zA-Z0-9\.\-_]+$

I'm not sure that openAPI v3.0 is supported by ReadyAPI V3.0
  • nmrao's avatar
    nmrao
    Champion Level 3
    5 years ago
    Here are couple of threads based on which it does not confirms support for OAS 3.0.1; it is currently support 3.0.0.

    it is a bit old, but not updates (there is defect / enhancement regarding the same RIA-9609)
    https://community.smartbear.com/t5/SoapUI-Pro/Support-of-openapi-3-0-1-specification-in-ReadyAPI/td-p/174048

    Latest version release notes with bug fix details and it does not have the above defect it
    https://support.smartbear.com/readyapi/docs/general-info/version-history/bugs-fixed-in-ver-3-0.html

    Best thing would be to open a support ticket and find the status of the issue and / or ETA for the fix.
  • richie's avatar
    richie
    Community Hero
    5 years ago
    Hi ANRAPI,

    Looking at your errors it appears that you might have errors in the content of the .json file itself, especially the last error. You might have some malformed/invalid detail in the file cos it appears at least from the last error it looks like you have an attribute value that doesnt correspond to a defined regex pattern.
    Have you tried using checking the wellformedness/validity of the file via an online tool or something like a recent version of xmlspy (which includes .json wellformed/valid functionality)?

    Id double check the file to ensure its ok and if not (as the errors may suggest) fix the file and then retry.

    Id also check ReadyAPI!'s release notes regarding openAPI/swagger to double check if v3.0 is supported. If its not, then youll have to downgrade your opemAPI file to the earlier supported version.

    Cheers,

    Rich
    • nmrao's avatar
      nmrao
      Champion Level 3
      5 years ago
      richie, Downgrading version in the swagger file would not be in the hands of QA engineers as certain features only work in specific version of swagger.
    • ANRAPI's avatar
      ANRAPI
      New Contributor
      5 years ago
      1/ In Ready API docs I find this :
      Features Added to ReadyAPI 2.7 / Overall improvements / Support for OpenAPI specifications ver. 3.0.1 and 3.0.2.
      So I should think that it works also in Ready API 3.0.0
      2/ when I use a json validator: it says it's valid jsonfile - I'll ask the devs to double check it for me
      • ANRAPI's avatar
        ANRAPI
        New Contributor
        5 years ago

        In the OpenAPI 3.0.1 we use customised attributes - probably that's the cause it doesn't work