go-openapi/spec

Question regarding to SchemaProps.ID

rmohr opened this issue · 2 comments

rmohr commented

If I look at the SchemaProps definition, I see that the ID is marshalled into json:

type SchemaProps struct {
	ID                   string            `json:"id,omitempty"`
}

Is there a specific reason for that? Because when I marshal the definitions to json, this ID is also added, but according to openapi the id field is not part of the spec and the validation in some validators fails.

Can we change that to json:"-,omitempty" or is there another way of marshalling the spec?

/cc @emicklei @wsong

I found jsonschema compatibility more important. Do you have a concrete example of a validator that fails?

rmohr commented

Sorry for the late response.

Examples are:

You can pass in the petshop example and add the id field there.

They do a schema validation too and since it is not part of the schema, they complain about it.