search

sailpoint-oss / api-specs

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

[NEROCKET-119] add api docs for nerm create permissions #24

Closed corey-votta-sp closed 1 year ago

CLAassistant commented 1 year ago

CLA assistant check
All committers have signed the CLA.

github-actions[bot] commented 1 year ago
OpenAPI lint errors: 22 problems (22 errors, 0 warnings, 0 infos, 0 hints) > nerm/paths/permissions.yaml |File Location|Severity|Rule Name|Message| |-------------|--------|---------|-------| |[nerm/paths/permissions.yaml:1:6](https://github.com/sailpoint-oss/api-specs/blob/nerocket-119-add-permission-docs/nerm/paths/permissions.yaml#L1)|:x:|path-operation-check|Rule 400: a camelCased operationId must be provided: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#400| > nerm/schemas/GET/Permission.yaml |File Location|Severity|Rule Name|Message| |-------------|--------|---------|-------| |[nerm/schemas/GET/Permission.yaml:3:6](https://github.com/sailpoint-oss/api-specs/blob/nerocket-119-add-permission-docs/nerm/schemas/GET/Permission.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/GET/Permission.yaml:3:6](https://github.com/sailpoint-oss/api-specs/blob/nerocket-119-add-permission-docs/nerm/schemas/GET/Permission.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/GET/Permission.yaml:7:11](https://github.com/sailpoint-oss/api-specs/blob/nerocket-119-add-permission-docs/nerm/schemas/GET/Permission.yaml#L7)|:x:|schema-properties-must-have-description|Rule 303: The property role_id must have a description: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#303| |[nerm/schemas/GET/Permission.yaml:7:11](https://github.com/sailpoint-oss/api-specs/blob/nerocket-119-add-permission-docs/nerm/schemas/GET/Permission.yaml#L7)|:x:|schema-properties-must-have-example|Rule 304: The property role_id must have a example: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#304| |[nerm/schemas/GET/Permission.yaml:10:9](https://github.com/sailpoint-oss/api-specs/blob/nerocket-119-add-permission-docs/nerm/schemas/GET/Permission.yaml#L10)|:x:|schema-properties-must-have-description|Rule 303: The property value must have a description: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#303| |[nerm/schemas/GET/Permission.yaml:10:9](https://github.com/sailpoint-oss/api-specs/blob/nerocket-119-add-permission-docs/nerm/schemas/GET/Permission.yaml#L10)|:x:|schema-properties-must-have-valid-formats-for-numbers-and-integers|Rule 171: The property value must have a format defined with type:integer [int32, int64, bigint]: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#171| |[nerm/schemas/GET/Permission.yaml:13:11](https://github.com/sailpoint-oss/api-specs/blob/nerocket-119-add-permission-docs/nerm/schemas/GET/Permission.yaml#L13)|:x:|schema-properties-must-have-description|Rule 303: The property subject must have a description: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#303| |[nerm/schemas/GET/Permission.yaml:13:11](https://github.com/sailpoint-oss/api-specs/blob/nerocket-119-add-permission-docs/nerm/schemas/GET/Permission.yaml#L13)|:x:|schema-properties-must-have-example|Rule 304: The property subject must have a example: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#304| |[nerm/schemas/GET/Permission.yaml:13:11](https://github.com/sailpoint-oss/api-specs/blob/nerocket-119-add-permission-docs/nerm/schemas/GET/Permission.yaml#L13)|:x:|schema-properties-must-have-valid-formats-for-numbers-and-integers|Rule 171: The property subject must have a format defined with type:integer [int32, int64, bigint]: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#171| |[nerm/schemas/GET/Permission.yaml:15:14](https://github.com/sailpoint-oss/api-specs/blob/nerocket-119-add-permission-docs/nerm/schemas/GET/Permission.yaml#L15)|:x:|schema-properties-must-have-description|Rule 303: The property subject_id must have a description: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#303| |[nerm/schemas/GET/Permission.yaml:15:14](https://github.com/sailpoint-oss/api-specs/blob/nerocket-119-add-permission-docs/nerm/schemas/GET/Permission.yaml#L15)|:x:|schema-properties-must-have-example|Rule 304: The property subject_id must have a example: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#304| > nerm/schemas/POST/Permission.yaml |File Location|Severity|Rule Name|Message| |-------------|--------|---------|-------| |[nerm/schemas/POST/Permission.yaml:3:11](https://github.com/sailpoint-oss/api-specs/blob/nerocket-119-add-permission-docs/nerm/schemas/POST/Permission.yaml#L3)|:x:|schema-properties-must-have-description|Rule 303: The property role_id must have a description: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#303| |[nerm/schemas/POST/Permission.yaml:3:11](https://github.com/sailpoint-oss/api-specs/blob/nerocket-119-add-permission-docs/nerm/schemas/POST/Permission.yaml#L3)|:x:|schema-properties-must-have-example|Rule 304: The property role_id must have a example: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#304| |[nerm/schemas/POST/Permission.yaml:6:14](https://github.com/sailpoint-oss/api-specs/blob/nerocket-119-add-permission-docs/nerm/schemas/POST/Permission.yaml#L6)|:x:|schema-properties-must-have-description|Rule 303: The property subject_id must have a description: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#303| |[nerm/schemas/POST/Permission.yaml:6:14](https://github.com/sailpoint-oss/api-specs/blob/nerocket-119-add-permission-docs/nerm/schemas/POST/Permission.yaml#L6)|:x:|schema-properties-must-have-example|Rule 304: The property subject_id must have a example: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#304| |[nerm/schemas/POST/Permission.yaml:9:9](https://github.com/sailpoint-oss/api-specs/blob/nerocket-119-add-permission-docs/nerm/schemas/POST/Permission.yaml#L9)|:x:|schema-properties-must-have-description|Rule 303: The property value must have a description: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#303| |[nerm/schemas/POST/Permission.yaml:9:9](https://github.com/sailpoint-oss/api-specs/blob/nerocket-119-add-permission-docs/nerm/schemas/POST/Permission.yaml#L9)|:x:|schema-properties-must-have-example|Rule 304: The property value must have a example: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#304| |[nerm/schemas/POST/Permission.yaml:9:9](https://github.com/sailpoint-oss/api-specs/blob/nerocket-119-add-permission-docs/nerm/schemas/POST/Permission.yaml#L9)|:x:|schema-properties-must-have-valid-formats-for-numbers-and-integers|Rule 171: The property value must have a format defined with type:integer [int32, int64, bigint]: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#171| |[nerm/schemas/POST/Permission.yaml:12:11](https://github.com/sailpoint-oss/api-specs/blob/nerocket-119-add-permission-docs/nerm/schemas/POST/Permission.yaml#L12)|:x:|schema-properties-must-have-description|Rule 303: The property subject must have a description: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#303| |[nerm/schemas/POST/Permission.yaml:12:11](https://github.com/sailpoint-oss/api-specs/blob/nerocket-119-add-permission-docs/nerm/schemas/POST/Permission.yaml#L12)|:x:|schema-properties-must-have-example|Rule 304: The property subject must have a example: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#304| |[nerm/schemas/POST/Permission.yaml:12:11](https://github.com/sailpoint-oss/api-specs/blob/nerocket-119-add-permission-docs/nerm/schemas/POST/Permission.yaml#L12)|:x:|schema-properties-must-have-valid-formats-for-numbers-and-integers|Rule 171: The property subject must have a format defined with type:integer [int32, int64, bigint]: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#171|
github-actions[bot] commented 1 year ago
OpenAPI lint errors: 5 problems (5 errors, 0 warnings, 0 infos, 0 hints) > nerm/paths/permissions.yaml |File Location|Severity|Rule Name|Message| |-------------|--------|---------|-------| |[nerm/paths/permissions.yaml:4:16](https://github.com/sailpoint-oss/api-specs/blob/nerocket-119-add-permission-docs/nerm/paths/permissions.yaml#L4)|:x:|path-operation-check|Rule 400: post is invalid, the operationId must start with one of the allowed values [approve,cancel,complete,create,delete,disable,enable,export,hide,import,move,ping,reject,reset,search,send,set,show,start,submit,sync,test,unlock,unregister,update] for post endpoints: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#400| > nerm/schemas/GET/Permission.yaml |File Location|Severity|Rule Name|Message| |-------------|--------|---------|-------| |[nerm/schemas/GET/Permission.yaml:14:9](https://github.com/sailpoint-oss/api-specs/blob/nerocket-119-add-permission-docs/nerm/schemas/GET/Permission.yaml#L14)|:x:|schema-properties-must-have-valid-formats-for-numbers-and-integers|Rule 171: The property value must have a format defined with type:integer [int32, int64, bigint]: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#171| |[nerm/schemas/GET/Permission.yaml:18:11](https://github.com/sailpoint-oss/api-specs/blob/nerocket-119-add-permission-docs/nerm/schemas/GET/Permission.yaml#L18)|:x:|schema-properties-must-have-valid-formats-for-numbers-and-integers|Rule 171: The property subject must have a format defined with type:integer [int32, int64, bigint]: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#171| > nerm/schemas/POST/Permission.yaml |File Location|Severity|Rule Name|Message| |-------------|--------|---------|-------| |[nerm/schemas/POST/Permission.yaml:13:9](https://github.com/sailpoint-oss/api-specs/blob/nerocket-119-add-permission-docs/nerm/schemas/POST/Permission.yaml#L13)|:x:|schema-properties-must-have-valid-formats-for-numbers-and-integers|Rule 171: The property value must have a format defined with type:integer [int32, int64, bigint]: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#171| |[nerm/schemas/POST/Permission.yaml:18:11](https://github.com/sailpoint-oss/api-specs/blob/nerocket-119-add-permission-docs/nerm/schemas/POST/Permission.yaml#L18)|:x:|schema-properties-must-have-valid-formats-for-numbers-and-integers|Rule 171: The property subject must have a format defined with type:integer [int32, int64, bigint]: https://sailpoint-oss.github.io/sailpoint-api-guidelines/#171|