Comments (2)
erunion
commented on June 6, 2024
Huh, interesting. I kind of like that idea.
from mill.
erunion
commented on June 6, 2024
/**
* @api-resource Pictures
*
* @api-uri:public {On Demand\Pages\Pictures} /ondemand/pages/+ondemand_id/pictures/#poster_id
* @api-uriSegment {/ondemand/pages/+ondemand_id/pictures/#poster_id} ondemand_id (integer) - On Demand ID
* @api-uriSegment {/ondemand/pages/+ondemand_id/pictures/#poster_id} poster_id (integer) - Picture ID
*
* @api-contentType application/vnd.vimeo.picture
* @api-minVersion 3.1
*/With this syntax, anything denoted within a docblock that has @api-resource will be applied to any docblock in that controller that contains an @api-method annotation. There will be no substitutions allowed, just a blanket "add this too".
It should accept any annotations that are the following:
-
@api-uri -
@api-uriSegment -
@api-contentType -
@api-scope -
@api-capability -
@api-minVersion -
@api-throws
Anything not in that list found in the first docblock should throw a compilation error.
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.