Comments (4)
The petstore example can't be fully integrated and written in Mill syntax because it has a lot of non-Vimeo-like API examples that Mill isn't able to document yet (like POST body objects).
Instead, I'm going to convert the response I built for my movie showtimes library into some controllers and representations instead and call it a day.
from mill.
I would be curious to know more about the features that mill can't document. Don't we support POST body objects in our API?
from mill.
The http://petstore.swagger.io/#!/pet/addPet endpoint, for example, the POST body is:
{
"id": 0,
"category": {
"id": 0,
"name": "string"
},
"name": "doggie",
"photoUrls": [
"string"
],
"tags": [
{
"id": 0,
"name": "string"
}
],
"status": "available"
}
Mill currently does not have support for object parameters like category.id
and category.name
. It also does not have support, so far, for signifying that tags
is an array of objects in the format of id
and name
.
from mill.
Sorry, I'm wrong. Mill supports category.id
and category.name
with the following syntax:
@api-param:public {integer} category.id Category ID
@api-param:public {integer} category.name Category name
Mill definitely doesn't yet support describing contents of array params though.
from mill.
Related Issues (20)
- Force subtypes to be present on `array` types.
- Grouping classes in single `use` statement leads to errors being discovered HOT 4
- Need a way to document array object payloads
- Need a way to document array parameter examples.
- Better change detection
- Add vendor tag and private filters to the compile command
- Make data annotations flagged as required by default
- Changelog compiler doesn't use the compiler version
- Changelog compilation is incredibly slow HOT 1
- Documentation groups should be configurable
- Add a `--verbose` option to the CLI compiler
- Union types?
- Allow for documenting array/collection responses.
- Documenting scope changes
- Error-coded responses should be compiled in numerical order
- Strange handling of linebreaks
- Improper handling of enum descriptions on parameter tokens
- Decouple the OpenAPI filtering logic into a separate tool
- Private parameters not getting x-mill-visibility-private attached in the OAS
- Translate common path parameters into structured common parameters
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 mill.