Request for OpenAPI Root Document

This thread has been locked for further replies. You can start a new thread to share your ideas or ask questions.

Request for OpenAPI Root Document

This thread has been locked for further replies. You can start a new thread to share your ideas or ask questions.
Request for OpenAPI Root Document
Request for OpenAPI Root Document
2024-03-05 18:03:55 - last edited 2024-03-06 03:08:26
Tags: #API
Model: OC200  
Hardware Version: V1
Firmware Version: 5.12.7

I'm a developer starting to integrate with the controller's OpenAPI. While I saw the documentation for the API at:

 

https://community.tp-link.com/en/business/forum/topic/590430

 

I was looking to generate the client / stubs for developing with the API, and it seems that tooling for OpenAPI requires the `openapi.json` or `openapi.yaml` root document (as described in the `Document Structure` section of https://swagger.io/specification/). I wasn't able to find this, so I'm seeing if someone could provide a link for it?

 

Thanks!

  0      
  0      
#1
Options
1 Accepted Solution
Re:Request for OpenAPI Root Document-Solution
2024-03-06 03:08:15 - last edited 2024-03-06 03:08:26

Hi @patrium

Since I am not specialized in Omada Controller, and not an engineer in software, I have a simple question for you, is this information you are looking for included in any of the public docs we provided?

If no, then it is not provided or ready yet. Then you should wait for the update on docs. We don't provide it unless when the public docs have it. Some files you think they are supposed to be open may not be the case. They are not open to the public and it is a decision of the team.

Best Regards! If you are new to the forum, please read: Howto - A Guide to Use Forum Effectively. Read Before You Post. Look for a model? Search your model NOW Official and Beta firmware. NEW features! Subscribe for the latest update!Download Beta Here☚ ☛ ★ Configuration Guide ★ ☚ ☛ ★ Knowledge Base ★ ☚ ☛ ★ Troubleshooting ★ ☚ ● Be kind and nice. ● Stay on the topic. ● Post details. ● Search first. ● Please don't take it for granted. ● No email confidentiality should be violated. ● S/N, MAC, and your true public IP should be mosaiced.
Recommended Solution
  0  
  0  
#2
Options
8 Reply
Re:Request for OpenAPI Root Document-Solution
2024-03-06 03:08:15 - last edited 2024-03-06 03:08:26

Hi @patrium

Since I am not specialized in Omada Controller, and not an engineer in software, I have a simple question for you, is this information you are looking for included in any of the public docs we provided?

If no, then it is not provided or ready yet. Then you should wait for the update on docs. We don't provide it unless when the public docs have it. Some files you think they are supposed to be open may not be the case. They are not open to the public and it is a decision of the team.

Best Regards! If you are new to the forum, please read: Howto - A Guide to Use Forum Effectively. Read Before You Post. Look for a model? Search your model NOW Official and Beta firmware. NEW features! Subscribe for the latest update!Download Beta Here☚ ☛ ★ Configuration Guide ★ ☚ ☛ ★ Knowledge Base ★ ☚ ☛ ★ Troubleshooting ★ ☚ ● Be kind and nice. ● Stay on the topic. ● Post details. ● Search first. ● Please don't take it for granted. ● No email confidentiality should be violated. ● S/N, MAC, and your true public IP should be mosaiced.
Recommended Solution
  0  
  0  
#2
Options
Re:Request for OpenAPI Root Document
2024-03-06 03:30:39

  @Clive_A 

 

Actually, would you be able to loop in a software engineer? This is a little difficult to explain as a "root document" is a technical term and not a document that a person reads.

  1  
  1  
#3
Options
Re:Request for OpenAPI Root Document
2024-03-06 03:49:04

Hi @patrium 

patrium wrote

  @Clive_A 

 

Actually, would you be able to loop in a software engineer? This is a little difficult to explain as a "root document" is a technical term and not a document that a person reads.

I can assist you. Please let me know how many devices you have. If you have hundreds of devices, please reach out to your local TP-Link office and the local management team will respond as if you were a VIP. Will also cooperate with the following requests from you.


If you only have a few products, I'm afraid this service is not available for individual home users.

 

Best Regards! If you are new to the forum, please read: Howto - A Guide to Use Forum Effectively. Read Before You Post. Look for a model? Search your model NOW Official and Beta firmware. NEW features! Subscribe for the latest update!Download Beta Here☚ ☛ ★ Configuration Guide ★ ☚ ☛ ★ Knowledge Base ★ ☚ ☛ ★ Troubleshooting ★ ☚ ● Be kind and nice. ● Stay on the topic. ● Post details. ● Search first. ● Please don't take it for granted. ● No email confidentiality should be violated. ● S/N, MAC, and your true public IP should be mosaiced.
  1  
  1  
#4
Options
Re:Request for OpenAPI Root Document
2024-03-06 04:26:20

  @Clive_A 

 

It seems like there might be an oversight then as the release notes for v5.12.7 says "Omada Controller now supports Open API integration". However, without the root document, this is not very useful. Maybe an analogy would be like publishing a recipe but not listing the ingredients that you should use in the recipe.

 

Are you sure that the root document was not accidentally left out when TP-Link made the integration available?

  1  
  1  
#5
Options
Re:Request for OpenAPI Root Document
2024-05-18 03:55:45

  @Clive_A 

Any API Document for this?

  0  
  0  
#6
Options
Re:Request for OpenAPI Root Document
2024-05-19 10:12:56

Hi  @wickedcool13 

wickedcool13 wrote

  @Clive_A 

Any API Document for this?

As discussed in this: https://community.tp-link.com/en/business/forum/topic/666630?replyId=1360440

You may refer to this reply from our Controller specialist who's on duty for this product line.

Best Regards! If you are new to the forum, please read: Howto - A Guide to Use Forum Effectively. Read Before You Post. Look for a model? Search your model NOW Official and Beta firmware. NEW features! Subscribe for the latest update!Download Beta Here☚ ☛ ★ Configuration Guide ★ ☚ ☛ ★ Knowledge Base ★ ☚ ☛ ★ Troubleshooting ★ ☚ ● Be kind and nice. ● Stay on the topic. ● Post details. ● Search first. ● Please don't take it for granted. ● No email confidentiality should be violated. ● S/N, MAC, and your true public IP should be mosaiced.
  0  
  0  
#7
Options
Re:Request for OpenAPI Root Document
2024-06-04 08:32:36 - last edited 2024-06-04 08:33:16

Does this one help ? https://##yourcontrollerhere##:8043/doc.html#/home

  0  
  0  
#8
Options
Re:Request for OpenAPI Root Document
2024-06-14 18:52:35 - last edited 2024-06-14 22:53:06

  @NorbertK 


I cant find vocuher endpoints, im using oc200 v1 with cloudbase binded

  0  
  0  
#9
Options

Information

Helpful: 0

Views: 935

Replies: 8

Tags

Related Articles