WilliamWilliams
Occasional Contributor
Joined 2 years ago
User Profile
User Widgets
Contributions
Is it possible to use GitHub integration only for the YAML?
The doc at Code Editor for OpenAPI | SwaggerHub Documentation (smartbear.com) mentions that GitHub integration is used to store generated output. We don't plan to use that, but since we're working with offshore teams I'd like to maintain history and view changes to the API YAML. Is it possible to set that up? I don't see a way in the UI to see changes to the YAML, and would really like to see who is making changes, review them, etc.Solved752Views0likes2CommentsLooking for an example using a Domain defined Response
The page at OpenAPI 3.0 Domain Example | SwaggerHub Documentation (smartbear.com) shows how to define responses in the Domain, but my attempts at referencing them in my endpoint are failing. Is there an existing example or a document that shows the structure of the responses block for openapi 3.0? DOMAIN: ------------------------- ... components: schemas: ResponseWrapper: type: object required: - correlationId properties: correlationId: type: string data: type: object errors: type: array minItems: 0 items: properties: code: type: string description: type: string responses: '200': description: OK headers: X-Correlation-Id: $ref: '#/components/headers/X-Correlation-Id' content: application/json: schema: allOf: - $ref: '#/components/schemas/ResponseWrapper' - type: object required: - data In my endpoint I want to use that 200 response and override the type of the data member to a boolean.Solved696Views0likes1CommentRe: Is it possible to simulate a 500 or other non-200 response with AutoMocking?
Unfortunately not. If I do like you did above the response just says "undocumented" above the previous 200 response. Or I get a 406 error. I would need the mocked up server code to throw a 500. Not sure exactly how they implement that mocking functionality.392Views0likes0CommentsRe: Referencing Domain defined parameter in OpenAPI 3.0
Unfortunately it's for a bank, can't expose the parameters or endpoints. :s Yes, normally if the reference is bad it shows on the line where the error occurs. In my case it was showing at the top of the page. Everything validated correctly, testing out the endpoint worked, everything was happy but the error still showed above the code editor area. I tried closing the window, reopening, going to a different page, etc and it persisted. Looking at it now it's gone. Apparently a UI bug. :s649Views0likes0CommentsIs it possible to simulate a 500 or other non-200 response with AutoMocking?
In order to test my api in SwaggerHub it'd be nice to simulate the response for a 500, 201, 400, etc and make sure that the format of the response is what I expect. Is this possible? When I try a new integration and set up automock that option isn't shown. Thank you!396Views0likes2CommentsReferencing Domain defined parameter in OpenAPI 3.0
I'm trying to define a parameter in a Domain, then use that common paramter in an API's parameters block. Doesn't seem to be working. The Domain and API are both OpenAPI v3.0. In Domain: ... #################### # Common parameters #################### parameters: MyCommonParameter: in: query name: "MyParameter" description: "My common paramter." required: false schema: type: string enum: - "1" ... In the api def: ... parameters: - $ref: 'https://api.swaggerhub.com/domains/mine/mymodels/1.0#/components/parameters/MyCommonParameter' ... It seems to work when viewing the documentation, but the api edit page, at the top, shows: "1 x Integrations Errors". Still saves, still works. Seems like a bug in the editor, but want to make sure I'm using it as expected.Solved734Views0likes3Comments