Want to provide a URL for the Swagger documentation for all, say, "Network Plug and Play" APIs, of which there are three. To do something like this:"The Swagger documentation for the topology APIs may be seen in the lab at
- https://192.168.1.13/swagger#!/pnp-device,
- https://192.168.1.13/swagger#!/pnp-file and
- https://192.168.1.13/swagger#!/pnp-project."
"The Swagger documentation for the topology APIs may be seen in the lab at https://192.168.1.13/swagger#!/ztd"
But there does not seem to a form of a URL like that which works. If the base URL is tried getting "Error Happened".
please use Login - APIC - Enterprise Module to show.
can't actually use "https://192.168.1.13/swagger#!/ztd". That is an example of what I would like to do, where that URL shows all of the PnP APIs that I have to refer to individually above.
not sure that makes sense:
- You should be referring to PnP not ZTD (that was legacy term, i know "ztd" is still embedded in DTO, but high level construct is PnP)
- PnP process involves a range of API that are in different subsystems. It also needs /file which is where all the config and image files are stored. PnP ends up impacting /network-device as a completed device ends up in inventory. where do you draw the line?
- If you think about workflows, there are two use cases
- project workflow ---- which uses /pnp-project
- unclaimed workflow --- which uses /pnp-device
- Found it easier to take people down a workflow and map that into API rather that the other way around...
want to be able to refer to the group of APIs in the attached diagram with a single URL.
"The Swagger documentation for the Network Plug and Play APIs may be seen in the lab at https://192.168.1.13/swagger#!/pnp-device, https://192.168.1.13/swagger#!/pnp-file and https://192.168.1.13/swagger#!/pnp-project."
Note that this is just a convenience to refer to a group of APIs, not a means to explain how to use them, or a means to explain the overall process.
Swagger documentation simply does not support this. want to be passed to the development team as a feature request
- For example: a common misconception is that /pnp-file is used for configuration/image files. It is not.
The /file service (the general file service, under "File") is a very important part of PnP as that is where the config and image files are stored. i.e. nothing to do with /pnp-file.
Developers will interact with multiple services to build a use case.
updated say:
The Swagger documentation for the Network Plug and Play APIs may be seen in the lab at https://192.168.1.13/swagger#!/pnp-device, https://192.168.1.13/swagger#!/pnp-file and https://192.168.1.13/swagger#!/pnp-project. Also see https://192.168.1.13/swagger#!/fileservice.
Comments
0 comments
Please sign in to leave a comment.