Skip to content
This repository was archived by the owner on Dec 25, 2024. It is now read-only.

Adds security_index info to endpoint docs#181

Merged
spacether merged 9 commits intomasterfrom
feat_adds_security_index_to_docs
Jun 7, 2023
Merged

Adds security_index info to endpoint docs#181
spacether merged 9 commits intomasterfrom
feat_adds_security_index_to_docs

Conversation

@spacether
Copy link
Copy Markdown
Contributor

@spacether spacether commented Jun 7, 2023

  • Adds security_index info to endpoint docs
  • Adds allowed values for security_index and server_index
  • Fix: corrects the link to the root server info from endpoint docs
  • makes servers a required key in server_index_info and security_index_info
  • Adds codes sample for security_index_info if there is more than one security

The fact that the docs needed this info came up in: #180

PR checklist

  • Read the contribution guidelines.
  • Pull Request title clearly describes the work in the pull request and Pull Request description provides details about how to validate the work. Missing information here may result in delayed response from the community.
  • Run the following to build the project and update samples:
    ./mvnw clean package 
    ./bin/generate-samples.sh
    ./bin/utils/export_docs_generators.sh
    
    Commit all changed files.
    This is important, as CI jobs will verify all generator outputs of your HEAD commit as it would merge with master.
    These must match the expectations made by your contribution.
    You may regenerate an individual generator by passing the relevant config(s) as an argument to the script, for example ./bin/generate-samples.sh bin/configs/python*.
    For Windows users, please run the script in Git BASH.

@spacether spacether changed the title Adds security_index info to endpoint docs Adds security_index_info to endpoint docs Jun 7, 2023
@spacether spacether changed the title Adds security_index_info to endpoint docs Adds security_index info to endpoint docs Jun 7, 2023
@spacether spacether merged commit 6c91e9e into master Jun 7, 2023
@spacether spacether deleted the feat_adds_security_index_to_docs branch June 7, 2023 20:43
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant