Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[HTTP/OAS] Add tags and descriptions for uptime setting APIs #184268

Merged
merged 4 commits into from
Jun 18, 2024

Conversation

lcawl
Copy link
Contributor

@lcawl lcawl commented May 24, 2024

Summary

Relates to #180056

This PR adds operation summaries for the uptime setting APIs in the generated OpenAPI document.
It also adds tags per #184320

How to test

Per #181277:

  1. Start Elasticsearch (e.g. yarn es snapshot --license trial)
  2. Add server.oas.enabled: true to kibana.dev.yml
  3. Start Kibana (e.g. yarn start --no-base-path)
  4. curl -s -u elastic http://localhost:5601/api/oas\?pathStartsWith\=/api/uptime/settings | jq > test.json
   "paths": {
    "/api/uptime/settings": {
      "get": {
        "summary": "Get uptime settings",
        "tags": [
          "uptime"
        ],

@lcawl lcawl added release_note:skip Skip the PR/issue when compiling release notes docs Team:uptime v8.15.0 labels May 24, 2024
@apmmachine
Copy link
Contributor

🤖 GitHub comments

Expand to view the GitHub comments

Just comment with:

  • /oblt-deploy : Deploy a Kibana instance using the Observability test environments.
  • run docs-build : Re-trigger the docs validation. (use unformatted text in the comment!)

@lcawl lcawl marked this pull request as ready for review May 24, 2024 22:56
@lcawl lcawl requested a review from a team as a code owner May 24, 2024 22:56
@botelastic botelastic bot added the ci:project-deploy-observability Create an Observability project label Jun 4, 2024
@lcawl lcawl changed the title [HTTP/OAS] Add descriptions for uptime setting APIs [HTTP/OAS] Add tags and descriptions for uptime setting APIs Jun 4, 2024
@kibana-ci
Copy link
Collaborator

kibana-ci commented Jun 18, 2024

💛 Build succeeded, but was flaky

Failed CI Steps

Metrics [docs]

✅ unchanged

History

To update your PR or re-run it, just comment with:
@elasticmachine merge upstream

Copy link
Contributor

@justinkambic justinkambic left a comment

Choose a reason for hiding this comment

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

LGTM!

Tested locally, seeing the expected JSON:

{                                                                             
  "openapi": "3.0.0",                                                         
  "info": {                                                                   
    "title": "Kibana HTTP APIs",                                              
    "version": "0.0.0"                                                        
  },                                                                          
  "servers": [                                                                
    {                                                                         
      "url": "http://localhost:5601"                                          
    }                                                                         
  ],                                                                          
  "paths": {                                                                  
    "/api/uptime/settings": {                                                 
      "get": {                                                                
        "summary": "",                                                        
        "description": "Get uptime settings",                                 
        "tags": [                                                             
          "uptime"                                                            
        ],                                                                    
        "responses": {                                                        
          "200": {                                                            
            "content": {                                                      
              "application/json; Elastic-Api-Version=2023-10-31": {           
                "schema": {                                                   
                  "type": "object",                                           
                  "properties": {                                             
                    "heartbeatIndices": {                                     
                      "type": "string",                                       
                      "minLength": 1                                          
                    },                                                        
                    "certAgeThreshold": {                                     
                      "minimum": 1,                                           
                      "type": "number"                                        
                    },                                                        
                    "certExpirationThreshold": {                              
                      "minimum": 1,                                           
                      "type": "number"                                        
                    },                            
...

@lcawl lcawl merged commit 1721633 into elastic:main Jun 18, 2024
27 checks passed
@kibanamachine kibanamachine added the backport:skip This commit does not require backporting label Jun 18, 2024
@lcawl lcawl deleted the uptime-desc branch June 18, 2024 17:10
bhapas pushed a commit to bhapas/kibana that referenced this pull request Jun 18, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
apm:review backport:skip This commit does not require backporting ci:project-deploy-observability Create an Observability project docs release_note:skip Skip the PR/issue when compiling release notes Team:uptime v8.15.0
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

6 participants