thim81 / thim81/openapi-format
sort - order not always preserved on certain sub-objects
Open
@thim81 is already working on this.
Since Jul 9, 2023.
- Dominant language
- JavaScript
- Stars
- 177
- Forks
- 29
- Avg merge
- 3d 13h
- Merged PRs (30d)
- 1
Description
My goal is to create normalised openapi.json files which developers can confidently review in a PR before deploying to apigee. This tool seems promising in helping us achieve that.
Unfortunately I'm experiencing unexpected sort side-effects which run contrary to the described behaviour:
The fields that are not specified will keep their order like it is in the original OpenAPI document, so only defined fields will be re-ordered.
Just using the default sorting, sub-properties eg auditStatus seem to have a reverse-alpha sort applied. Is there a way to configure that (other than essentially declaring the entire schema ordering in the config file, right down to the leaf level)?
Input:
"schema": {
"items": {
"properties": {
"auditStatus": {
"readOnly": true,
"type": "string"
},
"columnType": {
"type": "string"
},
"createdBy": {
"readOnly": true,
"type": "string"
},
"createdDate": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"customValidationType": {
"type": "string"
},
"dataContractColumnValidations": {
"items": {
"properties": {
"auditStatus": {
"readOnly": true,
"type": "string"
},
"createdBy": {
"readOnly": true,
"type": "string"
},
"createdDate": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"customValidationId": {
"format": "int32",
"type": "integer"
},
"dataContractColumnId": {
"format": "int32",
"type": "integer"
},
"id": {
"format": "int32",
"type": "integer"
},
"lastModifiedBy": {
"readOnly": true,
"type": "string"
},
"lastModifiedDate": {
"format": "date-time",
"readOnly": true,
"type": "string"
}
},
"type": "object"
},
"type": "array"
},
"description": {
"type": "string"
},
"id": {
"format": "int32",
"readOnly": true,
"type": "integer"
},
"isActive": {
"type": "boolean"
},
"lastModifiedBy": {
"readOnly": true,
"type": "string"
},
"lastModifiedDate": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"name": {
"type": "string"
},
"parameterType": {
"type": "string"
},
"rule": {
"type": "string"
},
"scalarModelContractValidations": {
"items": {
"properties": {
"auditStatus": {
"readOnly": true,
"type": "string"
},
"createdBy": {
"readOnly": true,
"type": "string"
},
"createdDate": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"customValidationId": {
"format": "int32",
"type": "integer"
},
"id": {
"format": "int32",
"type": "integer"
},
"lastModifiedBy": {
"readOnly": true,
"type": "string"
},
"lastModifiedDate": {
"format": "date-time",
"readOnly": true,
"type": "string"
},
"scalarModelContractId": {
"format": "int32",
"type": "integer"
}
},
"type": "object"
},
"type": "array"
}
},
"type": "object"
},
"type": "array"
}
},
Output:
"schema": {
"type": "array",
"items": {
"properties": {
"auditStatus": {
"type": "string",
"readOnly": true
},
"columnType": {
"type": "string"
},
"createdBy": {
"type": "string",
"readOnly": true
},
"createdDate": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"customValidationType": {
"type": "string"
},
"dataContractColumnValidations": {
"type": "array",
"items": {
"properties": {
"auditStatus": {
"type": "string",
"readOnly": true
},
"createdBy": {
"type": "string",
"readOnly": true
},
"createdDate": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"customValidationId": {
"type": "integer",
"format": "int32"
},
"dataContractColumnId": {
"type": "integer",
"format": "int32"
},
"id": {
"type": "integer",
"format": "int32"
},
"lastModifiedBy": {
"type": "string",
"readOnly": true
},
"lastModifiedDate": {
"type": "string",
"format": "date-time",
"readOnly": true
}
},
"type": "object"
}
},
"description": {
"type": "string"
},
"id": {
"type": "integer",
"format": "int32",
"readOnly": true
},
"isActive": {
"type": "boolean"
},
"lastModifiedBy": {
"type": "string",
"readOnly": true
},
"lastModifiedDate": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"name": {
"type": "string"
},
"parameterType": {
"type": "string"
},
"rule": {
"type": "string"
},
"scalarModelContractValidations": {
"type": "array",
"items": {
"properties": {
"auditStatus": {
"type": "string",
"readOnly": true
},
"createdBy": {
"type": "string",
"readOnly": true
},
"createdDate": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"customValidationId": {
"type": "integer",
"format": "int32"
},
"id": {
"type": "integer",
"format": "int32"
},
"lastModifiedBy": {
"type": "string",
"readOnly": true
},
"lastModifiedDate": {
"type": "string",
"format": "date-time",
"readOnly": true
},
"scalarModelContractId": {
"type": "integer",
"format": "int32"
}
},
"type": "object"
}
}
},
"type": "object"
}
}
},
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Assessment
This issue has not been assessed yet.