docusign / OpenAPI-Specifications

The official Docusign REST APIs Swagger Specifications
MIT License
20 stars 15 forks source link

"offlineAttributes" are not defined in both swagger files #36

Open tbolsh opened 3 years ago

tbolsh commented 3 years ago

I was trying to generate a golang client using the go-swagger utility and it barks on both swagger files:

swagger generate client -f ../eSign-OpenAPI-Specification/esignature.rest.swagger-v2.1.json -A go-demo-client 2021/01/14 10:35:17 validating spec /Users/gcsadmin/projects/docusign-api/eSign-OpenAPI-Specification/esignature.rest.swagger-v2.1.json The swagger spec at "/Users/gcsadmin/projects/docusign-api/eSign-OpenAPI-Specification/esignature.rest.swagger-v2.1.json" is invalid against swagger specification 2.0. see errors :

I have corrected files (the ones go-swagger validates) and if you want I can provide them to you as PR. Timofei Bolshakov, timofei.bolshakov@docusign.com

tbolsh commented 3 years ago

That's the utility: https://github.com/go-swagger/go-swagger

aymanbagabas commented 3 years ago

I can confirm the same problem, OfflineAttributes type is not defined in the specs.

image (Taken from Swagger Editor)

pimterry commented 3 years ago

I've just hit this too - that broken ref makes the spec currently unusable by most tools, since it's impossible to dereference. @RajRele @mmallis87 is it possible to get this fixed?

mjbarton712 commented 2 years ago

Also ran into this

kolesnick commented 2 years ago

Have the same issue. Quite unfortunate :/

ghost commented 1 year ago

Hello,

Recently I ran into this same issue when trying to generate a client for Elixir/OTP and my solution was to edit the swagger file locally and just remove this definition before generating the code. That didn't give me any trouble in the final application, so I assume this type is not currently used for anything.

Any update on this issue?

tbolsh commented 1 year ago

Will be fixed in the next version (23.1.00.00) - Dev Center returned this to me (I forgot about this issue completely). I will create a PR today. Workaround: manually edit swagger file and insert following definition between "oauthAccess": and "page":

    "offlineAttributes": {
      "description": "Reserved for DocuSign use.",
      "type": "object",
      "properties": {
        "accountEsignId": {
          "description": "A GUID identifying the account associated with the consumer disclosure",
          "type": "string"
        },
        "deviceModel": {
          "description": "A string containing information about the model of the device used for offline signing.",
          "type": "string"
        },
        "deviceName": {
          "description": "A string containing information about the type of device used for offline signing.",
          "type": "string"
        },
        "gpsLatitude": {
          "description": "A string containing the latitude of the device location at the time of signing.",
          "type": "string"
        },
        "gpsLongitude": {
          "description": "A string containing the longitude of the device location at the time of signing.",
          "type": "string"
        },
        "offlineSigningHash": {
          "description": "",
          "type": "string"
        }
      }
    },

See the screenshot: Screenshot 2023-01-20 at 10 30 35 AM

nathany-copia commented 1 year ago

Offline Attributes are defined in esignature.rest.swagger-v2.1.json now. Tested after #72 was merged.

I haven't tried the other file.