nav[aria-label="Primary Navigation"] { padding: 0; & ul { list-style: none; width: 100%; display: flex; flex-direction: row; justify-content: start; align-items: start; gap: 30px; padding: 0; & li { margin: 0; } & ul li { list-style: none; } } }

Problem uploading swagger/openapi file

Jack Cox_w01mo5

I've got a component defined and I'm trying to upload an openapi 3.0 spec file but things aren't working as expected. Here's what's going on:

1) If I drag and drop the openapi json file, things work as expected.

2) If I use the curl command to upload the file it only seems to work if there is no openapi spec already in place for that component.

3) If I upload a openapi spec via curl and there is already a spec in place I get a message that the upload was successful, but then any spec disappears from the Compass site. If I try to upload a 2nd time, it sometimes appears in Compass but usually does not.

This behavior make integration with my CI/CD pipeline (github actions) basically impossible.

Accepted answers

All comments

Moinul

Hi Jack, Sorry for the late reply. I'm with the compass engineering team. When you upload via the webhook

1. it sometimes appears in Compass but usually does not -> Do you still see the older version of the swagger file or it just disappears completely?

2. How often are you running those actions? I'm suspecting you might be getting rate limited by forge.

I'll report this issue in the backlog and will try to reproduce the issue locally.

Jack Cox_w01mo5

1) The older version goes away and there is no swagger there at all.

2) Initially I did run them fairly quickly back to back, but I tried again over the weekend, after many hours of idleness, and it still did nothing.

In all cases I get a positive response from the webhook that the swagger was accepted.

Moinul

Hi Jack thanks for the reply. I think we may have identified the problem. Could you tell us the size of the file you were trying to upload?

Jack Cox_w01mo5

The size of the file is 214004 bytes.

jack

Matt Boulton_eiu6y5

@Jack Cox @[deleted]we've made some performance improvements to the Swagger UI app that should resolve this issue you're having. Just note that you'll need to upgrade the Swagger UI app on the Apps page in Compass, and then re-upload your Swagger files to your components.

If you still have this issue, or any other feedback about the app upgrade, let us know! Many thanks for your patience here.

(We're also working on improving the usability of the app, too. Keep an eye out for news on that soon.)

Cheers!

David Harper

Hi @Matt Boulton ,

That looks like it is working now! Many thanks for your help on rebuilding that component; having all the Swagger in one place instead of having to deploy a developer portal is a really handy part of Compass.

Welcome!

It looks like you're new here. Sign in or register to get started.

Quick Links

Find more posts tagged with

api

swagger