Skip to content

Conversation

@ywangd
Copy link
Member

@ywangd ywangd commented May 10, 2021

This PR adds the documentation and Rest API spec file for the SAML complete logout API.
It is a (overdued) follow up for #56316

Doc preview URL: https://elasticsearch_72867.docs-preview.app.elstc.co/guide/en/elasticsearch/reference/master/security-api-saml-complete-logout.html

Relates: elastic/elasticsearch-specification#3753, #72839

@ywangd ywangd added >docs General docs changes :Security/Security Security issues without another label v8.0.0 Team:Clients Meta label for clients team v7.14.0 labels May 10, 2021
@ywangd ywangd requested a review from albertzaharovits May 10, 2021 01:53
@elasticmachine elasticmachine added the Team:Security Meta label for security team label May 10, 2021
@elasticmachine
Copy link
Collaborator

Pinging @elastic/clients-team (Team:Clients)

@elasticmachine elasticmachine added the Team:Docs Meta label for docs team label May 10, 2021
@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-security (Team:Security)

@elasticmachine
Copy link
Collaborator

Pinging @elastic/es-docs (Team:Docs)

(Required, array) A json array with all the valid SAML Request Ids that the caller of
the API has for the current user.

`queryString`::
Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think our APIs generally prefer snake case. So this should have been query_string instead of queryString. This is unfortunately another oversight of the original PR #56316. I can deprecate it and add a new query_string field in another follow-up PR.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Yeah, maybe raise an issue for it.

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I raised #73543

Copy link
Contributor

@albertzaharovits albertzaharovits left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

LGTM

"stability":"stable",
"visibility":"public",
"headers":{
"accept": [ "application/json"]
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'm not sure if this is used:

      "content_type": ["application/json"]

Copy link
Member Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thanks for catching this. I think it should be included.

@ywangd ywangd merged commit da3d72c into elastic:master May 31, 2021
ywangd added a commit to ywangd/elasticsearch that referenced this pull request May 31, 2021
This PR adds the documentation and Rest API spec file for the SAML complete
logout API. It is a (overdued) follow up for elastic#56316
ywangd added a commit that referenced this pull request May 31, 2021
)

This PR adds the documentation and Rest API spec file for the SAML complete
logout API. It is a (overdued) follow up for #56316
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

>docs General docs changes :Security/Security Security issues without another label Team:Clients Meta label for clients team Team:Docs Meta label for docs team Team:Security Meta label for security team v7.14.0 v8.0.0-alpha1

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants