Subsets of properties in a Swagger definition

Question

I'm writing an API where I have a Controller that POSTs a new object, GETs it back and can PUT/PATCH updates to it. The problem is that there's a difference in properties between the two different actions. For example, when I POST a new object I want to ensure that the 'id' of it is returned so that it can be used to identify it for the GET/PUT/PATCH endpoints. It doesn't matter if it comes back via the GET (it's just a duplication of data at that point) but I certainly don't want it passed for the PUT or PATCH as the id is immutable.

So what's the best way to mark this up in swagger so that I can have different versions of the same Definition? I've seen that you can use 'allOf' to add Definitions to other properties, but I'm wondering if there's a way of saying 'not these properties in the definition'?

If I could do the latter I could make one Definition of the object as a whole and simply knock out the things that aren't required to be returned or submitted when referencing it at the Controller. Is this possible? Am I making sense?

(Just to make things more interesting, my swagger.json file is being generated by swagger-php based on Annotations in my controller and entity files)

Answer 1

我在编写规范文件时遇到了同样的问题，并且不知道如何解决，但是我使用的是属性“ readOnly”：true，这样文档中就说这是一个只读属性，您只能读取通过GET / POST方法发送它，但是您不能通过PATCH / PUT发送它。希望对您有所帮助