LukeParke/api-specs
1
0
Fork 0
mirror of https://github.com/LukeHagar/api-specs.git synced 2025-12-06 12:27:48 +00:00
Code Issues Packages Projects Releases Wiki Activity

fixed bug encountered while updating collection

Browse Source
This commit is contained in:
Philip Ellis
2024-01-31 12:40:29 -06:00
parent 51f6dbff60
commit 1b0fb01d4e
9 changed files with 18385 additions and 11390 deletions
Download Patch File Download Diff File Expand all files Collapse all files

6
.github/workflows/build-dereferenced-spec.yml vendored
View File

@@ -33,15 +33,15 @@ jobs:
npm ci
cd ../../
swagger-cli bundle --dereference idn/sailpoint-api.v3.yaml -t yaml -o dereferenced/deref-sailpoint-api.v3.yaml
openapi2postmanv2 -s dereferenced/deref-sailpoint-api.v3.yaml -o postman/collections/sailpoint-api-v3.json -p -O folderStrategy=Tags,requestParametersResolution=Schema,exampleParametersResolution=Schema,disableOptionalParameters=true,optimizeConversion=false,stackLimit=50,alwaysInheritAuthentication=true
openapi2postmanv2 -s dereferenced/deref-sailpoint-api.v3.yaml -o postman/collections/sailpoint-api-v3.json -p -c postman-script/openapi2postman-config.json
node postman-script/modify-collection.js postman/collections/sailpoint-api-v3.json
node postman-script/updateByFolder/index.js v3
swagger-cli bundle --dereference idn/sailpoint-api.beta.yaml -t yaml -o dereferenced/deref-sailpoint-api.beta.yaml
openapi2postmanv2 -s dereferenced/deref-sailpoint-api.beta.yaml -o postman/collections/sailpoint-api-beta.json -p -O folderStrategy=Tags,requestParametersResolution=Schema,exampleParametersResolution=Schema,disableOptionalParameters=true,optimizeConversion=false,stackLimit=50,alwaysInheritAuthentication=true
openapi2postmanv2 -s dereferenced/deref-sailpoint-api.beta.yaml -o postman/collections/sailpoint-api-beta.json -p -c postman-script/openapi2postman-config.json
node postman-script/modify-collection.js postman/collections/sailpoint-api-beta.json
node postman-script/updateByFolder/index.js beta
swagger-cli bundle --dereference nerm/openapi.yaml -t yaml -o dereferenced/deref-sailpoint-api.nerm.yaml
openapi2postmanv2 -s dereferenced/deref-sailpoint-api.nerm.yaml -o postman/collections/sailpoint-api-nerm.json -p -O folderStrategy=Tags,requestParametersResolution=Schema,exampleParametersResolution=Schema,disableOptionalParameters=true,optimizeConversion=false,stackLimit=50,alwaysInheritAuthentication=true
openapi2postmanv2 -s dereferenced/deref-sailpoint-api.nerm.yaml -o postman/collections/sailpoint-api-nerm.json -p -c postman-script/openapi2postman-config.json
node postman-script/updateByFolder/index.js nerm
swagger-cli bundle --dereference idn/sailpoint-api.v3.yaml -t json -o dereferenced/deref-sailpoint-api.v3.json
swagger-cli bundle --dereference idn/sailpoint-api.beta.yaml -t json -o dereferenced/deref-sailpoint-api.beta.json

1601
dereferenced/deref-sailpoint-api.beta.yaml
View File

File diff suppressed because it is too large Load Diff

310
dereferenced/deref-sailpoint-api.nerm.yaml
View File

