openapi-directory
openapi-directory copied to clipboard
Add "NetBox API" API
Format: OpenAPI 3.0 Official: YES Url: https://demo.netbox.dev/api/?format=json Name: NetBox API Category: enterprise Logo:
Many thanks for the contribution. Please could you provide a link to the actual machine-readable API definition, in either OpenAPI or one of the other supported formats (RAML, API Blueprint, Postman etc)? Without this unfortunately we cannot add the API to the directory.
@bcftv - Closing due to inactivity - but please feel free to reopen the issue if necessary.
Apologies - I missed the notifications on this. I don't seem to be able to re-open it. Do you want a new issue?
Here's the OpenAPI JSON: https://demo.netbox.dev/api/docs/?format=openapi
And here's the browsable link: https://demo.netbox.dev/api/docs/
@bcftv - It looks like your API definition did not fully validate. Please mention (@) MikeRalphson to discuss. Here is the log output:
[email protected] check node --no-warnings --insecure-http-parser ./node_modules/@Mermade/api-registry/registry.js check --host undefined https://demo.netbox.dev/api/docs/?format=openapi
https://demo.netbox.dev/api/docs/?format=openapi Ffetch failed Saving metadata... Exiting with 1
The endpoint seems very slow, hence I think our fetch is timing out.
The endpoint seems very slow, hence I think our fetch is timing out.
Yes - it seems pretty laggy for me too. I'm afraid that I don't have any control over where it's hosted.
I logged a feature request for them to host it somewhere that is not dependent on their demo server: (https://github.com/netbox-community/netbox/issues/11911)
Looks like they addressed this previously and added some server-side caching but the docs are generated on demand so they can't generate a static file.
If you can't adjust the timeout then I guess this is not going to be possible.
I'll have a look, thanks for your efforts!
API added, many thanks for the contribution! The API will be live on the website after the next CI run.