sailpoint-oss / api-specs

This repo houses the API specifications for all SailPoint services.
MIT License
10 stars 16 forks source link

NEROCKET-64 removing deprecated admin param for User API doc #13

Closed scott-stevens1-sp closed 1 year ago

scott-stevens1-sp commented 1 year ago

Removed an invalid optional param "admin" from: nerm/schemas/PATCH/User.yaml nerm/schemas/POST/User.yaml

CLAassistant commented 1 year ago

CLA assistant check
All committers have signed the CLA.

github-actions[bot] commented 1 year ago
OpenAPI lint errors: 32 problems (32 errors, 0 warnings, 0 infos, 0 hints) > nerm/schemas/PATCH/User.yaml |File Location|Severity|Rule Name|Message| |-------------|--------|---------|-------| |[nerm/schemas/PATCH/User.yaml:3:6](https://github.com/sailpoint-oss/api-specs/blob/NEROCKET-64/nerm/schemas/PATCH/User.yaml#L3)|:x:|schema-properties-must-have-description|Rule 303: The property id must have a description: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#303| |[nerm/schemas/PATCH/User.yaml:3:6](https://github.com/sailpoint-oss/api-specs/blob/NEROCKET-64/nerm/schemas/PATCH/User.yaml#L3)|:x:|schema-properties-must-have-example|Rule 304: The property id must have a example: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#304| |[nerm/schemas/PATCH/User.yaml:8:8](https://github.com/sailpoint-oss/api-specs/blob/NEROCKET-64/nerm/schemas/PATCH/User.yaml#L8)|:x:|schema-properties-must-have-description|Rule 303: The property name must have a description: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#303| |[nerm/schemas/PATCH/User.yaml:8:8](https://github.com/sailpoint-oss/api-specs/blob/NEROCKET-64/nerm/schemas/PATCH/User.yaml#L8)|:x:|schema-properties-must-have-example|Rule 304: The property name must have a example: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#304| |[nerm/schemas/PATCH/User.yaml:10:9](https://github.com/sailpoint-oss/api-specs/blob/NEROCKET-64/nerm/schemas/PATCH/User.yaml#L10)|:x:|schema-properties-must-have-description|Rule 303: The property email must have a description: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#303| |[nerm/schemas/PATCH/User.yaml:10:9](https://github.com/sailpoint-oss/api-specs/blob/NEROCKET-64/nerm/schemas/PATCH/User.yaml#L10)|:x:|schema-properties-must-have-example|Rule 304: The property email must have a example: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#304| |[nerm/schemas/PATCH/User.yaml:13:8](https://github.com/sailpoint-oss/api-specs/blob/NEROCKET-64/nerm/schemas/PATCH/User.yaml#L13)|:x:|schema-properties-must-have-description|Rule 303: The property type must have a description: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#303| |[nerm/schemas/PATCH/User.yaml:13:8](https://github.com/sailpoint-oss/api-specs/blob/NEROCKET-64/nerm/schemas/PATCH/User.yaml#L13)|:x:|schema-properties-must-have-example|Rule 304: The property type must have a example: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#304| |[nerm/schemas/PATCH/User.yaml:17:14](https://github.com/sailpoint-oss/api-specs/blob/NEROCKET-64/nerm/schemas/PATCH/User.yaml#L17)|:x:|schema-properties-must-have-description|Rule 303: The property profile_id must have a description: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#303| |[nerm/schemas/PATCH/User.yaml:17:14](https://github.com/sailpoint-oss/api-specs/blob/NEROCKET-64/nerm/schemas/PATCH/User.yaml#L17)|:x:|schema-properties-must-have-example|Rule 304: The property profile_id must have a example: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#304| |[nerm/schemas/PATCH/User.yaml:20:9](https://github.com/sailpoint-oss/api-specs/blob/NEROCKET-64/nerm/schemas/PATCH/User.yaml#L20)|:x:|schema-properties-must-have-description|Rule 303: The property title must have a description: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#303| |[nerm/schemas/PATCH/User.yaml:20:9](https://github.com/sailpoint-oss/api-specs/blob/NEROCKET-64/nerm/schemas/PATCH/User.yaml#L20)|:x:|schema-properties-must-have-example|Rule 304: The property title must have a example: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#304| |[nerm/schemas/PATCH/User.yaml:22:10](https://github.com/sailpoint-oss/api-specs/blob/NEROCKET-64/nerm/schemas/PATCH/User.yaml#L22)|:x:|schema-properties-must-have-description|Rule 303: The property status must have a description: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#303| |[nerm/schemas/PATCH/User.yaml:22:10](https://github.com/sailpoint-oss/api-specs/blob/NEROCKET-64/nerm/schemas/PATCH/User.yaml#L22)|:x:|schema-properties-must-have-example|Rule 304: The property status must have a example: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#304| |[nerm/schemas/PATCH/User.yaml:25:9](https://github.com/sailpoint-oss/api-specs/blob/NEROCKET-64/nerm/schemas/PATCH/User.yaml#L25)|:x:|schema-properties-must-have-description|Rule 303: The property login must have a description: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#303| |[nerm/schemas/PATCH/User.yaml:25:9](https://github.com/sailpoint-oss/api-specs/blob/NEROCKET-64/nerm/schemas/PATCH/User.yaml#L25)|:x:|schema-properties-must-have-example|Rule 304: The property login must have a example: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#304| |[nerm/schemas/PATCH/User.yaml:27:17](https://github.com/sailpoint-oss/api-specs/blob/NEROCKET-64/nerm/schemas/PATCH/User.yaml#L27)|:x:|schema-properties-must-have-description|Rule 303: The property group_strings must have a description: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#303| > nerm/schemas/POST/User.yaml |File Location|Severity|Rule Name|Message| |-------------|--------|---------|-------| |[nerm/schemas/POST/User.yaml:3:8](https://github.com/sailpoint-oss/api-specs/blob/NEROCKET-64/nerm/schemas/POST/User.yaml#L3)|:x:|schema-properties-must-have-description|Rule 303: The property name must have a description: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#303| |[nerm/schemas/POST/User.yaml:3:8](https://github.com/sailpoint-oss/api-specs/blob/NEROCKET-64/nerm/schemas/POST/User.yaml#L3)|:x:|schema-properties-must-have-example|Rule 304: The property name must have a example: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#304| |[nerm/schemas/POST/User.yaml:6:9](https://github.com/sailpoint-oss/api-specs/blob/NEROCKET-64/nerm/schemas/POST/User.yaml#L6)|:x:|schema-properties-must-have-description|Rule 303: The property email must have a description: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#303| |[nerm/schemas/POST/User.yaml:6:9](https://github.com/sailpoint-oss/api-specs/blob/NEROCKET-64/nerm/schemas/POST/User.yaml#L6)|:x:|schema-properties-must-have-example|Rule 304: The property email must have a example: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#304| |[nerm/schemas/POST/User.yaml:10:8](https://github.com/sailpoint-oss/api-specs/blob/NEROCKET-64/nerm/schemas/POST/User.yaml#L10)|:x:|schema-properties-must-have-description|Rule 303: The property type must have a description: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#303| |[nerm/schemas/POST/User.yaml:10:8](https://github.com/sailpoint-oss/api-specs/blob/NEROCKET-64/nerm/schemas/POST/User.yaml#L10)|:x:|schema-properties-must-have-example|Rule 304: The property type must have a example: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#304| |[nerm/schemas/POST/User.yaml:14:14](https://github.com/sailpoint-oss/api-specs/blob/NEROCKET-64/nerm/schemas/POST/User.yaml#L14)|:x:|schema-properties-must-have-description|Rule 303: The property profile_id must have a description: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#303| |[nerm/schemas/POST/User.yaml:14:14](https://github.com/sailpoint-oss/api-specs/blob/NEROCKET-64/nerm/schemas/POST/User.yaml#L14)|:x:|schema-properties-must-have-example|Rule 304: The property profile_id must have a example: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#304| |[nerm/schemas/POST/User.yaml:17:9](https://github.com/sailpoint-oss/api-specs/blob/NEROCKET-64/nerm/schemas/POST/User.yaml#L17)|:x:|schema-properties-must-have-description|Rule 303: The property title must have a description: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#303| |[nerm/schemas/POST/User.yaml:17:9](https://github.com/sailpoint-oss/api-specs/blob/NEROCKET-64/nerm/schemas/POST/User.yaml#L17)|:x:|schema-properties-must-have-example|Rule 304: The property title must have a example: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#304| |[nerm/schemas/POST/User.yaml:19:10](https://github.com/sailpoint-oss/api-specs/blob/NEROCKET-64/nerm/schemas/POST/User.yaml#L19)|:x:|schema-properties-must-have-description|Rule 303: The property status must have a description: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#303| |[nerm/schemas/POST/User.yaml:19:10](https://github.com/sailpoint-oss/api-specs/blob/NEROCKET-64/nerm/schemas/POST/User.yaml#L19)|:x:|schema-properties-must-have-example|Rule 304: The property status must have a example: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#304| |[nerm/schemas/POST/User.yaml:23:9](https://github.com/sailpoint-oss/api-specs/blob/NEROCKET-64/nerm/schemas/POST/User.yaml#L23)|:x:|schema-properties-must-have-description|Rule 303: The property login must have a description: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#303| |[nerm/schemas/POST/User.yaml:23:9](https://github.com/sailpoint-oss/api-specs/blob/NEROCKET-64/nerm/schemas/POST/User.yaml#L23)|:x:|schema-properties-must-have-example|Rule 304: The property login must have a example: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#304| |[nerm/schemas/POST/User.yaml:26:17](https://github.com/sailpoint-oss/api-specs/blob/NEROCKET-64/nerm/schemas/POST/User.yaml#L26)|:x:|schema-properties-must-have-description|Rule 303: The property group_strings must have a description: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#303|
github-actions[bot] commented 1 year ago
OpenAPI lint errors: 1 problems (1 errors, 0 warnings, 0 infos, 0 hints) > nerm/schemas/POST/User.yaml |File Location|Severity|Rule Name|Message| |-------------|--------|---------|-------| |[nerm/schemas/POST/User.yaml:35:9](https://github.com/sailpoint-oss/api-specs/blob/NEROCKET-64/nerm/schemas/POST/User.yaml#L35)|:x:|schema-properties-must-have-example|Rule 304: The property login must have a example: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#304|