@@ -4065,6 +4065,11 @@ paths:
description: The role ids that are permitted for this profile type.
example:
- 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
isc_synced:
type: boolean
default: false
description: Is this profile type synced with ics
example: false
profile_type_dup_attributes:
type: array
items:
@@ -4176,6 +4181,10 @@ paths:
description: The role ids that are permitted for this profile type.
example:
- 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
isc_synced:
type: boolean
description: Is this profile type synced with ics
example: false
profile_type_dup_attributes:
type: array
items:
@@ -4367,6 +4376,10 @@ paths:
description: The role ids that are permitted for this profile type.
example:
- 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
isc_synced:
type: boolean
description: Is this profile type synced with ics
example: false
profile_type_dup_attributes:
type: array
items:
@@ -4536,6 +4549,10 @@ paths:
description: The role ids that are permitted for this profile type.
example:
- 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
isc_synced:
type: boolean
description: Is this profile type synced with ics
example: false
profile_type_dup_attributes:
type: array
items:
@@ -4675,6 +4692,11 @@ paths:
description: The role ids that are permitted for this profile type.
example:
- 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
isc_synced:
type: boolean
default: false
description: Is this profile type synced with ics
example: false
profile_type_dup_attributes:
type: array
items:
@@ -4786,6 +4808,10 @@ paths:
description: The role ids that are permitted for this profile type.
example:
- 33f072dd-13b4-41e1-8ea0-16f2a59b57c8
isc_synced:
type: boolean
description: Is this profile type synced with ics
example: false
profile_type_dup_attributes:
type: array
items:
@@ -4923,6 +4949,286 @@ paths:
error:
description: A message describing the error
example: Sorry something went wrong
'/profile_types/{profile_type_id}/ne_attributes':
get:
summary: profile_types/ne_attributes synced status
operationId: getProfileTypeAttributes
description: Get ne attributes and synced attribute relationship to profile type.
tags:
- synced attributes
parameters:
- name: profile_type_id
in: path
description: Profile type ID of the object
required: true
schema:
type: string
format: uuid
example: 1246d8b3-ac29-4015-8154-dea4434a73fa
- name: active_filter
in: query
description: Filter for profile type synced attributes
required: false
schema:
type: string
enum:
- synced
- unsynced
- all
example: all
- name: search
in: query
description: Filter by string
required: false
schema:
type: string
example: search
- name: page
in: query
description: Pagination page number
required: false
schema:
type: integer
format: int32
minimum: 1
example: 5
- name: page
in: query
description: Pagination items per page
required: false
schema:
type: integer
format: int32
minimum: 1
example: 5
- name: sort
in: query
description: How records should be sorted
required: false
schema:
type: object
example:
attr: sync
order: asc
properties:
attr:
type: string
example: sync
order:
type: string
enum:
- asc
- desc
example: asc
responses:
'200':
description: Expected response to a valid request
content:
application/json:
schema:
type: object
properties:
form:
type: object
properties:
count:
type: integer
format: int32
description: How many ne attribute records exist
example: 5
records:
type: array
items:
type: object
properties:
id:
description: ID of ne attribute
type: string
format: uuid
readOnly: true
example: 1246d8b3-ac29-4015-8154-dea4434a73fa
uid:
description: Ne attribute's uid
type: string
minLength: 32
maxLength: 32
readOnly: true
example: 1246d8b3-ac29-4015-8154-dea4434a73fa
label:
description: Ne attribute's label
type: string
required: true
readOnly: true
example: object
synced:
description: synced_attribute ID if there is one
type: uuid
required: false
example: 1246d8b3-ac29-4015-8154-dea4434a73fa
'400':
description: Bad Request - unable to complete.
content:
application/json:
schema:
oneOf:
- type: object
properties:
error:
example: Invalid JSON syntax. Please check your syntax and try again.
- type: object
properties:
error:
example: The <object> failed to create/update
errors:
example:
attribute: can't be blank
'500':
description: Internal Server Error - returned on unhandled exceptions.
content:
application/json:
schema:
type: object
properties:
error:
description: A message describing the error
example: Sorry something went wrong
'/profile_types/{profile_type_id}/synced_attributes':
post:
summary: Create a synced attribute
operationId: createSyncedAttribute
description: Create synced attribute
tags:
- synced attributes
requestBody:
required: true
content:
application/json:
schema:
type: object
properties:
ne_attribute_id:
type: string
format: uuid
example: 1246d8b3-ac29-4015-8154-dea4434a73fa
description: synced attribute's ID
responses:
'201':
description: Expected response to a valid request
content:
application/json:
schema:
type: object
properties:
synced_attribute:
type: object
properties:
id:
type: string
format: uuid
readOnly: true
example: 1246d8b3-ac29-4015-8154-dea4434a73fa
description: synced attribute's ID
profile_type_id:
type: string
format: uuid
readOnly: true
example: 1246d8b3-ac29-4015-8154-dea4434a73fa
description: Profile type ID of synced attribute
ne_attribute_id:
type: string
format: uuid
readOnly: true
example: 1246d8b3-ac29-4015-8154-dea4434a73fa
description: Ne attribute ID of synced attribute
'400':
description: Bad Request - unable to complete.
content:
application/json:
schema:
oneOf:
- type: object
properties:
error:
example: Invalid JSON syntax. Please check your syntax and try again.
- type: object
properties:
error:
example: The <object> failed to create/update
errors:
example:
attribute: can't be blank
'500':
description: Internal Server Error - returned on unhandled exceptions.
content:
application/json:
schema:
type: object
properties:
error:
description: A message describing the error
example: Sorry something went wrong
'/profile_types/{profile_type_id}/synced_attributes/{ne_attribute_id}':
delete:
summary: Delete synced attribute
operationId: deleteSyncedAttribute
description: Delete a synced attribute.
tags:
- synced attributes
parameters:
- name: profile_type_id
in: path
description: Profile type ID of the object
required: true
schema:
type: string
format: uuid
example: 1246d8b3-ac29-4015-8154-dea4434a73fa
- name: ne_attribute_id
in: path
description: Ne attribute ID of the object
required: true
schema:
type: string
format: uuid
example: 1246d8b3-ac29-4015-8154-dea4434a73fa
responses:
'200':
description: Info about the operation
content:
application/json:
schema:
type: object
properties:
info:
description: A message confirming the operation
example: object deleted
'400':
description: Bad Request - unable to complete.
content:
application/json:
schema:
oneOf:
- type: object
properties:
error:
example: Invalid JSON syntax. Please check your syntax and try again.
- type: object
properties:
error:
example: The <object> failed to create/update
errors:
example:
attribute: can't be blank
'500':
description: Internal Server Error - returned on unhandled exceptions.
content:
application/json:
schema:
type: object
properties:
error:
description: A message describing the error
example: Sorry something went wrong
/profile_type_roles:
post:
summary: Create a profile type role
@@ -6148,6 +6454,7 @@ paths:
schema:
type: string
format: uuid
example: 1246d8b3-ac29-4015-8154-dea4434a73fa
responses:
'200':
description: Expected response to a valid request
@@ -6209,6 +6516,7 @@ paths:
schema:
type: string
format: uuid
example: 1246d8b3-ac29-4015-8154-dea4434a73fa
requestBody:
required: true
content:
@@ -14701,6 +15009,7 @@ paths:
schema:
type: string
format: uuid
example: 1246d8b3-ac29-4015-8154-dea4434a73fa
responses:
'200':
description: Expected response to a valid request
@@ -14762,6 +15071,7 @@ paths:
schema:
type: string
format: uuid
example: 1246d8b3-ac29-4015-8154-dea4434a73fa
requestBody:
required: true
content:

