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

Update to latest master from upstream. #1741

Closed
wants to merge 2 commits into from

Conversation

sstrigler
Copy link
Contributor

Also contains changes from emqx/emqx#10195

@zmstone
Copy link
Member

zmstone commented Mar 22, 2023

@wivwiv is this enough ? or are there extra steps?

@wivwiv
Copy link
Member

wivwiv commented Mar 23, 2023

  1. These 3 APIs are still not fixed:
GET /status
Serves as a health check for the node.  Returns a plain text response describing the status of the node.  This endpoint requires no authentication.<br/><br/>Returns status code 200 if the EMQX application is up and running, 503 otherwise.<br/>This API was introduced in v5.0.10.<br/>The GET `/status` endpoint (without the `/api/...` prefix) is also an alias to this endpoint and works in the same way.  This alias has been available since v5.0.0.

POST /exhook/{name}/move
Move the server.<br/>NOTE: The position should be


POST /configs_reset/{rootname} 
Reset the config entry specified by the query string parameter `conf_path`.<br/>- For a config entry that has default value, this resets it to the default value;<br/>- For a config entry that has no default value, an error 400 will be returned
  1. Please provide a copy in zh language, and please upload them to . /redocly instead of ./swagger.
redocly
├── ce-en.json
├── ce-zh.json
├── ee-en.json
└── ee-zh.json

@wivwiv
Copy link
Member

wivwiv commented Mar 23, 2023

With the help of chatgpt, I used this code to check the api title. You can also use it to check zh file before you upload.

import json
import os

swEN = open('./swagger.json').read()
swEN = json.loads(swEN)

for item in swEN['paths'].items():
    key, value = item
    for item2 in value.items():
        method, api = item2
        title = api.get('summary') or api.get('description')
        if '<br/>' in title:
            print({
                'method': method,
                'key': key,
                'title': title
            })

@sstrigler
Copy link
Contributor Author

  1. These 3 APIs are still not fixed:
POST /exhook/{name}/move
Move the server.<br/>NOTE: The position should be

Oh, yes, this needs another PR merged first. I'll turn this one to Draft and come back with an update.

  1. Please provide a copy in zh language, and please upload them to . /redocly instead of ./swagger.
redocly
├── ce-en.json
├── ce-zh.json
├── ee-en.json
└── ee-zh.json

If this is the desired default procedure now, we should probably update README.md to reflect this.

@sstrigler sstrigler marked this pull request as draft March 23, 2023 09:03
@sstrigler sstrigler force-pushed the sstrigler-fix-html-and-lower-case branch from 2eb1e73 to 82f104b Compare March 23, 2023 15:37
@sstrigler
Copy link
Contributor Author

Took a bit longer than expected. @wivwiv could you have another look please? I used your script from above to double check and it looked good.

Also question remains, should we update the README?

@sstrigler sstrigler marked this pull request as ready for review March 23, 2023 15:39
@sstrigler sstrigler force-pushed the sstrigler-fix-html-and-lower-case branch from 9577df9 to d24f6de Compare April 12, 2023 15:58
@sstrigler
Copy link
Contributor Author

Now with changes from https://emqx.atlassian.net/browse/EMQX-8507

@wivwiv
Copy link
Member

wivwiv commented Apr 13, 2023

This is the workflow for REST API document updates. Sorry for not replying to you earlier.

#1783

The e5.0.2 has been updated, you can try this process in v5.0.22.

Notice: It should be updated only after each release to avoid the API being added to the documentation but not available in the product.

@wivwiv
Copy link
Member

wivwiv commented Apr 13, 2023

By the way, can we provide the CE/EE version info and the current version number in the info field?

image

@sstrigler sstrigler force-pushed the sstrigler-fix-html-and-lower-case branch from d24f6de to 453c020 Compare April 13, 2023 08:04
@sstrigler
Copy link
Contributor Author

PR updated.

Created a ticket to include CE/EE and exact version info: https://emqx.atlassian.net/browse/EMQX-9569

@id
Copy link
Contributor

id commented May 29, 2023

@sstrigler FYI

@LenaLenaPan why this PR has been closed without merge?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

None yet

5 participants