search

sailpoint-oss / developer.sailpoint.com

The codebase that makes up developer.sailpoint.com, including developer documentation. This codebase is open source and welcomes contributions.
https://developer.sailpoint.com
MIT License
32 stars 85 forks source link

[Bug] NERM API Docs have incorrect URLs #304

Closed zachary-tarantinowoolson-sp closed 1 year ago

zachary-tarantinowoolson-sp commented 1 year ago

Describe the bug I haven't explicitly checked every endpoint/example, but the URL provided in the API call examples show as "https://developer.sailpoint.com/profiles" when the correct URL should have the endpoint preceded with "/api/" like so: "https://developer.sailpoint.com/api/profiles"

This has lead to a bit of confusion on how to utilize the NERM API as the provided examples lead to 404 errors.

Operating System (please complete the following information):

Browser (please complete the following information):

codey-bot[bot] commented 1 year ago

🎉 Thanks for opening your first issue here! Be sure to follow the issue template, and welcome to the community! 🙌

colin-mckibben-sp commented 1 year ago

@zachary-tarantinowoolson-sp can you provide links to specific endpoints and screenshots showing the issue?

zachary-tarantinowoolson-sp commented 1 year ago

@colin-mckibben-sp

Two examples:

POST Profile example: https://developer.sailpoint.com/nerm/api/post-profile image

GET workflow_sessions example: https://developer.sailpoint.com/nerm/api/get-workflow-sessions image

I checked through more of the endpoints and it looks like most if not all of the examples do not have the "/api" in the request URL

darrell-thobe-sp commented 1 year ago

This was solved in https://github.com/sailpoint-oss/api-specs/commit/62a3d42ec70b8c075e75cb3c58fde994561870ac#diff-bcd11c2bbbe5251a370d160eeb7e2e66ffbff15474493fcae803389a702e5f96R10. If you feel there is still an issue please re-open.