Skip to content

Commit

Permalink
update openapi.yml (#26)
Browse files Browse the repository at this point in the history
* update openapi.yml

* add new methods to overrides

* override tags

* fix overrides

* fix override path

* try to remove top-level tags too

* tags: {}

* fix scim endpoint tag

* fix get scim group endpoint path

* renaming API group (#27)

Co-authored-by: chdeskur <[email protected]>

* update openapi.yml

* fix overrides

* add example for list users

* bunch of fixes

* fix example param locations

---------

Co-authored-by: fern <[email protected]>
Co-authored-by: chdeskur <[email protected]>
  • Loading branch information
3 people authored Aug 13, 2024
1 parent 345fd13 commit 3aa3466
Show file tree
Hide file tree
Showing 4 changed files with 394 additions and 154 deletions.
4 changes: 4 additions & 0 deletions fern/docs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -38,6 +38,10 @@ navigation:
snippets:
python: ssoready
typescript: ssoready
layout:
- saml
- scim:
title: SCIM
- section: IDP configuration
contents:
- page: Enabling self-service configuration for your customers
Expand Down
2 changes: 1 addition & 1 deletion fern/fern.config.json
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
{
"organization": "ssoready",
"version": "0.29.0"
"version": "0.39.1"
}
99 changes: 99 additions & 0 deletions fern/openapi-overrides.yml
Original file line number Diff line number Diff line change
@@ -1,3 +1,8 @@
servers:
- url: https://api.ssoready.com

tags: {}

components:
securitySchemes:
bearerAuth:
Expand All @@ -10,6 +15,8 @@ components:
paths:
/v1/saml/redeem:
post:
tags:
- saml
x-fern-sdk-group-name: saml
x-fern-sdk-method-name: redeemSAMLAccessCode
x-fern-examples:
Expand All @@ -23,6 +30,8 @@ paths:

/v1/saml/redirect:
post:
tags:
- saml
x-fern-sdk-group-name: saml
x-fern-sdk-method-name: getSAMLRedirectUrl
x-fern-examples:
Expand All @@ -31,3 +40,93 @@ paths:
response:
body:
redirectUrl: https://your.redirect.url

/v1/scim/users:
get:
tags:
- scim
x-fern-sdk-group-name: scim
x-fern-sdk-method-name: listSCIMUsers
x-fern-examples:
- query-parameters:
organizationExternalId: my_custom_external_id
response:
body:
scimUsers:
- id: scim_user_...
email: [email protected]
deleted: false
attributes:
displayName: John Doe
preferredLanguage: en_US
key: value
- id: scim_user_...
email: [email protected]
deleted: true
attributes:
displayName: Jane Doe
preferredLanguage: fr_FR
key: value
nextPageToken: "..."

/v1/scim/users/{id}:
get:
tags:
- scim
x-fern-sdk-group-name: scim
x-fern-sdk-method-name: getSCIMUser
x-fern-examples:
- path-parameters:
id: scim_user_...
response:
body:
scimUser:
id: scim_user_...
email: [email protected]
deleted: false
attributes:
displayName: John Doe
preferredLanguage: en_US
key: value

/v1/scim/groups:
get:
tags:
- scim
x-fern-sdk-group-name: scim
x-fern-sdk-method-name: listSCIMGroups
x-fern-examples:
- query-parameters:
organizationExternalId: my_custom_external_id
response:
body:
scimGroups:
- id: scim_group_...
displayName: Engineering
deleted: false
attributes:
key: value
- id: scim_group_...
displayName: Marketing
deleted: true
attributes:
key: value
nextPageToken: "..."

/v1/scim/groups/{id}:
get:
tags:
- scim
x-fern-sdk-group-name: scim
x-fern-sdk-method-name: getSCIMGroup
x-fern-examples:
- path-parameters:
id: scim_group_...
response:
body:
scimGroup:
id: scim_group_...
displayName: Engineering
deleted: false
attributes:
key: value
Loading

0 comments on commit 3aa3466

Please sign in to comment.