search

docusign / OpenAPI-Specifications

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

Type offlineAttributes definition references itself #22

Closed Bouhmarc closed 4 years ago

Bouhmarc commented 4 years ago

Hi

I think there is a problem in the offlineAttributes definition (line 51551) here is the definition

    "offlineAttributes": {
      "$ref": "#/definitions/offlineAttributes",
      "description": "Reserved for DocuSign."
    },

it references it self..

Thx

LarryKlugerDS commented 4 years ago

Hi @Bouhmarc , by design we don't publish that object. Do you have a tool that is complaining about the Swagger file or you're pointing out that the object definition is missing?

Thanks, Larry

Bouhmarc commented 4 years ago

Hi

We developped a tool to import the swagger file, and this object is referenced in the witness object, which is itselft referenced in the recipients object.

Since it's a tool that import the swagger file, it complains about this object.. It's not really a pb, but i just wanted to be sure it's not a unwanted mistake !

Regards

LarryKlugerDS commented 4 years ago

Thank you for the info. Can you say more about what your tool does / what your use case is?

Yeah, leaving out the definition is by design. A prior version of the Swagger file simply omitted the definition. At least this way attribute has a "definition" (itself).

Bouhmarc commented 4 years ago

Hi

Our tool is a code generator for our customers. It's a generic tool that analyze the swagger file and generates the codes that lets our customers call any REST api. So the tool analyzes the file, and declares the objects, and the methods..

That's why..

Could you just tell me if it's a "normal" way to declare objects that are not meant to be used ? I'm not very used to swagger file, i'm just one of the maintainer of this tool... Regards

LarryKlugerDS commented 4 years ago

Hi @Bouhmarc , Thank you for the information. I would like to talk with you or your manager more about your application. Please connect with me via LinkedIn -- https://www.linkedin.com/in/larrykluger/ Thank you.

Re:

Could you just tell me if it's a "normal" way to declare objects that are not meant to be used ?

I don't know. It is the best idea we could come up with. We had more complaints from developers when we just left out the definition. If you hear of a better way to omit an object, please let me know.