Comments (3)
@DKierner Hello and thank you for the issue. The OpenAPI Docs are currently a bit out of sync, but that should not be a problem as there were no bigger changes in the API. We are currently reviewing how we can provide the API documentation and keep it as up-to-date as possible. I will inform the collegue who is responsible for the js SDK to take a look.
from domainrobot-api.
@Ephenodrom Typically, your API server would document the ReST endpoints automatically via code statements and under a designated Swagger and Swagger UI endpoint (example: /api-docs<.json,.yaml>
, /swagger-ui/index.html
), making the separate manual generation of an OpenAPI specification redundant. See oatpp/oatpp-swagger or Documenting a Spring REST API Using OpenAPI 3.0 for examples.
I find it a bit odd that InterNetX opted for the manual generation.
from domainrobot-api.
@DKierner
Yes this the well known way to do it and also the target picture for us. As always, the software behind the API has grown historically and therefore there is still some work to do to be up to date in every aspect.
from domainrobot-api.
Related Issues (11)
- "Try out" not working HOT 3
- Soa definition incorrect HOT 1
- openapi generator is failing HOT 2
- Api Endpoint /domain/_search returns not all elements, bulk max without paging HOT 2
- Question for domain creation /domain endpoint HOT 2
- Wrong types for "job" in PollMessage HOT 3
- Missing "items" in type array HOT 3
- test HOT 1
- broken HOT 4
- Error codes not documented HOT 3
Recommend Projects
-
React
A declarative, efficient, and flexible JavaScript library for building user interfaces.
-
Vue.js
🖖 Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.
-
Typescript
TypeScript is a superset of JavaScript that compiles to clean JavaScript output.
-
TensorFlow
An Open Source Machine Learning Framework for Everyone
-
Django
The Web framework for perfectionists with deadlines.
-
Laravel
A PHP framework for web artisans
-
D3
Bring data to life with SVG, Canvas and HTML. 📊📈🎉
-
Recommend Topics
-
javascript
JavaScript (JS) is a lightweight interpreted programming language with first-class functions.
-
web
Some thing interesting about web. New door for the world.
-
server
A server is a program made to process requests and deliver data to clients.
-
Machine learning
Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.
-
Visualization
Some thing interesting about visualization, use data art
-
Game
Some thing interesting about game, make everyone happy.
Recommend Org
-
Facebook
We are working to build community through open source technology. NB: members must have two-factor auth.
-
Microsoft
Open source projects and samples from Microsoft.
-
Google
Google ❤️ Open Source for everyone.
-
Alibaba
Alibaba Open Source for everyone
-
D3
Data-Driven Documents codes.
-
Tencent
China tencent open source team.
from domainrobot-api.