openapi: Error: ReadMe API error: An API reference by that name already exists. Did you mean to update that one instead?

[behnam-oneschema]

I have these a few readmeio/rdme@v10 steps in my workflow job, with exactly the parameters, except the file name and slug value:

  - name: "Deploy OAS: Templates"
    uses: readmeio/rdme@v10
    with:
      rdme: >
        openapi upload --key=${{ secrets.README_API_KEY }}
          --confirm-overwrite --slug=templates.json
          docs/external_api/templates.yaml

  - name: "Deploy OAS: Workflows"
    uses: readmeio/rdme@v10
    with:
      rdme: >
        openapi upload --key=${{ secrets.README_API_KEY }}
          --confirm-overwrite --slug=workflows.json
          docs/external_api/workflows.yaml

These steps fail randomly with the this error:

Error: ReadMe API error: An API reference by that name already exists. Did you mean to update that one instead?

If you intended to update this API you should use the `updateAPI` operation instead.

Looking at https://github.com/readmeio/rdme/blob/next/documentation/commands/openapi.md#rdme-openapi-upload-spec, I see that it clearly says "Upload (or re-upload) your API definition", meaning that it's correct to use openapi upload for updating the resources.

And, I've already set --confirm-overwrite, to avoid asking for confirmation from command-line.

This looks like a bug in this action, or something going wrong on the API server side.

---

Example from a recent run:

[sokol8]

I just run into the same issue with the code that used to work perfectly well a week ago

this command

rdme openapi upload ./bundled_docs/mydoc.json --slug=mydoc.json --key $README_API_KEY

used to work but now I get error

✔ This will overwrite the existing API definition for repliers.json. Are you sure you want to continue? … yes
✖ Updating your API definition to ReadMe...

ReadMe API error: An API reference by that name already exists. Did you mean to update that one instead?

If you intended to update this API you should use the `updateAPI` operation instead.

what am I doing wrong?

[berzniz]

We're seeing the same error now and can't fix it

[pso-aeb]

Also see #1151

[sokol8]

I just tried an update command from CLI again and it worked for me.
Seems to be an intermittent bug on readme backend, but it would help if they acknowledged the incident.

[behnam-oneschema]

For anyone else ending up here: this was actually resolved by me contacting the readme support team from the dashboard, after seeing (under /update/reference) that the problematic resource was in a broken state.

I think the support team was able to unbreak the resource with a dummy change from the dashboard. Maybe that resolves the issue for some of you, too.

For now, I'm going to leave this open for others to be able to find it easily, too.

And, regardless of the server-side issue, personally, I think the CLI should be able to communicate better about the cause of this being a server-side problem, and not a command problem.