1811
dereferenced/deref-sailpoint-api.v3.yaml
View File

File diff suppressed because it is too large Load Diff

9
postman-script/openapi2postman-config.json Normal file
View File

@@ -0,0 +1,9 @@
{
"folderStrategy": "Tags",
"requestParametersResolution": "Schema",
"exampleParametersResolution": "Schema",
"disableOptionalParameters": true,
"optimizeConversion": false,
"stackLimit": 50,
"alwaysInheritAuthentication": true
}

12
postman-script/updateByFolder/index.js
View File

@@ -300,7 +300,7 @@ async function updateRequestsInFolder(item, folderId, remoteItem) {
let remoteRequest = getMatchingRequest(items, remoteItem.item)
let postmanRequestBody = buildRequestBody(items)
let remotePostmanBody = buildRequestBody(remoteRequest)
if (remoteRequest !== null) {
// remove responses from request that are no longer there
for (let response of remotePostmanBody.responses) {
let localResponse = getMatchingResponse(response, postmanRequestBody.responses)
@@ -331,9 +331,15 @@ async function updateRequestsInFolder(item, folderId, remoteItem) {
console.log(`no changes to request ${remoteRequest.name}`)
}
}
delete postmanRequestBody.responses
delete remotePostmanBody.responses
delete postmanRequestBody.responses
} else {
console.log(`request is null`)
}
// now check if the request has any changes in it
if (checkIfDifferent(postmanRequestBody, remotePostmanBody)) {
postmanRequestBody = buildRequestBody(items)

13766
postman/collections/sailpoint-api-beta.json
View File

File diff suppressed because one or more lines are too long

2169
postman/collections/sailpoint-api-nerm.json
View File

File diff suppressed because it is too large Load Diff

10029
postman/collections/sailpoint-api-v3.json
View File

File diff suppressed because one or more lines are too long