What is the swagger sync-gateway-admin spec.json file?

Mobile Sync Gateway
1

https://developer.couchbase.com/documentation/mobile/1.5/guides/authentication/basic-authentication/index.html

In the Sync Gateway - Basic Authentication - App Server for User Registration part, what is the url link “http://developer.couchbase.com/mobile/swagger/sync-gateway-admin/spec.json”. I can’t find anything about it.

2

FYI

https://blog.couchbase.com/managing-rest-apis-swagger-video/

3

That link appears to be broken. Can you file a ticket please by tapping on “Feedback” link on the page.

In meantime, here are the swagger specs in yaml

4

Yea, I have created a Feedback about the broken link.

Thanks.

1 Like
5

Very good. It’s clear.

Thanks.

6

Updated the docs. Thanks for the feedback!

7

Hi Priya,
the github link you mentioned is not accessible to the public unfortunately:
https://github.com/couchbaselabs/couchbase-mobile-portal/tree/master/swagger/1.5
Rainer.

8

Our documentation site has been rearchitected quite a bit this past year, so it is possible that these are no longer accessible or they have moved (Will let @jamiltz chime in on that). In the meantime, any reason you need direct access to the swagger spec ?

9

Yes, I took down this repo because it was obsolete.
The latest version of swagger specs can be found at
http://docs.couchbase.com/sync-gateway/2.1/_attachments/sync-gateway-public.yaml
http://docs.couchbase.com/sync-gateway/2.1/_attachments/sync-gateway-admin.yaml

I’m also interested to know more about what you’re using the specs for… We don’t currently document those links on https://docs.couchbase.com/sync-gateway/2.1/rest-api.html but could look into it.

1 Like
10

@jamiltz, @priya.rajagopal,
Thank you for the URLs. That’s what I was looking for.

I use the Swagger specs with AutoRest to generate C# client code to access the Sync Gateway admin interface.
Rainer.

1 Like
11

Sorry for bringing this back to life, but … do you also have a location where I could get a VALID and UP_TO_DATE OpenAPI spec in either json or yaml format?

I tried witt the link given by @jamiltz, (The 2.1) , and replaced the 2.1 in the URL with a 2.6. This actually does return a yaml file, and it IS different from the 2.1 version. (Feature request: Could you maybe add some kind of version information within the file? That makes it easier to find out what version you’re actually using).

However, both yaml file contain errors - at least the Swagger editor complains about 1 semantic error in 2.1, and 1 semantic and 3 structural errors in the 2.6 version. Naturally the generated client code is therefore also not compileable.

Do you have a version of the spec that complies with OpenAPI? Also, can I maybe get the OpenAPI spec for “my” SyncGateway directly without using your URL?

Thank you,

/hauke